wip

2026-08-07 17:33:18 +00:00 · 2026-07-29 18:57:46 +02:00
parent ac2b5bd4f3
commit 5b92ae8f73
20 changed files with 996 additions and 154 deletions
@@ -126,6 +126,90 @@ RECORDING_STORAGE_EVENT_TOKEN = <token>
 > Questions? Open an issue on [GitHub](https://github.com/suitenumerique/meet/issues/new?assignees=&labels=bug&template=Bug_report.md) or join our [Matrix community](https://matrix.to/#/#meet-official:matrix.org).


+## Push recordings to Drive
+
+Once a recording is over, it can be pushed to the main workspace of the user who
+started it in [Drive](https://github.com/suitenumerique/drive), on top of staying
+in the object storage. The file is streamed from the object storage to Drive: it
+is never fully held in the worker's memory nor written to its disk.
+
+Drive is called as an OIDC resource server, following its
+[resource server documentation](https://github.com/suitenumerique/drive/blob/main/docs/resource_server.md):
+
+```mermaid
+sequenceDiagram
+    participant User
+    participant Backend as Django Backend
+    participant Worker as Celery Worker
+    participant Storage as Object Storage
+    participant Drive
+
+    User->>Backend: POST /api/v1.0/rooms/{id}/start-recording/
+    Backend->>Backend: Park the user's OIDC access token (encrypted)
+
+    Note over Backend: Recording in progress...
+
+    Storage->>Backend: Storage event notification
+    Backend->>Worker: Schedule push_recording
+
+    Worker->>Drive: GET /items/ (as the user)
+    Drive-->>Worker: Main workspace
+    Worker->>Drive: POST /items/{workspace}/children/
+    Drive-->>Worker: Item + presigned upload URL
+    Worker->>Storage: GET recording (streamed)
+    Worker->>Drive: PUT presigned URL (relayed chunk by chunk)
+    Worker->>Drive: POST /items/{item}/upload-ended/
+    Worker->>Backend: Drop the parked access token
+```
+
+### Special requirements
+
+- Drive configured as an OIDC resource server, accepting Meet's audience
+  (`OIDC_RS_ALLOWED_AUDIENCES` must contain Meet's client id), with the `items`
+  endpoint allowing the `list`, `children` and `upload_ended` actions.
+- `OIDC_STORE_ACCESS_TOKEN` enabled on Meet, along with
+  `OIDC_STORE_REFRESH_TOKEN_KEY`, the Fernet key encrypting the parked token.
+
+> [!CAUTION]
+> This is a proof of concept: the access token is captured when the recording
+> starts and assumed to still be valid when the recording ends. Long recordings
+> may therefore fail to be pushed. Exchanging it for a long-lived, narrowly
+> scoped token ([RFC 8693](https://datatracker.ietf.org/doc/html/rfc8693)) is the
+> intended follow-up.
+
+### Configuration options
+
+| Option                                                | Type        | Default | Description                                                                                                                                        |
+| ----------------------------------------------------- | ----------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **RECORDING_PUSH_TO_DRIVE_ENABLED**                   | Boolean     | `False` | Enable pushing recordings to the owner's Drive.                                                                                                     |
+| **DRIVE_API_BASE_URL**                                | String      | `None`  | Base URL of Drive's external API, e.g. `https://drive.example.com/external_api/v1.0`.                                                                |
+| **RECORDING_PUSH_TO_DRIVE_SIGNED_URL_EXPIRY_SECONDS** | Integer     | `3600`  | Lifetime of the signed URL the worker downloads the recording from.                                                                                 |
+| **OIDC_STORE_ACCESS_TOKEN**                           | Boolean     | `False` | Keep the user's access token in the session, required to call Drive on their behalf.                                                                 |
+| **OIDC_STORE_REFRESH_TOKEN_KEY**                      | Secret/File | `None`  | Fernet key encrypting OIDC tokens at rest. Generate one with `Fernet.generate_key()`.                                                                |
+| **DRIVE_UPLOAD_STORAGE_NETLOC**                       | String      | `None`  | Development only: `host:port` to reach Drive's object storage at, when the domain Drive signs its upload URLs with only resolves from a browser.     |
+
+### Local development
+
+Meet and Drive run as two separate compose projects, joined by the external
+`lasuite-network` (`make create-docker-network`). Meet's backend containers reach
+Drive's nginx at `drive-nginx:8083` and its object storage at `drive-minio:9000`.
+
+On the Drive side:
+
+```bash
+OIDC_RESOURCE_SERVER_ENABLED=True
+OIDC_RS_CLIENT_ID=drive
+OIDC_RS_CLIENT_SECRET=ThisIsAnExampleKeyForDevPurposeOnly
+OIDC_RS_AUDIENCE_CLAIM=client_id
+OIDC_RS_ALLOWED_AUDIENCES=meet
+```
+
+`DRIVE_UPLOAD_STORAGE_NETLOC` is needed there because Drive signs its upload URLs
+with `localhost:9100`, which does not resolve from Meet's containers. The
+presigned signature covers the `Host` header, so the backend keeps announcing the
+signed host and only swaps the address it connects to.
+
+
 ## LiveKit Egress

 La Suite Meet uses LiveKit Egress to record room sessions. For reference, see the [LiveKit Egress repository](https://github.com/livekit/egress) and the [official documentation](https://docs.livekit.io/home/egress/overview/).