Compare commits
4 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 2ea661c250 | |||
| 80de49cff7 | |||
| a1766e0e22 | |||
| 2a6d259fc5 |
@@ -89,6 +89,4 @@ docker/livekit/rootCA.pem
|
||||
|
||||
# NixOS
|
||||
.devenv
|
||||
# Zensical build document site
|
||||
/site/
|
||||
.pre-commit-config.yaml
|
||||
|
||||
@@ -10,10 +10,12 @@ and this project adheres to
|
||||
|
||||
### Added
|
||||
|
||||
- 📝(doc) create complete documentation website for Meet
|
||||
- 🌐(i18n) add Portuguese language support
|
||||
- ✨(frontend) add jittered exponential backoff to LiveKit reconnections
|
||||
- ✨(backend) add OIDC_ALLOW_DUPLICATE_EMAILS to let users share an email
|
||||
- ✨(frontend) tell participants when a recording is interrupted
|
||||
- ✨(backend) show the last login of users in the admin
|
||||
- ✨(backend) filter users sharing an email in the admin
|
||||
|
||||
### Changed
|
||||
|
||||
@@ -30,7 +32,9 @@ and this project adheres to
|
||||
- 🍱(frontend) add Portuguese glyphs to Marianne subsetted fonts
|
||||
- 🚸(frontend) bring new speakers to the top of the carousel
|
||||
- 🚸(frontend) bring raised hands into view in the carousel
|
||||
- ⚡️(frontend) serve illustrations as WebP with a PNG fallback
|
||||
- 💥(backend) refuse new users whose email is already used
|
||||
- ♻️(backend) match emails in a single normalized form
|
||||
- ⚡️(backend) index user emails for exact lookups
|
||||
|
||||
### Fixed
|
||||
|
||||
|
||||
@@ -7,13 +7,6 @@ To get started with the project, please refer to the [README.md](https://github.
|
||||
Please also check out our [dev handbook](https://suitenumerique.gitbook.io/handbook) to learn our best practices.
|
||||
|
||||
|
||||
## Before You Start
|
||||
|
||||
- A small fix, a typo or an obvious bug, can go straight to a pull request.
|
||||
- Before a larger change, or one written with the help of AI, agree on the approach with a maintainer on the [Matrix channel](https://matrix.to/#/#meet-official:matrix.org), as the [README](https://github.com/suitenumerique/meet/blob/main/README.md#contributing) asks.
|
||||
- [Develop locally](https://documentation-meet.beta.numerique.gouv.fr/contributing/develop/) sets up the code and explains every command. With an AI coding assistant, point it at that page and at [What CI Checks](#what-ci-checks).
|
||||
|
||||
|
||||
## Creating an Issue
|
||||
|
||||
When creating an issue, please provide the following details:
|
||||
@@ -25,146 +18,50 @@ When creating an issue, please provide the following details:
|
||||
5. **Labels**: Add appropriate labels to categorize the issue (e.g., bug, feature request, documentation).
|
||||
|
||||
|
||||
## Workflow
|
||||
|
||||
1. Fork [suitenumerique/meet](https://github.com/suitenumerique/meet) on GitHub, clone your fork, and add the project as a second remote:
|
||||
|
||||
```bash
|
||||
git clone https://github.com/<you>/meet.git && cd meet
|
||||
git remote add upstream https://github.com/suitenumerique/meet.git
|
||||
```
|
||||
|
||||
2. Create a branch from the project's latest `main`:
|
||||
|
||||
```bash
|
||||
git fetch upstream
|
||||
git switch -c my-change upstream/main
|
||||
```
|
||||
|
||||
3. Commit in steps, each one change that builds and passes the tests on its own: maintainers may merge commits as they are.
|
||||
4. Add a line to `CHANGELOG.md`, as [Changelog Update](#changelog-update) describes.
|
||||
5. Go through the [Checklist](#checklist).
|
||||
6. Push to your fork and open the pull request against `main`.
|
||||
7. To bring the branch up to date, rebase it rather than merging `main` into it:
|
||||
|
||||
```bash
|
||||
git fetch upstream
|
||||
git rebase upstream/main
|
||||
git push --force-with-lease
|
||||
```
|
||||
|
||||
## Commit Message Format
|
||||
|
||||
All commit messages must adhere to the following format:
|
||||
|
||||
```
|
||||
<gitmoji>(<scope>) <title>
|
||||
`<gitmoji>(type) title description`
|
||||
|
||||
<description>
|
||||
```
|
||||
|
||||
* <**gitmoji**>: Use a gitmoji to represent the purpose of the commit. For example, ✨ for adding a new feature or 🔥 for removing something. Copy it from the list at <https://gitmoji.dev/>: some, such as 🔒️, end in an invisible character that an emoji picker can leave out, and gitlint then rejects the title.
|
||||
* **(scope)**: The part of the repository the change touches, such as `backend`, `frontend`, `summary`, `helm`, `ci` or `docs`.
|
||||
* <**gitmoji**>: Use a gitmoji to represent the purpose of the commit. For example, ✨ for adding a new feature or 🔥 for removing something, see the list here: <https://gitmoji.dev/>.
|
||||
* **(type)**: Describe the type of change. Common types include `backend`, `frontend`, `CI`, `docker` etc...
|
||||
* **title**: A short, descriptive title for the change, starting with a lowercase character.
|
||||
* **description**: Include additional details about what was changed and why.
|
||||
|
||||
To see the scopes in use, most used first:
|
||||
|
||||
```bash
|
||||
git log -300 --format=%s upstream/main | sed -n 's/^[^(]*(\([^)]*\)).*/\1/p' |
|
||||
sort | uniq -c | sort -rn
|
||||
```
|
||||
|
||||
CI checks every commit with gitlint, using [`.gitlint`](https://github.com/suitenumerique/meet/blob/main/.gitlint) and the rule in [`gitlint/gitlint_emoji.py`](https://github.com/suitenumerique/meet/blob/main/gitlint/gitlint_emoji.py). Run the same check before pushing:
|
||||
|
||||
```bash
|
||||
# From the repository root, with network access:
|
||||
# the gitmoji rule downloads the gitmoji list
|
||||
uvx --from gitlint-core gitlint --commits upstream/main..HEAD
|
||||
```
|
||||
|
||||
The [devenv shell](https://documentation-meet.beta.numerique.gouv.fr/contributing/develop/#nix-with-devenv) installs gitlint as a commit-message hook, so it runs on every commit.
|
||||
|
||||
### Example Commit Message
|
||||
|
||||
```
|
||||
✨(frontend) add user authentication logic
|
||||
✨(frontend) add user authentication logic
|
||||
|
||||
Implemented login and signup features, and integrated OAuth2 for social login.
|
||||
```
|
||||
|
||||
## Changelog Update
|
||||
|
||||
Please add a line to the [changelog](https://github.com/suitenumerique/meet/blob/main/CHANGELOG.md) describing your development, under `## [Unreleased]`, in the `### Added`, `### Changed` or `### Fixed` section. The changelog entry should include a brief summary of the changes, this helps in tracking changes effectively and keeping everyone informed. The line is usually the commit title, sometimes ended with the pull request number.
|
||||
|
||||
CI fails the pull request when:
|
||||
|
||||
- `CHANGELOG.md` is unchanged, unless a maintainer adds the `noChangeLog` label.
|
||||
- A line other than a link reference is 80 characters or more. The `wc -L` command in [What CI Checks](#what-ci-checks) checks it: in a UTF-8 terminal it counts most gitmojis as two columns, so it can read more than CI does, and a line under 80 there passes.
|
||||
Please add a line to the changelog describing your development. The changelog entry should include a brief summary of the changes, this helps in tracking changes effectively and keeping everyone informed. We usually include the title of the pull request, followed by the pull request ID to finish the log entry. The changelog line should be less than 80 characters in total.
|
||||
|
||||
### Example Changelog Message
|
||||
```
|
||||
## [Unreleased]
|
||||
|
||||
### Added
|
||||
## Added
|
||||
|
||||
- ✨(frontend) add AI to the project #321
|
||||
```
|
||||
|
||||
## What CI Checks
|
||||
|
||||
These jobs run on each pull request to `main`, most through shared workflows from [suitenumerique/ci](https://github.com/suitenumerique/ci). Each one runs locally:
|
||||
|
||||
| Workflow | Run it locally |
|
||||
|---|---|
|
||||
| [Project quality](https://github.com/suitenumerique/meet/blob/main/.github/workflows/code-quality.yml), commits | `git diff upstream/main..HEAD -- src/backend src/summary src/agents \| grep -E '^\+.*\bprint\('` must print nothing, then the gitlint command of [Commit Message Format](#commit-message-format) and the `fixup!` check of [Code Review](#code-review) |
|
||||
| Project quality, spelling | `uvx codespell`, which reads [`.codespellrc`](https://github.com/suitenumerique/meet/blob/main/.codespellrc) |
|
||||
| Project quality, shell scripts | `shellcheck --external-sources <file>.sh` |
|
||||
| [Changelog](https://github.com/suitenumerique/meet/blob/main/.github/workflows/changelog.yml) | `grep -Ev '^\[.*\]: https://github.com' CHANGELOG.md \| wc -L` must print less than 80 |
|
||||
| [CI](https://github.com/suitenumerique/meet/blob/main/.github/workflows/ci.yml), Python lint | `make lint`, then commit what it changed |
|
||||
| CI, backend tests | `make test-back-parallel` |
|
||||
| CI, summary tests | `make test-summary` |
|
||||
| CI, frontend lint and tests | `make frontend-lint`, `make frontend-format`, `make test-frontend` |
|
||||
| CI, SDK | `cd src/sdk/library && npm ci && npm run lint && npm run check && npm run build` |
|
||||
| [Docker Hub](https://github.com/suitenumerique/meet/blob/main/.github/workflows/docker-hub.yml) | `npm run build` in `src/frontend` for the type errors; `docker build --build-arg DOCKER_USER=$(id -u):$(id -g) --target backend-production .` for the backend, and `--target production` in `src/summary` or `src/agents` when you touch them. CI also fails an image on a HIGH or CRITICAL Trivy finding |
|
||||
| [Security analysis](https://github.com/suitenumerique/meet/blob/main/.github/workflows/security.yml) | `uvx zizmor .github/workflows` |
|
||||
|
||||
## Pull Requests
|
||||
|
||||
It is nice to add information about the purpose of the pull request to help reviewers understand the context and intent of the changes. If you can, add some pictures or a small video to show the changes.
|
||||
|
||||
### Checklist
|
||||
|
||||
- [ ] Every job in [What CI Checks](#what-ci-checks) passes locally.
|
||||
- [ ] The change has tests.
|
||||
- [ ] A model change comes with its migration, from `make makemigrations`.
|
||||
- [ ] An External API change is reflected in [`docs/reference/openapi.yaml`](https://github.com/suitenumerique/meet/blob/main/docs/reference/openapi.yaml), and in `resource_server.yaml` beside it when the user's OIDC token routes change.
|
||||
- [ ] Every new or changed string is translated in the five frontend languages, and in the backend catalogs when it is a backend string, see [Translations](https://documentation-meet.beta.numerique.gouv.fr/contributing/develop/#translations).
|
||||
- [ ] An interface change works with the keyboard alone, every control has a name a screen reader reads, and the description shows it with screenshots.
|
||||
- [ ] A new or changed setting is documented in [Environment variables](https://documentation-meet.beta.numerique.gouv.fr/reference/env-variables/), and a user-visible change on the page that describes the feature.
|
||||
- [ ] A change that asks operators to do something when they upgrade is described in [`UPGRADE.md`](https://github.com/suitenumerique/meet/blob/main/UPGRADE.md).
|
||||
- [ ] No secret, password or key is committed.
|
||||
### Don't forget to:
|
||||
- check your commits
|
||||
- check the linting: `make lint && make frontend-lint`
|
||||
- check the tests: `make test`
|
||||
- add a changelog entry
|
||||
|
||||
Once all the required tests have passed, you can request a review from the project maintainers.
|
||||
|
||||
## Code Review
|
||||
|
||||
A maintainer reviews the pull request. Keep it to one change: a fix and a refactor go in two pull requests, so neither waits on the other.
|
||||
|
||||
CI rejects `fixup!` and `squash!` commits, so a review fix goes into the commit it belongs to, not a new one on top:
|
||||
|
||||
```bash
|
||||
# Record the fix against the commit it amends
|
||||
git commit --fixup=<sha of that commit>
|
||||
# Fold every fixup into its target: save the list the editor opens.
|
||||
# Keep -i: Git before 2.44 ignores --autosquash without it.
|
||||
git rebase -i --autosquash upstream/main
|
||||
# Check that no fixup! or squash! title remains: this prints nothing
|
||||
git log --format=%s upstream/main..HEAD | grep -E '^(fixup|squash)!'
|
||||
# Replace the branch on your fork
|
||||
git push --force-with-lease
|
||||
```
|
||||
|
||||
## Code Style
|
||||
|
||||
Please maintain consistency in code style. Run any linting tools available to make sure the code is clean and follows the project's conventions.
|
||||
@@ -173,10 +70,6 @@ Please maintain consistency in code style. Run any linting tools available to ma
|
||||
|
||||
Make sure that all new features or fixes have corresponding tests. Run the test suite before pushing your changes to ensure that nothing is broken.
|
||||
|
||||
## Security
|
||||
|
||||
Never report, discuss or fix a vulnerability in a public issue or pull request first: report it privately, as [SECURITY.md](https://github.com/suitenumerique/meet/blob/main/SECURITY.md) describes.
|
||||
|
||||
## Asking for Help
|
||||
|
||||
If you need any help while contributing, feel free to open a discussion or ask for guidance in the issue tracker. We are more than happy to assist!
|
||||
|
||||
@@ -169,7 +169,7 @@ run-summary: ## start only the summary application and all needed services
|
||||
@$(COMPOSE) up --force-recreate -d celery-summary-summarize
|
||||
.PHONY: run-summary
|
||||
|
||||
run-agents: ## start the LiveKit agents (opt-in, see docs/contributing/develop.md)
|
||||
run-agents: ## start the LiveKit agents (opt-in, see docs/developping_locally.md)
|
||||
@$(MAKE) run-agent-multi-user-transcriber
|
||||
@$(MAKE) run-agent-metadata-collector
|
||||
.PHONY: run-agents
|
||||
|
||||
@@ -24,13 +24,13 @@
|
||||
|
||||
<p align="center">
|
||||
<a href="https://visio.numerique.gouv.fr/">
|
||||
<img src="https://github.com/user-attachments/assets/09c1faa1-de88-4848-af3a-6fbe793999bf" alt="LaSuite Meet Demonstration">
|
||||
<img src="https://github.com/user-attachments/assets/09c1faa1-de88-4848-af3a-6fbe793999bf" alt="La Suite Meet Demonstration">
|
||||
</a>
|
||||
</p>
|
||||
|
||||
## LaSuite Meet: Simple Video Conferencing
|
||||
## La Suite Meet: Simple Video Conferencing
|
||||
|
||||
Powered by [LiveKit](https://livekit.io/), LaSuite Meet offers Zoom-level performance with high-quality video and audio. No installation required—simply join calls directly from your browser. Check out LiveKit's impressive optimizations in their [blog post](https://blog.livekit.io/livekit-one-dot-zero/).
|
||||
Powered by [LiveKit](https://livekit.io/), La Suite Meet offers Zoom-level performance with high-quality video and audio. No installation required—simply join calls directly from your browser. Check out LiveKit's impressive optimizations in their [blog post](https://blog.livekit.io/livekit-one-dot-zero/).
|
||||
|
||||
> [!TIP]
|
||||
> New here? Start by introducing yourself in our Matrix channel:
|
||||
@@ -57,15 +57,15 @@ Powered by [LiveKit](https://livekit.io/), LaSuite Meet offers Zoom-level perfor
|
||||
- SVC codecs (VP9, AV1)
|
||||
|
||||
|
||||
LaSuite Meet is fully self-hostable and released under the MIT License, ensuring complete control and flexibility. It's simple to [get started](https://visio.numerique.gouv.fr/) or [request a demo](mailto:visio@numerique.gouv.fr).
|
||||
La Suite Meet is fully self-hostable and released under the MIT License, ensuring complete control and flexibility. It's simple to [get started](https://visio.numerique.gouv.fr/) or [request a demo](mailto:visio@numerique.gouv.fr).
|
||||
|
||||
We’re continuously adding new features to enhance your experience, with the latest updates coming soon!
|
||||
|
||||
⭐ **Find LaSuite Meet useful?** Click the Star button at the top right of this page. It helps other people and public organizations discover the project.
|
||||
⭐ **Find La Suite Meet useful?** Click the Star button at the top right of this page. It helps other people and public organisations discover the project.
|
||||
|
||||
### 🚀 Major roll out to all French public servants
|
||||
|
||||
On the 29th of January 2026, Prime Minister Sébastien Lecornu announced the full deployment of Visio—the French government’s dedicated Meet platform—to all public servants. ([Source in English](https://www.nytimes.com/2026/01/29/world/europe/france-zoom-alternative-visio.html))
|
||||
On the 29th of January 2026, Prime Minister Sébastien Lecornu, announced the full deployment of Visio—the French government’s dedicated Meet platform—to all public servants. ([Source in English](https://www.nytimes.com/2026/01/29/world/europe/france-zoom-alternative-visio.html))
|
||||
|
||||
## Table of Contents
|
||||
|
||||
@@ -81,19 +81,30 @@ On the 29th of January 2026, Prime Minister Sébastien Lecornu announced the ful
|
||||
|
||||
## Docs
|
||||
|
||||
The documentation, for users, administrators and integrators, is at [documentation-meet.beta.numerique.gouv.fr](https://documentation-meet.beta.numerique.gouv.fr/).
|
||||
We're currently working on both technical and user documentation for La Suite Meet. In the meantime, many of the essential aspects are already well covered by the [LiveKit documentation](https://docs.livekit.io/home/) and their [self-hosting guide](https://docs.livekit.io/home/self-hosting/deployment/). Stay tuned for more updates!
|
||||
|
||||
## Self-host
|
||||
|
||||
### LaSuite Meet is easy to install on your own servers
|
||||
### La Suite Meet is easy to install on your own servers
|
||||
|
||||
We use Kubernetes for our [production instance](https://visio.numerique.gouv.fr/) but also support Docker Compose. The community contributed a couple of other methods (Nix, YunoHost, etc.); check out the [docs](/docs/self-hosting/index.md) for detailed instructions and examples.
|
||||
We use Kubernetes for our [production instance](https://visio.numerique.gouv.fr/) but also support Docker Compose. The community contributed a couple other methods (Nix, YunoHost etc.) check out the [docs](/docs/installation/README.md) to get detailed instructions and examples.
|
||||
|
||||
**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).
|
||||
|
||||
#### Known instances
|
||||
> [!NOTE]
|
||||
> Some advanced features (ex: recording, transcription) lack detailed documentation. We're working hard to provide comprehensive guides soon.
|
||||
|
||||
The public instances are listed in the [documentation](https://documentation-meet.beta.numerique.gouv.fr/#known-public-instances). Feel free to make a PR adding yours to [`docs/index.md`](docs/index.md).
|
||||
#### Known instances
|
||||
We hope to see many more, here is an incomplete list of public La Suite Meet instances. Feel free to make a PR to add ones that are not listed below🙏
|
||||
|
||||
| Url | Org | Access |
|
||||
|---------------------------------------------------------------|--------------|-----------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| [visio.numerique.gouv.fr](https://visio.numerique.gouv.fr/) | DINUM | French public agents working for the central administration and the extended public sphere. ProConnect is required to login in or sign up |
|
||||
| [visio.suite.anct.gouv.fr](https://visio.suite.anct.gouv.fr/) | ANCT | French public agents working for the territorial administration and the extended public sphere. ProConnect is required to login in or sign up |
|
||||
| [visio.lasuite.coop](https://visio.lasuite.coop/) | lasuite.coop | Free and open demo to all. Content and accounts are reset after one month |
|
||||
| [mosacloud.cloud](https://mosa.cloud/) | mosa.cloud | Demo instance of mosa.cloud, a dutch company providing services around La Suite apps. |
|
||||
| [Clever Cloud](https://www.clever.cloud/product/visio/) | clever cloud | Openvisio is a sovereign video conferencing solution based on LaSuite Meet offered by [Clever Cloud](https://www.clever.cloud/). |
|
||||
| [Email.eu](https://email.eu/) | Email.eu | Sovereign business workspace. |
|
||||
|
||||
|
||||
# Contributing
|
||||
@@ -126,7 +137,7 @@ Open source is much more than code. Writing documentation, improving onboarding,
|
||||
When you’re ready, here are a few ways to get involved:
|
||||
|
||||
* 👋 **Say hello** and share your ideas with the community and maintainers on our [Matrix channel](https://matrix.to/#/#meet-official:matrix.org)
|
||||
* 🛠️ **Open a PR** by following our guide to [develop LaSuite Meet locally](https://github.com/suitenumerique/meet/blob/main/docs/contributing/develop.md)
|
||||
* 🛠️ **Open a PR** by following our guide to [develop La Suite Meet locally](https://github.com/suitenumerique/meet/blob/main/docs/developping_locally.md)
|
||||
* 💡 **Suggest an idea** by opening a [feature request](https://github.com/suitenumerique/meet/issues/new?assignees=&labels=enhancement&template=Feature_request.md)
|
||||
* 🐛 **Report a bug** by opening a [bug report](https://github.com/suitenumerique/meet/issues/new?assignees=&labels=bug&template=Bug_report.md)
|
||||
|
||||
@@ -140,9 +151,9 @@ Whether you’re actively contributing or just curious about the project, you’
|
||||
|
||||
## Philosophy
|
||||
|
||||
We’re relentlessly focused on building the best open-source video conferencing product—LaSuite Meet. Growth comes from creating something people truly need, not just from chasing metrics.
|
||||
We’re relentlessly focused on building the best open-source video conferencing product—La Suite Meet. Growth comes from creating something people truly need, not just from chasing metrics.
|
||||
|
||||
Our users come first. We’re committed to making LaSuite Meet as accessible and easy to use as proprietary solutions, ensuring it meets the highest standards.
|
||||
Our users come first. We’re committed to making La Suite Meet as accessible and easy to use as proprietary solutions, ensuring it meets the highest standards.
|
||||
|
||||
Most of the heavy engineering is handled by the incredible LiveKit team, allowing us to focus on delivering a top-tier product. We follow extreme programming practices, favoring pair programming and quick, iterative releases. Challenge our tech and architecture—simplicity is always our top priority.
|
||||
|
||||
@@ -156,7 +167,7 @@ To learn more, don't hesitate to [reach out](mailto:visio@numerique.gouv.fr).
|
||||
|
||||
### Help us!
|
||||
|
||||
Come help us make LaSuite Meet even better. We're growing fast and [would love some help](mailto:visio@numerique.gouv.fr).
|
||||
Come help us make La Suite Meet even better. We're growing fast and [would love some help](mailto:visio@numerique.gouv.fr).
|
||||
|
||||
|
||||
## Contributors 🧞
|
||||
|
||||
@@ -16,42 +16,6 @@ the following command inside your docker container:
|
||||
|
||||
## [Unreleased]
|
||||
|
||||
### Illustrations served as WebP with a PNG fallback
|
||||
|
||||
The illustrations in `assets/intro-slider/` are now served as WebP, the PNG files being kept as a fallback for browsers
|
||||
that do not support WebP.
|
||||
|
||||
> [!WARNING]
|
||||
> If you override these illustrations, as described in
|
||||
> [the theming guide](docs/self-hosting/configuration/theming.md), you should now provide a `.webp` file next to each
|
||||
> `.png` one. If you override only a `.png` file while the default `.webp` one remains, your users see the default
|
||||
> illustration instead of yours. If the `.webp` file is missing from your mount altogether, the frontend falls back to
|
||||
> your `.png` file, at the cost of a failed request and without the benefit of WebP.
|
||||
|
||||
Generate the WebP files from your PNG ones with [cwebp](https://developers.google.com/speed/webp/docs/cwebp), using the
|
||||
same settings as the default illustrations:
|
||||
|
||||
```bash
|
||||
for file in assets/intro-slider/*.png; do
|
||||
cwebp -q 90 -m 6 "$file" -o "${file%.png}.webp"
|
||||
done
|
||||
```
|
||||
|
||||
If you maintain your own nginx configuration, add `webp` to the extensions of the `location ~* ^/assets/` block, as in
|
||||
`src/frontend/default.conf`, so that the new files are served with the cache headers.
|
||||
|
||||
### Compose env files: `KEYCLOAK_HOST` renamed, internal hosts removed
|
||||
|
||||
`env.d/production.dist/hosts` and the OIDC endpoints of
|
||||
`env.d/production.dist/common` now read `IDP_HOST`. If you refresh `common`
|
||||
from the new templates, rename `KEYCLOAK_HOST` to `IDP_HOST` in your `.env`
|
||||
too, or the OIDC endpoints get an empty host and login fails.
|
||||
|
||||
`hosts` also no longer carries `BACKEND_INTERNAL_HOST`,
|
||||
`FRONTEND_INTERNAL_HOST` and `LIVEKIT_INTERNAL_HOST`. A deployment that still
|
||||
mounts `docker/files/production/default.conf.template` needs them in its
|
||||
`.env`, or the frontend nginx fails to start. The compose examples now use
|
||||
`docs/examples/meet/nginx-routing.conf` in its place.
|
||||
|
||||
### Room access tokens moved to POST /join/
|
||||
|
||||
@@ -81,11 +45,20 @@ parse as a UUID, yet to normalize to an existing room's id, matched no registere
|
||||
unregistered one. The token minted for that unregistered room was valid for the registered room: anyone could join a
|
||||
trusted or restricted room without being admitted through the lobby.
|
||||
|
||||
### User emails matched in a single normalized form
|
||||
|
||||
User emails are now stored stripped, with their ASCII letters lowercased, and compared exactly. A migration normalizes
|
||||
the stored emails and stores blank ones as NULL. Other letters keep their case.
|
||||
|
||||
- With `OIDC_FALLBACK_TO_EMAIL_FOR_IDENTIFICATION` disabled (the default), a new `sub` whose email is already used by
|
||||
another user is now refused, by the OIDC login and by external API calls made with a Menshen token, instead of getting
|
||||
a second account. To keep creating users with a duplicate email, set the new `OIDC_ALLOW_DUPLICATE_EMAILS=True`.
|
||||
|
||||
## v1.37.0
|
||||
|
||||
### Crisp support chat replaced by the LaSuite support form
|
||||
### Crisp support chat replaced by the La Suite support form
|
||||
|
||||
The Crisp chat is gone, the support button, now open the LaSuite support form. They are hidden unless these `FRONTEND_SUPPORT` keys are all set.
|
||||
The Crisp chat is gone, the support button, now open the La Suite support form. They are hidden unless these `FRONTEND_SUPPORT` keys are all set.
|
||||
The former help links for recording/transcription are now redirecting to the adhoc page in the official documentation
|
||||
|
||||
### Pages hidden from search engines
|
||||
@@ -107,7 +80,7 @@ The development stack now runs LiveKit server v1.13.11 and LiveKit Egress v1.15.
|
||||
|
||||
### Purging deleted rooms
|
||||
|
||||
Deleting a room now only soft deletes it: it is hidden but keeps its slug and PIN code. The `purge_inactive_rooms` command also permanently deletes soft-deleted rooms. See [the room purge documentation](docs/self-hosting/configuration/room-purge.md).
|
||||
Deleting a room now only soft deletes it: it is hidden but keeps its slug and PIN code. The `purge_inactive_rooms` command also permanently deletes soft-deleted rooms. See [the room purge documentation](docs/features/room-purge.md).
|
||||
|
||||
- Inactive soft-deleted rooms are purged along with the other inactive rooms: if `ROOM_INACTIVITY_DELETION_DAYS` is already set, nothing else is needed.
|
||||
- The new `ROOM_DELETED_RETENTION_DAYS` setting purges soft-deleted rooms that many days after their deletion, whether they are inactive or not. It is unset by default.
|
||||
@@ -126,7 +99,7 @@ The in-house marketing service (`core.services.marketing`) has been removed and
|
||||
replaced by the shared implementation from `django-lasuite`
|
||||
(`lasuite.marketing`). This fixes a bug where updating a user's contact on
|
||||
Brevo overwrote their list memberships, removing lists set by other
|
||||
LaSuite products. Existing lists are now preserved and merged.
|
||||
La Suite products. Existing lists are now preserved and merged.
|
||||
|
||||
**Celery worker required.** Newsletter signup on login
|
||||
(`SIGNUP_NEW_USER_TO_MARKETING_EMAIL=True`) is now dispatched as an
|
||||
@@ -275,7 +248,7 @@ start-recording API accepts an `encoding` object
|
||||
falls back to `RECORDING_ENCODING_DEFAULT_PROFILE`) that overrides the default for
|
||||
a single recording. It does not enable or disable the
|
||||
default encoding, which is built from the two `RECORDING_ENCODING_DEFAULT_*`
|
||||
settings either way. Leaving it at `False` preserves the previous behavior, where
|
||||
settings either way. Leaving it at `False` preserves the previous behaviour, where
|
||||
every recording uses the server-side encoding: requests carrying
|
||||
`options.encoding` are rejected with a `400` before the recording is created, so
|
||||
nothing is persisted and no egress is started.
|
||||
@@ -287,14 +260,14 @@ Before enabling it:
|
||||
- `encoding` is accepted but ignored for `transcript` recordings, whose audio-only
|
||||
egress has no video encoding to configure.
|
||||
|
||||
See [docs/self-hosting/configuration/recording.md](docs/self-hosting/configuration/recording.md#configuring-recording-encoding)
|
||||
See [docs/features/recording.md](docs/features/recording.md#tuning-recording-encoding)
|
||||
for the full setting reference, the shipped profile table and the tuning caveats.
|
||||
|
||||
## v1.33.0
|
||||
|
||||
### Purging inactive rooms
|
||||
|
||||
Rooms now keep track of the last time they were started (`last_started_at`), fed by LiveKit's `room_started` webhook. A new `purge_inactive_rooms` management command permanently deletes the rooms that have not been started for `ROOM_INACTIVITY_DELETION_DAYS` days. See [the room purge documentation](docs/self-hosting/configuration/room-purge.md).
|
||||
Rooms now keep track of the last time they were started (`last_started_at`), fed by LiveKit's `room_started` webhook. A new `purge_inactive_rooms` management command permanently deletes the rooms that have not been started for `ROOM_INACTIVITY_DELETION_DAYS` days. See [the room purge documentation](docs/features/room-purge.md).
|
||||
|
||||
- The feature is **disabled by default**: nothing is deleted unless you set `ROOM_INACTIVITY_DELETION_DAYS`.
|
||||
- The migration marks every existing room as started at the time of the upgrade, so no existing room can be purged before a full inactivity period has elapsed after upgrading.
|
||||
|
||||
@@ -33,7 +33,7 @@ server {
|
||||
}
|
||||
|
||||
# Serve static files with caching
|
||||
location ~* ^/assets/.*\.(css|js|json|png|jpg|jpeg|gif|webp|ico|svg|woff|woff2|ttf|eot)$ {
|
||||
location ~* ^/assets/.*\.(css|js|json|png|jpg|jpeg|gif|ico|svg|woff|woff2|ttf|eot)$ {
|
||||
expires 30d;
|
||||
add_header Cache-Control "public, max-age=2592000";
|
||||
}
|
||||
|
||||
@@ -72,7 +72,7 @@ server {
|
||||
}
|
||||
|
||||
# Serve static files with caching
|
||||
location ~* ^/assets/.*\.(css|js|json|png|jpg|jpeg|gif|webp|ico|svg|woff|woff2|ttf|eot)$ {
|
||||
location ~* ^/assets/.*\.(css|js|json|png|jpg|jpeg|gif|ico|svg|woff|woff2|ttf|eot)$ {
|
||||
expires 30d;
|
||||
add_header Cache-Control "public, max-age=2592000";
|
||||
}
|
||||
|
||||
|
Before Width: | Height: | Size: 87 KiB |
|
Before Width: | Height: | Size: 200 KiB |
|
Before Width: | Height: | Size: 58 KiB |
|
Before Width: | Height: | Size: 26 KiB |
|
Before Width: | Height: | Size: 27 KiB |
|
Before Width: | Height: | Size: 27 KiB |
|
Before Width: | Height: | Size: 9.2 MiB |
|
Before Width: | Height: | Size: 1.1 MiB |
|
Before Width: | Height: | Size: 1.0 MiB |
|
Before Width: | Height: | Size: 123 KiB |
|
Before Width: | Height: | Size: 473 KiB |
|
Before Width: | Height: | Size: 769 KiB |
|
Before Width: | Height: | Size: 861 KiB |
|
Before Width: | Height: | Size: 138 KiB |
|
Before Width: | Height: | Size: 228 KiB |
|
Before Width: | Height: | Size: 75 KiB |
|
Before Width: | Height: | Size: 53 KiB |
|
Before Width: | Height: | Size: 218 KiB |
|
Before Width: | Height: | Size: 44 KiB |
|
Before Width: | Height: | Size: 146 KiB |
|
Before Width: | Height: | Size: 22 KiB |
@@ -1 +0,0 @@
|
||||
<svg viewBox="0 0 24 24" fill="currentColor" xmlns="http://www.w3.org/2000/svg"><path d="M12 14V16C8.68629 16 6 18.6863 6 22H4C4 17.5817 7.58172 14 12 14ZM12 13C8.685 13 6 10.315 6 7C6 3.685 8.685 1 12 1C15.315 1 18 3.685 18 7C18 10.315 15.315 13 12 13ZM12 11C14.21 11 16 9.21 16 7C16 4.79 14.21 3 12 3C9.79 3 8 4.79 8 7C8 9.21 9.79 11 12 11ZM21 17H22V22H14V17H15V16C15 14.3431 16.3431 13 18 13C19.6569 13 21 14.3431 21 16V17ZM19 17V16C19 15.4477 18.5523 15 18 15C17.4477 15 17 15.4477 17 16V17H19Z"/></svg>
|
||||
|
Before Width: | Height: | Size: 507 B |
@@ -1 +0,0 @@
|
||||
<svg viewBox="0 0 24 24" fill="currentColor" xmlns="http://www.w3.org/2000/svg"><path d="M13.0001 7.82843V20H11.0001V7.82843L5.63614 13.1924L4.22192 11.7782L12.0001 4L19.7783 11.7782L18.3641 13.1924L13.0001 7.82843Z"/></svg>
|
||||
|
Before Width: | Height: | Size: 224 B |
@@ -1 +0,0 @@
|
||||
<svg viewBox="0 0 24 24" fill="currentColor" xmlns="http://www.w3.org/2000/svg"><path d="M11.9999 10.8284L7.0502 15.7782L5.63599 14.364L11.9999 8L18.3639 14.364L16.9497 15.7782L11.9999 10.8284Z"/></svg>
|
||||
|
Before Width: | Height: | Size: 202 B |
@@ -1 +0,0 @@
|
||||
<svg viewBox="0 0 24 24" fill="currentColor" xmlns="http://www.w3.org/2000/svg"><path d="M10 3H14C18.4183 3 22 6.58172 22 11C22 15.4183 18.4183 19 14 19V22.5C9 20.5 2 17.5 2 11C2 6.58172 5.58172 3 10 3ZM12 17H14C17.3137 17 20 14.3137 20 11C20 7.68629 17.3137 5 14 5H10C6.68629 5 4 7.68629 4 11C4 14.61 6.46208 16.9656 12 19.4798V17Z"/></svg>
|
||||
|
Before Width: | Height: | Size: 341 B |
@@ -1 +0,0 @@
|
||||
<svg viewBox="0 0 24 24" fill="currentColor" xmlns="http://www.w3.org/2000/svg"><path d="M11.9997 10.5865L16.9495 5.63672L18.3637 7.05093L13.4139 12.0007L18.3637 16.9504L16.9495 18.3646L11.9997 13.4149L7.04996 18.3646L5.63574 16.9504L10.5855 12.0007L5.63574 7.05093L7.04996 5.63672L11.9997 10.5865Z"/></svg>
|
||||
|
Before Width: | Height: | Size: 307 B |
@@ -1 +0,0 @@
|
||||
<svg viewBox="0 0 24 24" fill="currentColor" xmlns="http://www.w3.org/2000/svg"><path d="M21 3C21.5523 3 22 3.44772 22 4V20C22 20.5523 21.5523 21 21 21H3C2.44772 21 2 20.5523 2 20V4C2 3.44772 2.44772 3 3 3H21ZM20 5H4V19H20V5ZM9 8C10.1045 8 11.1049 8.44841 11.829 9.173L10.4153 10.5866C10.0534 10.2241 9.55299 10 9 10C7.895 10 7 10.895 7 12C7 13.105 7.895 14 9 14C9.5525 14 10.0525 13.7762 10.4144 13.4144L11.828 14.828C11.104 15.552 10.104 16 9 16C6.792 16 5 14.208 5 12C5 9.792 6.792 8 9 8ZM16 8C17.1045 8 18.1049 8.44841 18.829 9.173L17.4153 10.5866C17.0534 10.2241 16.553 10 16 10C14.895 10 14 10.895 14 12C14 13.105 14.895 14 16 14C16.5525 14 17.0525 13.7762 17.4144 13.4144L18.828 14.828C18.104 15.552 17.104 16 16 16C13.792 16 12 14.208 12 12C12 9.792 13.792 8 16 8Z"/></svg>
|
||||
|
Before Width: | Height: | Size: 781 B |
@@ -1 +0,0 @@
|
||||
<svg viewBox="0 0 24 24" fill="currentColor" xmlns="http://www.w3.org/2000/svg"><path d="M12 22C6.47715 22 2 17.5228 2 12C2 6.47715 6.47715 2 12 2C17.5228 2 22 6.47715 22 12C22 17.5228 17.5228 22 12 22ZM12 20C16.4183 20 20 16.4183 20 12C20 7.58172 16.4183 4 12 4C7.58172 4 4 7.58172 4 12C4 16.4183 7.58172 20 12 20ZM8 13H16C16 15.2091 14.2091 17 12 17C9.79086 17 8 15.2091 8 13ZM8 11C7.17157 11 6.5 10.3284 6.5 9.5C6.5 8.67157 7.17157 8 8 8C8.82843 8 9.5 8.67157 9.5 9.5C9.5 10.3284 8.82843 11 8 11ZM16 11C15.1716 11 14.5 10.3284 14.5 9.5C14.5 8.67157 15.1716 8 16 8C16.8284 8 17.5 8.67157 17.5 9.5C17.5 10.3284 16.8284 11 16 11Z"/></svg>
|
||||
|
Before Width: | Height: | Size: 638 B |
@@ -1 +0,0 @@
|
||||
<svg viewBox="0 0 24 24" fill="currentColor" xmlns="http://www.w3.org/2000/svg"><path d="M2 22C2 17.5817 5.58172 14 10 14C14.4183 14 18 17.5817 18 22H16C16 18.6863 13.3137 16 10 16C6.68629 16 4 18.6863 4 22H2ZM10 13C6.685 13 4 10.315 4 7C4 3.685 6.685 1 10 1C13.315 1 16 3.685 16 7C16 10.315 13.315 13 10 13ZM10 11C12.21 11 14 9.21 14 7C14 4.79 12.21 3 10 3C7.79 3 6 4.79 6 7C6 9.21 7.79 11 10 11ZM18.2837 14.7028C21.0644 15.9561 23 18.752 23 22H21C21 19.564 19.5483 17.4671 17.4628 16.5271L18.2837 14.7028ZM17.5962 3.41321C19.5944 4.23703 21 6.20361 21 8.5C21 11.3702 18.8042 13.7252 16 13.9776V11.9646C17.6967 11.7222 19 10.264 19 8.5C19 7.11935 18.2016 5.92603 17.041 5.35635L17.5962 3.41321Z"/></svg>
|
||||
|
Before Width: | Height: | Size: 704 B |
@@ -1 +0,0 @@
|
||||
<svg viewBox="0 0 24 24" fill="currentColor" xmlns="http://www.w3.org/2000/svg"><path d="M12.5002 2C12.2241 2 12.0002 2.22386 12.0002 2.5V12H10.0002V4.5C10.0002 4.22386 9.77634 4 9.5002 4C9.22405 4 9.0002 4.22386 9.0002 4.5V14C8.64653 14 7.00024 14 7.00024 14C6.61911 12.3792 5.64236 11.4407 4.5954 11.3216C4.87926 12.0664 5.36117 13.2592 6.16634 15.0995C7.02511 17.0622 7.89128 18.5218 9.00374 19.4986C10.0783 20.442 11.4586 21 13.5002 21C16.5378 21 19.0002 18.5377 19.0002 15.5002V7C19.0002 6.72386 18.7763 6.5 18.5002 6.5C18.2241 6.5 18.0002 6.72386 18.0002 7V12H16.0002V4C16.0002 3.72386 15.7763 3.5 15.5002 3.5C15.2241 3.5 15.0002 3.72386 15.0002 4V12H13.0002V2.5C13.0002 2.22386 12.7763 2 12.5002 2ZM21.0002 15.5002C21.0002 19.6424 17.6423 23 13.5002 23C11.0417 23 9.17214 22.308 7.68416 21.0015C6.23411 19.7283 5.22528 17.9381 4.33405 15.9012C3.40393 13.7753 2.89004 12.4804 2.60991 11.7235C2.25318 10.7597 2.74616 9.41212 4.08583 9.31846C5.24076 9.23771 6.22061 9.61249 7.0002 10.2587V4.5C7.0002 3.11929 8.11949 2 9.5002 2C9.68522 2 9.86554 2.0201 10.0391 2.05823C10.2477 0.888227 11.2702 0 12.5002 0C13.5602 0 14.4661 0.659694 14.8298 1.59091C15.0431 1.53167 15.268 1.5 15.5002 1.5C16.8809 1.5 18.0002 2.61929 18.0002 4V4.55001C18.1618 4.51722 18.329 4.5 18.5002 4.5C19.8809 4.5 21.0002 5.61929 21.0002 7V15.5002Z"/></svg>
|
||||
|
Before Width: | Height: | Size: 1.3 KiB |
@@ -1 +0,0 @@
|
||||
<svg viewBox="0 0 24 24" fill="currentColor" xmlns="http://www.w3.org/2000/svg"><path d="M12 22C6.47715 22 2 17.5228 2 12C2 6.47715 6.47715 2 12 2C17.5228 2 22 6.47715 22 12C22 17.5228 17.5228 22 12 22ZM12 20C16.4183 20 20 16.4183 20 12C20 7.58172 16.4183 4 12 4C7.58172 4 4 7.58172 4 12C4 16.4183 7.58172 20 12 20ZM11 7H13V9H11V7ZM11 11H13V17H11V11Z"/></svg>
|
||||
|
Before Width: | Height: | Size: 359 B |
@@ -1 +0,0 @@
|
||||
<svg viewBox="0 0 24 24" fill="currentColor" xmlns="http://www.w3.org/2000/svg"><path d="M11.9998 3C10.3429 3 8.99976 4.34315 8.99976 6V10C8.99976 11.6569 10.3429 13 11.9998 13C13.6566 13 14.9998 11.6569 14.9998 10V6C14.9998 4.34315 13.6566 3 11.9998 3ZM11.9998 1C14.7612 1 16.9998 3.23858 16.9998 6V10C16.9998 12.7614 14.7612 15 11.9998 15C9.23833 15 6.99976 12.7614 6.99976 10V6C6.99976 3.23858 9.23833 1 11.9998 1ZM3.05469 11H5.07065C5.55588 14.3923 8.47329 17 11.9998 17C15.5262 17 18.4436 14.3923 18.9289 11H20.9448C20.4837 15.1716 17.1714 18.4839 12.9998 18.9451V23H10.9998V18.9451C6.82814 18.4839 3.51584 15.1716 3.05469 11Z"/></svg>
|
||||
|
Before Width: | Height: | Size: 640 B |
@@ -1 +0,0 @@
|
||||
<svg viewBox="0 0 24 24" fill="currentColor" xmlns="http://www.w3.org/2000/svg"><path d="M16.4249 17.839L21.1925 22.6066L22.6068 21.1924L2.80777 1.3934L1.39355 2.80761L7.00016 8.41421V10C7.00016 12.7614 9.23873 15 12.0002 15C12.4825 15 12.9489 14.9317 13.3902 14.8042L14.9404 16.3544C14.0464 16.7688 13.0503 17 12.0002 17C8.47368 17 5.55627 14.3923 5.07105 11H3.05509C3.51623 15.1716 6.82854 18.4839 11.0002 18.9451V23H13.0002V18.9451C14.2341 18.8087 15.3929 18.4228 16.4249 17.839ZM11.5528 12.9669C10.2541 12.7727 9.22745 11.7461 9.03328 10.4473L11.5528 12.9669ZM19.3747 15.1604L17.9323 13.7179C18.4407 12.9084 18.788 11.9874 18.9293 11H20.9452C20.7754 12.5366 20.2187 13.9565 19.3747 15.1604ZM16.4658 12.2514L14.9173 10.703C14.9715 10.4775 15.0002 10.2421 15.0002 10V6C15.0002 4.34315 13.657 3 12.0002 3C10.7059 3 9.6031 3.81956 9.18237 4.96802L7.68575 3.47139C8.55427 1.99268 10.1613 1 12.0002 1C14.7616 1 17.0002 3.23858 17.0002 6V10C17.0002 10.8099 16.8076 11.5748 16.4658 12.2514Z"/></svg>
|
||||
|
Before Width: | Height: | Size: 995 B |
@@ -1 +0,0 @@
|
||||
<svg viewBox="0 0 24 24" fill="currentColor" xmlns="http://www.w3.org/2000/svg"><path d="M5 10C3.9 10 3 10.9 3 12C3 13.1 3.9 14 5 14C6.1 14 7 13.1 7 12C7 10.9 6.1 10 5 10ZM19 10C17.9 10 17 10.9 17 12C17 13.1 17.9 14 19 14C20.1 14 21 13.1 21 12C21 10.9 20.1 10 19 10ZM12 10C10.9 10 10 10.9 10 12C10 13.1 10.9 14 12 14C13.1 14 14 13.1 14 12C14 10.9 13.1 10 12 10Z"/></svg>
|
||||
|
Before Width: | Height: | Size: 370 B |
@@ -1 +0,0 @@
|
||||
<svg viewBox="0 0 24 24" fill="currentColor" xmlns="http://www.w3.org/2000/svg"><path d="M21 16.42V19.9561C21 20.4811 20.5941 20.9167 20.0705 20.9537C19.6331 20.9846 19.2763 21 19 21C10.1634 21 3 13.8366 3 5C3 4.72371 3.01545 4.36687 3.04635 3.9295C3.08337 3.40588 3.51894 3 4.04386 3H7.5801C7.83678 3 8.05176 3.19442 8.07753 3.4498C8.10067 3.67907 8.12218 3.86314 8.14207 4.00202C8.34435 5.41472 8.75753 6.75936 9.3487 8.00303C9.44359 8.20265 9.38171 8.44159 9.20185 8.57006L7.04355 10.1118C8.35752 13.1811 10.8189 15.6425 13.8882 16.9565L15.4271 14.8019C15.5572 14.6199 15.799 14.5573 16.001 14.6532C17.2446 15.2439 18.5891 15.6566 20.0016 15.8584C20.1396 15.8782 20.3225 15.8995 20.5502 15.9225C20.8056 15.9483 21 16.1633 21 16.42Z"/></svg>
|
||||
|
Before Width: | Height: | Size: 743 B |
@@ -1 +0,0 @@
|
||||
<svg viewBox="0 0 24 24" fill="currentColor" xmlns="http://www.w3.org/2000/svg"><path d="M3 4H21C21.5523 4 22 4.44772 22 5V19C22 19.5523 21.5523 20 21 20H3C2.44772 20 2 19.5523 2 19V5C2 4.44772 2.44772 4 3 4ZM4 6V18H20V6H4Z"/></svg>
|
||||
|
Before Width: | Height: | Size: 232 B |
@@ -1,4 +0,0 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="20" height="20">
|
||||
<path d="M3 3H21C21.5523 3 22 3.44772 22 4V16C22 16.5523 21.5523 17 21 17H3C2.44772 17 2 16.5523 2 16V4C2 3.44772 2.44772 3 3 3ZM4 5V15H20V5H4Z" fill="currentColor"/>
|
||||
<path d="M12 7.58578L16.9497 12.5355L15.5355 13.9497L13 11.4142L13 17H11L11 11.4142L8.46447 13.9497L7.05025 12.5355L12 7.58578Z" fill="currentColor"/>
|
||||
</svg>
|
||||
|
Before Width: | Height: | Size: 413 B |
@@ -1 +0,0 @@
|
||||
<svg viewBox="0 0 24 24" fill="currentColor" xmlns="http://www.w3.org/2000/svg"><path d="M11.9998 1L6 11H18L11.9998 1ZM11.9998 4.8873L14.4676 9H9.53232L11.9998 4.8873ZM6.75 20C5.23122 20 4 18.7688 4 17.25C4 15.7312 5.23122 14.5 6.75 14.5C8.26878 14.5 9.5 15.7312 9.5 17.25C9.5 18.7688 8.26878 20 6.75 20ZM6.75 22C9.37335 22 11.5 19.8734 11.5 17.25C11.5 14.6266 9.37335 12.5 6.75 12.5C4.12665 12.5 2 14.6266 2 17.25C2 19.8734 4.12665 22 6.75 22ZM15 15.5V19.5H19V15.5H15ZM13 21.5V13.5H21V21.5H13Z"/></svg>
|
||||
|
Before Width: | Height: | Size: 503 B |
@@ -1 +0,0 @@
|
||||
<svg viewBox="0 0 24 24" fill="currentColor" xmlns="http://www.w3.org/2000/svg"><path d="M17 18.4142L21.1925 22.6067L22.6067 21.1925L2.80769 1.39349L1.39348 2.80771L2.58579 4.00001H2C1.44772 4.00001 1 4.44773 1 5.00001V19C1 19.5523 1.44772 20 2 20H16C16.5523 20 17 19.5523 17 19V18.4142ZM15 16.4142V18H3V6.00001H4.58579L15 16.4142ZM23 18.0397C23 18.2517 22.875 18.4176 22.7083 18.4943L21 16.786V8.84133L17 11.6413V12.786L15 10.786V6.00001H10.214L8.21402 4.00001H16C16.5523 4.00001 17 4.44773 17 5.00001V9.20001L22.2133 5.55073C22.5447 5.31876 23 5.55583 23 5.96034V18.0397Z"/></svg>
|
||||
|
Before Width: | Height: | Size: 582 B |
@@ -1 +0,0 @@
|
||||
<svg viewBox="0 0 24 24" fill="currentColor" xmlns="http://www.w3.org/2000/svg"><path d="M17 9.2L22.2133 5.55071C22.4395 5.39235 22.7513 5.44737 22.9096 5.6736C22.9684 5.75764 23 5.85774 23 5.96033V18.0397C23 18.3158 22.7761 18.5397 22.5 18.5397C22.3974 18.5397 22.2973 18.5081 22.2133 18.4493L17 14.8V19C17 19.5523 16.5523 20 16 20H2C1.44772 20 1 19.5523 1 19V5C1 4.44772 1.44772 4 2 4H16C16.5523 4 17 4.44772 17 5V9.2ZM17 12.3587L21 15.1587V8.84131L17 11.6413V12.3587ZM3 6V18H15V6H3Z"/></svg>
|
||||
|
Before Width: | Height: | Size: 494 B |
|
Before Width: | Height: | Size: 294 KiB |
|
Before Width: | Height: | Size: 177 KiB |
|
Before Width: | Height: | Size: 38 KiB |
|
Before Width: | Height: | Size: 58 KiB |
|
Before Width: | Height: | Size: 44 KiB |
|
Before Width: | Height: | Size: 295 KiB |
|
Before Width: | Height: | Size: 230 KiB |
|
Before Width: | Height: | Size: 60 KiB |
|
Before Width: | Height: | Size: 50 KiB |
|
Before Width: | Height: | Size: 942 KiB |
|
Before Width: | Height: | Size: 548 KiB |
|
Before Width: | Height: | Size: 98 KiB |
|
Before Width: | Height: | Size: 46 KiB |
|
Before Width: | Height: | Size: 32 KiB |
@@ -1,224 +0,0 @@
|
||||
#!/bin/bash
|
||||
# check-install.sh - Check a LaSuite Meet install on Docker Compose
|
||||
#
|
||||
# Prints the setup it finds, then one line per check: ✓ when it passes, ✗ and
|
||||
# the cause when it fails. Exits 0 only when every check passed.
|
||||
#
|
||||
# Run it on the server, in the Meet stack's directory, as the user who runs
|
||||
# docker compose:
|
||||
# cd ~/docker/meet && curl -fsSL https://raw.githubusercontent.com/suitenumerique/meet/main/docs/check-install.sh | bash
|
||||
#
|
||||
# It reads the domains from the .env there, and checks the Keycloak stack too
|
||||
# when ../keycloak exists. It needs bash, docker and curl.
|
||||
|
||||
set -euo pipefail
|
||||
|
||||
KC_DIR="$(dirname "$PWD")/keycloak"
|
||||
|
||||
die() { echo "Error: $*" >&2; exit 1; }
|
||||
|
||||
command -v docker >/dev/null 2>&1 || die "docker is not installed."
|
||||
command -v curl >/dev/null 2>&1 || die "curl is not installed."
|
||||
[[ -f .env ]] || die "No .env in $PWD. Run this in the Meet stack's directory, ~/docker/meet."
|
||||
|
||||
# env_value KEY: the value of KEY in the stack's .env, empty when it has none.
|
||||
env_value() {
|
||||
local key="$1"
|
||||
grep -E "^${key}=" .env | tail -1 | cut -d= -f2- | tr -d "\"'" || true
|
||||
}
|
||||
|
||||
MEET_HOST=$(env_value MEET_HOST)
|
||||
LIVEKIT_HOST=$(env_value LIVEKIT_HOST)
|
||||
IDP_HOST=$(env_value IDP_HOST)
|
||||
REALM_NAME=$(env_value REALM_NAME)
|
||||
COMPOSE_PROFILES=$(env_value COMPOSE_PROFILES)
|
||||
[[ -n "$MEET_HOST" && -n "$LIVEKIT_HOST" ]] \
|
||||
|| die "MEET_HOST or LIVEKIT_HOST is missing from $PWD/.env."
|
||||
|
||||
if [[ -t 1 ]]; then OK=$'\e[32m✓\e[0m'; KO=$'\e[31m✗\e[0m'; else OK='✓'; KO='✗'; fi
|
||||
|
||||
tmp=$(mktemp)
|
||||
trap 'rm -f "$tmp"' EXIT
|
||||
|
||||
passed=0
|
||||
failed=0
|
||||
pass() { echo " $OK $*"; passed=$((passed + 1)); }
|
||||
fail() { echo " $KO $*"; failed=$((failed + 1)); }
|
||||
skip() { echo " - $*"; }
|
||||
|
||||
# fetch URL: sets code and location, and why to curl's error when it got no answer.
|
||||
fetch() {
|
||||
local out
|
||||
out=$(curl -sS --max-time 10 -o /dev/null -w '%{http_code} %{redirect_url}' "$1" 2>"$tmp") || true
|
||||
code=${out%% *}
|
||||
location=${out#* }
|
||||
why=$(sed -n '1s/^curl: ([0-9]*) //p' "$tmp")
|
||||
}
|
||||
|
||||
# check_stack NAME DIR: every service of the stack runs, and passes its health check.
|
||||
check_stack() {
|
||||
local name="$1" dir="$2" services states svc state health problems="" count=0
|
||||
if ! services=$(cd "$dir" && docker compose config --services 2>"$tmp"); then
|
||||
fail "$name stack: $(tail -1 "$tmp")"
|
||||
return
|
||||
fi
|
||||
states=$(cd "$dir" && docker compose ps --all --format '{{.Service}} {{.State}} {{.Health}}' 2>/dev/null)
|
||||
for svc in $services; do
|
||||
count=$((count + 1))
|
||||
read -r _ state health <<<"$(grep "^$svc " <<<"$states" || true)"
|
||||
if [[ -z "${state:-}" ]]; then
|
||||
problems+=", $svc not created"
|
||||
elif [[ "$state" != running ]]; then
|
||||
problems+=", $svc $state"
|
||||
elif [[ -n "${health:-}" && "$health" != healthy ]]; then
|
||||
problems+=", $svc $health"
|
||||
fi
|
||||
done
|
||||
if [[ -z "$problems" ]]; then
|
||||
pass "$name stack: $count services running, health checks passing"
|
||||
else
|
||||
fail "$name stack: ${problems#, }"
|
||||
fi
|
||||
}
|
||||
|
||||
# ── Your setup ────────────────────────────────────────────────────────────────
|
||||
|
||||
version="unknown, the backend is not running"
|
||||
backend_id=$(docker compose ps -q backend 2>/dev/null || true)
|
||||
if [[ -n "$backend_id" ]]; then
|
||||
read -r image version <<<"$(docker inspect --format \
|
||||
'{{.Config.Image}} {{index .Config.Labels "org.opencontainers.image.version"}}' "$backend_id")"
|
||||
version="${version/<no value>/unknown} (image ${image})"
|
||||
fi
|
||||
|
||||
config=$(curl -sS --max-time 10 --fail "https://${MEET_HOST}/api/v1.0/config/" 2>"$tmp") || true
|
||||
config_why=$(sed -n '1s/^curl: ([0-9]*) //p' "$tmp")
|
||||
if [[ -n "$config" && "$config" != *'"livekit"'* ]]; then
|
||||
config=""
|
||||
config_why="the answer is not Meet's configuration"
|
||||
fi
|
||||
features=""
|
||||
grep -qE '"recording": *\{ *"is_enabled": *true' <<<"$config" && features+=", recording"
|
||||
grep -qE '"subtitle": *\{ *"enabled": *true' <<<"$config" && features+=", subtitles"
|
||||
grep -qE '"telephony": *\{ *"enabled": *true' <<<"$config" && features+=", telephony"
|
||||
grep -qE '"connection_test_enabled": *true' <<<"$config" && features+=", connection test"
|
||||
if [[ -z "$config" ]]; then
|
||||
features="unknown, the configuration did not load"
|
||||
else
|
||||
features=${features#, }
|
||||
fi
|
||||
|
||||
echo "Your setup"
|
||||
echo " Version ${version}"
|
||||
echo " Meet ${MEET_HOST}"
|
||||
echo " LiveKit ${LIVEKIT_HOST}"
|
||||
echo " Sign-in ${IDP_HOST:-not set}"
|
||||
echo " Profiles ${COMPOSE_PROFILES:-none}"
|
||||
echo " Features ${features:-none turned on}"
|
||||
echo ""
|
||||
echo "Checks"
|
||||
|
||||
# ── 1. Services ───────────────────────────────────────────────────────────────
|
||||
|
||||
check_stack Meet "$PWD"
|
||||
[[ -d "$KC_DIR" ]] && check_stack Keycloak "$KC_DIR"
|
||||
|
||||
# ── 2. The backend's own production checks ────────────────────────────────────
|
||||
|
||||
# Piped into bash, this script is stdin: docker must not read it.
|
||||
if out=$(docker compose exec -T backend python manage.py check --deploy </dev/null 2>&1); then
|
||||
pass "Backend: manage.py check --deploy passes"
|
||||
else
|
||||
issue=$(grep -m1 -E '\.E[0-9]+\)' <<<"$out" || grep -v '^\s*$' <<<"$out" | tail -1)
|
||||
fail "Backend: ${issue}"
|
||||
fi
|
||||
|
||||
# ── 3. Each domain answers over HTTPS ─────────────────────────────────────────
|
||||
|
||||
urls=("https://${MEET_HOST}/" "https://${LIVEKIT_HOST}/")
|
||||
[[ -d "$KC_DIR" ]] && urls+=("https://${IDP_HOST}/realms/${REALM_NAME:-meet}")
|
||||
for url in "${urls[@]}"; do
|
||||
fetch "$url"
|
||||
if [[ "$code" == 200 ]]; then
|
||||
pass "$url answers 200, certificate valid"
|
||||
elif [[ "$code" == 000 ]]; then
|
||||
fail "$url: $why"
|
||||
else
|
||||
fail "$url answers $code, not 200"
|
||||
fi
|
||||
done
|
||||
|
||||
# ── 4. Browsers get LiveKit's public address ──────────────────────────────────
|
||||
|
||||
livekit_url=$(grep -oE '"livekit": *\{ *"url": *"[^"]*"' <<<"$config" | cut -d'"' -f6 || true)
|
||||
if [[ -z "$config" ]]; then
|
||||
fail "https://${MEET_HOST}/api/v1.0/config/: $config_why"
|
||||
elif [[ "${livekit_url%/}" == "https://${LIVEKIT_HOST}" ]]; then
|
||||
pass "Meet sends browsers to LiveKit at ${livekit_url}"
|
||||
else
|
||||
fail "Meet sends browsers to LiveKit at ${livekit_url:-no address}, not https://${LIVEKIT_HOST}: set LIVEKIT_API_URL"
|
||||
fi
|
||||
|
||||
# ── 5. Sign-in leaves for the identity provider ───────────────────────────────
|
||||
|
||||
fetch "https://${MEET_HOST}/api/v1.0/authenticate/"
|
||||
idp=$(sed -E 's|^[a-z]+://([^/:?]*).*|\1|' <<<"$location")
|
||||
if [[ "$code" == 302 && -n "$location" && "$idp" != "$MEET_HOST" ]]; then
|
||||
pass "Sign-in sends browsers to ${idp}"
|
||||
elif [[ "$code" == 000 ]]; then
|
||||
fail "Sign-in: $why"
|
||||
elif [[ "$code" == 302 ]]; then
|
||||
fail "Sign-in sends browsers to ${location%%\?*}, not to the identity provider"
|
||||
else
|
||||
fail "Sign-in: /api/v1.0/authenticate/ answers $code, not 302"
|
||||
fi
|
||||
|
||||
# ── 6. LiveKit announces the address its domain resolves to ───────────────────
|
||||
|
||||
node_ip=$(docker compose logs livekit 2>/dev/null | grep -o '"nodeIP": "[^"]*"' | tail -1 | cut -d'"' -f4 || true)
|
||||
addresses=$(getent ahosts "$LIVEKIT_HOST" | cut -d' ' -f1 | sort -u || true)
|
||||
if [[ -z "$addresses" ]]; then
|
||||
fail "${LIVEKIT_HOST} does not resolve from this server"
|
||||
elif [[ -z "$node_ip" ]]; then
|
||||
fail "LiveKit's log has no nodeIP line"
|
||||
elif grep -qxF "$node_ip" <<<"$addresses"; then
|
||||
pass "LiveKit announces ${node_ip}, the address of ${LIVEKIT_HOST}"
|
||||
else
|
||||
fail "LiveKit announces ${node_ip}, but ${LIVEKIT_HOST} resolves to ${addresses//$'\n'/ }"
|
||||
fi
|
||||
|
||||
# Prefer the address LiveKit announces, which browsers send media to.
|
||||
target=$(grep -xF "${node_ip:-none}" <<<"$addresses" || head -1 <<<"$addresses")
|
||||
if [[ -z "$target" ]]; then
|
||||
fail "${LIVEKIT_HOST}:7881 untested, the domain does not resolve"
|
||||
elif timeout 5 bash -c "exec 3<>/dev/tcp/${target}/7881" 2>/dev/null; then
|
||||
pass "${LIVEKIT_HOST}:7881 accepts TCP from this server; a test from outside is stronger"
|
||||
else
|
||||
fail "${LIVEKIT_HOST}:7881 does not accept TCP from this server: open the port in the firewall"
|
||||
fi
|
||||
|
||||
# ── 7. LiveKit reports calls to the backend ───────────────────────────────────
|
||||
|
||||
codes=$(docker compose logs backend 2>/dev/null \
|
||||
| grep -oE 'webhooks-livekit/[^"]*" [0-9]{3}' | grep -oE '[0-9]{3}$' || true)
|
||||
if [[ -z "$codes" ]]; then
|
||||
skip "LiveKit webhooks: no call yet"
|
||||
else
|
||||
total=$(wc -l <<<"$codes")
|
||||
bad=$(grep -cvx 200 <<<"$codes" || true)
|
||||
if [[ "$bad" == 0 ]]; then
|
||||
pass "LiveKit webhooks: all ${total} answered 200"
|
||||
else
|
||||
fail "LiveKit webhooks: ${bad} of ${total} answered $(grep -vx 200 <<<"$codes" | sort -u | paste -sd,)"
|
||||
fi
|
||||
fi
|
||||
|
||||
# ── Verdict ───────────────────────────────────────────────────────────────────
|
||||
|
||||
echo ""
|
||||
if [[ "$failed" == 0 ]]; then
|
||||
echo "All $((passed + failed)) checks passed. Now join a meeting from two devices on different networks."
|
||||
else
|
||||
echo "${failed} of $((passed + failed)) checks failed."
|
||||
exit 1
|
||||
fi
|
||||
@@ -1,317 +0,0 @@
|
||||
# Code tour
|
||||
|
||||
Find each part of Meet's code in the repository before you change it. [How Meet works](../overview/how-meet-works.md) explains how the parts work together, and [Develop locally](develop.md) how to run them.
|
||||
|
||||
## TL;DR
|
||||
|
||||
The Django backend is [`src/backend`](https://github.com/suitenumerique/meet/tree/main/src/backend), the React frontend [`src/frontend`](https://github.com/suitenumerique/meet/tree/main/src/frontend), and LiveKit carries the media. The agents, the summary service and the Helm chart each have their own directory under `src/`.
|
||||
|
||||
## The repository
|
||||
|
||||
```
|
||||
meet/
|
||||
├── src/
|
||||
│ ├── backend/ Django application: API, rooms, recordings, LiveKit control
|
||||
│ ├── frontend/ React application served to browsers
|
||||
│ ├── agents/ LiveKit agents: live subtitles, metadata collector
|
||||
│ ├── summary/ FastAPI service that transcribes and summarizes recordings
|
||||
│ ├── sdk/ TypeScript SDK: a button that creates a Meet link in another app
|
||||
│ ├── addons/ Outlook add-in
|
||||
│ ├── mail/ MJML sources of the emails
|
||||
│ └── helm/ Helm chart and the helmfile used for local Kubernetes
|
||||
├── .github/ CI: pull request checks, image builds, Helm chart release
|
||||
├── docker/ Dev Keycloak realm, LiveKit, nginx, Garage; DINUM frontend image
|
||||
├── env.d/ Environment file templates, for development and production
|
||||
├── bin/ Wrappers for docker compose, Tiltfile, release, Scalingo buildpack
|
||||
├── deploy/ The nginx configuration template of the Scalingo deployment
|
||||
├── crowdin/ The Crowdin configuration that syncs the translations
|
||||
├── docs/ This site
|
||||
├── gitlint/ The commit message rule CI applies
|
||||
├── compose.yml The development stack
|
||||
├── Dockerfile The backend image, development and production stages
|
||||
├── Makefile Every development command
|
||||
├── CHANGELOG.md One line per change, written in each pull request
|
||||
└── UPGRADE.md What an operator does when upgrading
|
||||
```
|
||||
|
||||
## Backend
|
||||
|
||||
A [Django](https://www.djangoproject.com/) 5.2 project in three parts:
|
||||
|
||||
- [`meet`](https://github.com/suitenumerique/meet/tree/main/src/backend/meet), the project, holds the settings and the root URLs.
|
||||
- [`core`](https://github.com/suitenumerique/meet/tree/main/src/backend/core), an app, holds the code.
|
||||
- [`demo`](https://github.com/suitenumerique/meet/tree/main/src/backend/demo), a second app, holds the `create_demo` and `createsuperuser` commands that `make demo` and `make superuser` call.
|
||||
|
||||
| Path under `src/backend/` | What it holds |
|
||||
|---|---|
|
||||
| [`meet/settings.py`](https://github.com/suitenumerique/meet/blob/main/src/backend/meet/settings.py) | Every setting, read from environment variables through django-configurations; each variable is in [Environment variables](../reference/env-variables.md). [`DJANGO_CONFIGURATION`](../reference/env-variables.md#DJANGO_CONFIGURATION) picks the class: `Development` or `Test` locally, `Production` on a server |
|
||||
| [`meet/celery_app.py`](https://github.com/suitenumerique/meet/blob/main/src/backend/meet/celery_app.py) | The Celery application the `celery-dev` worker runs |
|
||||
| [`core/models.py`](https://github.com/suitenumerique/meet/blob/main/src/backend/core/models.py) | The data model, described under [Models](#models) |
|
||||
| [`core/api/`](https://github.com/suitenumerique/meet/tree/main/src/backend/core/api) | The REST API the frontend calls, under `/api/v1.0/`, built on [Django REST Framework](https://www.django-rest-framework.org/): viewsets, serializers, permissions, throttling |
|
||||
| [`core/external_api/`](https://github.com/suitenumerique/meet/tree/main/src/backend/core/external_api) | The API other applications call to create and manage rooms, authenticated with application tokens |
|
||||
| [`core/addons/`](https://github.com/suitenumerique/meet/tree/main/src/backend/core/addons) | The endpoints of add-ins embedded in other applications, such as the Outlook add-in |
|
||||
| [`core/authentication/`](https://github.com/suitenumerique/meet/tree/main/src/backend/core/authentication) | Sign-in, and the authentication of requests carrying a LiveKit pass |
|
||||
| [`core/services/`](https://github.com/suitenumerique/meet/tree/main/src/backend/core/services) | The logic behind the API: the waiting room, presence, invitations, moderation, LiveKit webhooks, phone dial-in, subtitles |
|
||||
| [`core/recording/`](https://github.com/suitenumerique/meet/tree/main/src/backend/core/recording) | Starting and stopping recordings, and what happens once one ends |
|
||||
| [`core/tasks/`](https://github.com/suitenumerique/meet/tree/main/src/backend/core/tasks) | Celery tasks: deleting connection-test rooms, deleting files, sending email. They run on the Celery worker when [`CELERY_ENABLED`](../reference/env-variables.md#CELERY_ENABLED) is on. Otherwise file deletion and email run inline in the request, and the connection-test room cleanup is not scheduled |
|
||||
| [`core/management/commands/`](https://github.com/suitenumerique/meet/tree/main/src/backend/core/management/commands) | Maintenance commands: `purge_deleted_files`, `purge_inactive_rooms`, `clean_pending_files` and `merge_duplicate_users` |
|
||||
| [`core/audit/`](https://github.com/suitenumerique/meet/tree/main/src/backend/core/audit), [`core/auditing.py`](https://github.com/suitenumerique/meet/blob/main/src/backend/core/auditing.py) | The audit log of room, token and recording operations, see [The audit log](#the-audit-log) |
|
||||
| [`core/roomkit/`](https://github.com/suitenumerique/meet/tree/main/src/backend/core/roomkit) | Meeting-room hardware joining over SIP |
|
||||
| [`core/analytics/`](https://github.com/suitenumerique/meet/tree/main/src/backend/core/analytics) | Product analytics sent to PostHog, and the feature flags read from it |
|
||||
| [`core/admin.py`](https://github.com/suitenumerique/meet/blob/main/src/backend/core/admin.py) | The Django admin pages |
|
||||
| [`core/factories.py`](https://github.com/suitenumerique/meet/blob/main/src/backend/core/factories.py), [`core/tests/`](https://github.com/suitenumerique/meet/tree/main/src/backend/core/tests) | Test data factories and the test suite |
|
||||
| [`locale/`](https://github.com/suitenumerique/meet/tree/main/src/backend/locale) | The backend's translations |
|
||||
|
||||
Sign-in goes through the `oidc_login` module of [django-lasuite](https://github.com/suitenumerique/django-lasuite), built on mozilla-django-oidc; [`core/urls.py`](https://github.com/suitenumerique/meet/blob/main/src/backend/core/urls.py) mounts its URLs. Meet's own backend class is in [`core/authentication/backends.py`](https://github.com/suitenumerique/meet/blob/main/src/backend/core/authentication/backends.py).
|
||||
|
||||
### Models
|
||||
|
||||
| Model | What it stores |
|
||||
|---|---|
|
||||
| `User` | An account, created at the first OIDC sign-in. A staff account signs in to `/admin/` with its `admin_email` and a password |
|
||||
| `Room` | A meeting room: its `slug`, the code in the URL; its `access_level`, `public`, `trusted` or `restricted`; its `configuration`, a JSON object every participant receives; and its telephony `pin_code` |
|
||||
| `ResourceAccess` | A user's role on a room: `owner`, `administrator` or `member` |
|
||||
| `Recording`, `RecordingAccess` | A recording or a transcription, its `status` from `initiated` to `saved` or a failure, and who may see it |
|
||||
| `Application`, `ApplicationDomain` | An application allowed to call the external API, and the email domains it may act for |
|
||||
| `File` | An uploaded file, such as a custom background image, and its upload state |
|
||||
|
||||
### API
|
||||
|
||||
[`core/urls.py`](https://github.com/suitenumerique/meet/blob/main/src/backend/core/urls.py) mounts two APIs. The frontend's is described by the schema the backend generates, at `/api/v1.0/swagger/` under the `Development` configuration; the other is the [External API](../reference/external-api.md).
|
||||
|
||||
| API | Prefix | Routes and their code |
|
||||
|---|---|---|
|
||||
| Browser API | `/api/v1.0/` | `users`, `rooms`, `resource-accesses`, `recordings`, `files` and `diagnostics` from [`core/api/viewsets.py`](https://github.com/suitenumerique/meet/blob/main/src/backend/core/api/viewsets.py); `roomkit` from `core/roomkit/`; `addons/sessions` from `core/addons/`; the sign-in routes; `config/`, the instance's settings for the frontend |
|
||||
| External API | `/external-api/v1.0/`, mounted only when [`EXTERNAL_API_ENABLED`](../reference/env-variables.md#EXTERNAL_API_ENABLED) is on | `application`, `rooms` and `users` from [`core/external_api/viewsets.py`](https://github.com/suitenumerique/meet/blob/main/src/backend/core/external_api/viewsets.py) |
|
||||
|
||||
Most actions on a room are extra routes of `RoomViewSet`, such as `request-entry`, `start-recording` or `mute-participant`.
|
||||
|
||||
## Frontend
|
||||
|
||||
A [React](https://react.dev/) 18 and [TypeScript](https://www.typescriptlang.org/) application built with [Vite](https://vite.dev/). Its libraries, whose versions are in [`package.json`](https://github.com/suitenumerique/meet/blob/main/src/frontend/package.json):
|
||||
|
||||
| For | Library |
|
||||
|---|---|
|
||||
| Components | [React Aria](https://react-spectrum.adobe.com/react-aria/) |
|
||||
| Styles | [Panda CSS](https://panda-css.com/) |
|
||||
| Global state | [Valtio](https://valtio.dev/) |
|
||||
| Server data | [TanStack Query](https://tanstack.com/query) |
|
||||
| Routes | [wouter](https://github.com/molefrog/wouter) |
|
||||
| Translations | i18next |
|
||||
| Calls | LiveKit's [`livekit-client`](https://github.com/livekit/client-sdk-js) and [`@livekit/components-react`](https://github.com/livekit/components-js) |
|
||||
|
||||
| Path under `src/frontend/src/` | What it holds |
|
||||
|---|---|
|
||||
| [`features/`](https://github.com/suitenumerique/meet/tree/main/src/frontend/src/features) | One directory per feature: `rooms`, `chat`, `recording`, `participants`, `settings` and the others. Each keeps its own components, hooks and API calls |
|
||||
| [`features/rooms/livekit/`](https://github.com/suitenumerique/meet/tree/main/src/frontend/src/features/rooms/livekit) | Everything inside a call: the control bar, the participant tiles, the background effects, the LiveKit hooks |
|
||||
| [`primitives/`](https://github.com/suitenumerique/meet/tree/main/src/frontend/src/primitives) | The styled building blocks, `Button`, `ToggleButton`, `Dialog`, `Menu` and others, wrapping React Aria. A new component uses these rather than raw HTML or a direct React Aria import |
|
||||
| [`components/`](https://github.com/suitenumerique/meet/tree/main/src/frontend/src/components) | Components several features share |
|
||||
| [`stores/`](https://github.com/suitenumerique/meet/tree/main/src/frontend/src/stores) | Valtio stores, one file per concern: `layout.ts`, `chat.ts`, `recording.ts` and the others. A component reads one with `useSnapshot()` and changes it by assigning to the store |
|
||||
| [`api/`](https://github.com/suitenumerique/meet/tree/main/src/frontend/src/api) | `fetchApi`, which calls the backend, the TanStack Query client, and `useConfig`, which reads the instance's settings from `/api/v1.0/config/` |
|
||||
| [`hooks/`](https://github.com/suitenumerique/meet/tree/main/src/frontend/src/hooks) | Hooks shared across features, such as `useScreenReaderAnnounce` |
|
||||
| [`locales/`](https://github.com/suitenumerique/meet/tree/main/src/frontend/src/locales), [`i18n/`](https://github.com/suitenumerique/meet/tree/main/src/frontend/src/i18n) | One JSON file per namespace and language, and the i18next setup |
|
||||
| [`routes.ts`](https://github.com/suitenumerique/meet/blob/main/src/frontend/src/routes.ts) | The pages and their URLs |
|
||||
| [`utils/livekit.ts`](https://github.com/suitenumerique/meet/blob/main/src/frontend/src/utils/livekit.ts) | Browser detection the LiveKit workarounds rely on |
|
||||
|
||||
Server data, such as a room or the list of recordings, goes through TanStack Query. A Valtio store holds what only the browser knows, such as the layout or an open panel.
|
||||
|
||||
Accessibility follows these patterns:
|
||||
|
||||
- Every interactive element has an accessible name, from its visible text or an `aria-label` read through `t()`. [`HandToggle.tsx`](https://github.com/suitenumerique/meet/blob/main/src/frontend/src/features/rooms/livekit/components/controls/HandToggle.tsx) shows the usual shape: a `ToggleButton` from the primitives, its label and tooltip translated.
|
||||
- A state change the screen does not show, such as a recording starting, is announced with `useScreenReaderAnnounce()`.
|
||||
- A room event goes through the toasts of [`ToastProvider.tsx`](https://github.com/suitenumerique/meet/blob/main/src/frontend/src/features/notifications/components/ToastProvider.tsx).
|
||||
- A tooltip shown in picture-in-picture uses `VisualOnlyTooltip` instead of `TooltipWrapper`, so a screen reader does not read it twice. For the same reason, an element that only shows something carries no `aria-live`: announce the change once, with `useScreenReaderAnnounce()`.
|
||||
- A React Aria `Dialog` traps focus and gives it back to the button that opened it. A side panel or a custom toolbar does neither: move focus into it yourself, with `autoFocus`, a `ref.focus()` or a `FocusScope`.
|
||||
|
||||
## How Meet talks to LiveKit
|
||||
|
||||
### The pass
|
||||
|
||||
The pass is the LiveKit access token the backend signs for each participant; the browser connects to LiveKit with it, as [Joining a meeting](../overview/how-meet-works.md#joining-a-meeting) describes.
|
||||
|
||||
[`generate_token()`](https://github.com/suitenumerique/meet/blob/main/src/backend/core/utils.py) in `core/utils.py` builds it. The token's name is the participant's display name, and it carries three attributes: `room_role`, `is_authenticated` and `color`, the last derived from the participant's identity.
|
||||
|
||||
Owners and administrators get LiveKit's `room_admin` grant, which lets them moderate.
|
||||
|
||||
The pass reaches the browser two ways:
|
||||
|
||||
- In the `livekit` field of the answer to `POST /api/v1.0/rooms/<id>/join/`, the `join` action of `RoomViewSet` in [`core/api/viewsets.py`](https://github.com/suitenumerique/meet/blob/main/src/backend/core/api/viewsets.py), when the visitor may enter at once. The display name travels in its body, as `username`; reading a room returns no pass.
|
||||
- In the answer to `POST /api/v1.0/rooms/<id>/request-entry/`, once someone admits the visitor from the waiting room, from [`core/services/lobby.py`](https://github.com/suitenumerique/meet/blob/main/src/backend/core/services/lobby.py).
|
||||
|
||||
The pass also authenticates the API calls a participant makes during a call, signed in or not. They accept it through `LiveKitTokenAuthentication` in [`core/authentication/livekit.py`](https://github.com/suitenumerique/meet/blob/main/src/backend/core/authentication/livekit.py).
|
||||
|
||||
```mermaid
|
||||
sequenceDiagram
|
||||
participant Browser
|
||||
participant Backend
|
||||
participant LiveKit
|
||||
|
||||
Browser->>Backend: POST /api/v1.0/rooms/{id}/join/ {username}
|
||||
Backend-->>Browser: room, with livekit {url, token, room}
|
||||
Browser->>LiveKit: WebSocket with the token
|
||||
Browser->>LiveKit: publish microphone and camera
|
||||
Backend->>LiveKit: room metadata, data messages, moderation, egress, agents
|
||||
LiveKit->>Backend: POST /api/v1.0/rooms/webhooks-livekit/
|
||||
```
|
||||
|
||||
### What the backend asks LiveKit
|
||||
|
||||
Every call goes through the client that [`create_livekit_client()`](https://github.com/suitenumerique/meet/blob/main/src/backend/core/utils.py) returns.
|
||||
|
||||
| What | Backend side | What the frontend does with it |
|
||||
|---|---|---|
|
||||
| Room metadata: the room's configuration and access level, and the recording state | `RoomManagement.update_metadata()` in [`core/services/room_management.py`](https://github.com/suitenumerique/meet/blob/main/src/backend/core/services/room_management.py) | [`RoomMetadataSynchronizer`](https://github.com/suitenumerique/meet/blob/main/src/frontend/src/features/rooms/livekit/components/RoomMetadataSynchronizer.tsx) copies the configuration and access level into the cached room, and [`useRecordingStatuses`](https://github.com/suitenumerique/meet/blob/main/src/frontend/src/features/recording/hooks/useRecordingStatuses.ts) reads the recording state |
|
||||
| Data messages to every participant, such as someone waiting to enter | `notify_participants()` in [`core/utils.py`](https://github.com/suitenumerique/meet/blob/main/src/backend/core/utils.py) | [`MainNotificationToast.tsx`](https://github.com/suitenumerique/meet/blob/main/src/frontend/src/features/notifications/MainNotificationToast.tsx) turns them into toasts and sounds |
|
||||
| Muting, removing and updating a participant | [`core/services/participants_management.py`](https://github.com/suitenumerique/meet/blob/main/src/backend/core/services/participants_management.py) | LiveKit applies it to the participant's connection |
|
||||
| Recording, through LiveKit Egress | [`core/recording/worker/services.py`](https://github.com/suitenumerique/meet/blob/main/src/backend/core/recording/worker/services.py), behind [`mediator.py`](https://github.com/suitenumerique/meet/blob/main/src/backend/core/recording/worker/mediator.py) | Shows the state carried by the room metadata |
|
||||
| Sending an agent into a room | [`core/services/subtitle.py`](https://github.com/suitenumerique/meet/blob/main/src/backend/core/services/subtitle.py) for subtitles, [`core/recording/services/metadata_collector.py`](https://github.com/suitenumerique/meet/blob/main/src/backend/core/recording/services/metadata_collector.py) during a transcription | Shows the subtitles the agent publishes |
|
||||
| Phone dial-in rules, which route a caller's PIN to the room | [`core/services/sip_management.py`](https://github.com/suitenumerique/meet/blob/main/src/backend/core/services/sip_management.py) | Nothing: the caller joins as an audio-only participant |
|
||||
|
||||
### What LiveKit tells the backend
|
||||
|
||||
LiveKit posts its events to `/api/v1.0/rooms/webhooks-livekit/`, the `webhooks_livekit` action of `RoomViewSet`. `LiveKitEventsService` in [`core/services/livekit_events.py`](https://github.com/suitenumerique/meet/blob/main/src/backend/core/services/livekit_events.py) checks the signature, then handles each event:
|
||||
|
||||
| Event | What the backend does |
|
||||
|---|---|
|
||||
| `egress_updated` | Updates the recording's status |
|
||||
| `egress_ended` | Clears the recording state from the room metadata and stops the metadata collector. On success, [`core/recording/event/notification.py`](https://github.com/suitenumerique/meet/blob/main/src/backend/core/recording/event/notification.py) emails a screen recording's link to the people [Email](../self-hosting/configuration/email.md) names, and sends a transcription to the summary service |
|
||||
| `room_started` | Closes the LiveKit room again if its Meet room was deleted; otherwise records the start time `purge_inactive_rooms` reads, and creates the room's phone dial-in rule when telephony or Roomkit is on |
|
||||
| `room_finished` | Deletes that rule and clears the room's presence and waiting-room state |
|
||||
| `participant_left` | Removes the participant from the presence cache, unless [`PRESENCE_CLEAR_ON_PARTICIPANT_LEFT`](../reference/env-variables.md#PRESENCE_CLEAR_ON_PARTICIPANT_LEFT) is off |
|
||||
|
||||
Any other event is acknowledged and ignored, and so is every event of a connection-test room or of a room whose name [`LIVEKIT_WEBHOOK_EVENTS_FILTER_REGEX`](../reference/env-variables.md#LIVEKIT_WEBHOOK_EVENTS_FILTER_REGEX) does not match. In development, LiveKit finds the endpoint through the `webhook` section of [`docker/livekit/config/livekit-server.yaml`](https://github.com/suitenumerique/meet/blob/main/docker/livekit/config/livekit-server.yaml).
|
||||
|
||||
### The frontend side
|
||||
|
||||
[`Conference.tsx`](https://github.com/suitenumerique/meet/blob/main/src/frontend/src/features/rooms/components/Conference.tsx) joins the room with `POST /api/v1.0/rooms/<id>/join/`, through [`joinRoom.ts`](https://github.com/suitenumerique/meet/blob/main/src/frontend/src/features/rooms/api/joinRoom.ts), builds the LiveKit `Room` with Meet's options, and renders `<LiveKitRoom>` with the pass and the server URL. When the answer carries no pass, it shows the waiting room instead. It also holds the browser workarounds, such as an early WebSocket that lets Firefox connect behind some proxies, when `enable_firefox_proxy_workaround` is on.
|
||||
|
||||
The call's interface is [`VideoConference.tsx`](https://github.com/suitenumerique/meet/blob/main/src/frontend/src/features/rooms/livekit/prefabs/VideoConference.tsx).
|
||||
|
||||
## Agents
|
||||
|
||||
[`src/agents`](https://github.com/suitenumerique/meet/tree/main/src/agents) holds two LiveKit agents, workers that LiveKit sends into a room as silent participants when the backend asks.
|
||||
|
||||
| File | What it does |
|
||||
|---|---|
|
||||
| [`multi_user_transcriber.py`](https://github.com/suitenumerique/meet/blob/main/src/agents/multi_user_transcriber.py) | Live subtitles: transcribes each speaker and publishes the text to the room |
|
||||
| [`voxtral_vllm_stt.py`](https://github.com/suitenumerique/meet/blob/main/src/agents/voxtral_vllm_stt.py) | The speech-to-text plugin for Voxtral served by vLLM, one of the subtitles providers |
|
||||
| [`metadata_collector.py`](https://github.com/suitenumerique/meet/blob/main/src/agents/metadata_collector.py) | During a transcription, records who speaks when, connections and chat, and writes them to S3 for the summary service |
|
||||
|
||||
Their settings are under [Agents](../reference/env-variables.md#agents).
|
||||
|
||||
## Summary service
|
||||
|
||||
[`src/summary`](https://github.com/suitenumerique/meet/tree/main/src/summary) is a [FastAPI](https://fastapi.tiangolo.com/) application with [Celery](https://docs.celeryq.dev/) workers:
|
||||
|
||||
- The backend posts a recording to its API, [`summary/api/route/tasks_v2.py`](https://github.com/suitenumerique/meet/blob/main/src/summary/summary/api/route/tasks_v2.py).
|
||||
- The workers in [`summary/core/celery_worker.py`](https://github.com/suitenumerique/meet/blob/main/src/summary/summary/core/celery_worker.py) transcribe it, summarize it and report back to the backend's `/api/v1.0/recordings/external-process-hook/`.
|
||||
|
||||
The queues and the order of the steps are in [How Meet works](../overview/how-meet-works.md#transcription-and-summary), and the settings under [Summary service](../reference/env-variables.md#summary-service).
|
||||
|
||||
## Other packages
|
||||
|
||||
| Path | What it holds |
|
||||
|---|---|
|
||||
| [`src/sdk`](https://github.com/suitenumerique/meet/tree/main/src/sdk) | The SDK in `library/`, published on npm as `@gouvfr-lasuite/visio-sdk`, which adds to another web application a button that creates a Meet link, and a sample application using it in `consumer/`. Its own guide is [`src/sdk/library/CONTRIBUTING.md`](https://github.com/suitenumerique/meet/blob/main/src/sdk/library/CONTRIBUTING.md) |
|
||||
| [`src/addons/outlook`](https://github.com/suitenumerique/meet/tree/main/src/addons/outlook) | The Outlook add-in that adds a Meet link to an event, calling [`core/addons/`](https://github.com/suitenumerique/meet/tree/main/src/backend/core/addons) |
|
||||
| [`src/mail`](https://github.com/suitenumerique/meet/tree/main/src/mail) | The MJML sources of the emails, compiled as [Email templates](develop.md#email-templates) describes |
|
||||
|
||||
## Deployment files
|
||||
|
||||
| Path | What it holds |
|
||||
|---|---|
|
||||
| [`src/helm/meet`](https://github.com/suitenumerique/meet/tree/main/src/helm/meet) | The Helm chart. Its values are documented in its [`README.md`](https://github.com/suitenumerique/meet/blob/main/src/helm/meet/README.md), which `generate-readme.sh` regenerates from `values.yaml`. [Helm deployment](../self-hosting/kubernetes/helm.md) covers deploying it |
|
||||
| [`src/helm/helmfile.yaml.gotmpl`](https://github.com/suitenumerique/meet/blob/main/src/helm/helmfile.yaml.gotmpl), [`src/helm/env.d`](https://github.com/suitenumerique/meet/tree/main/src/helm/env.d) | The helmfile and the values of the `dev-keycloak` and `dev-dinum` environments that Tilt deploys |
|
||||
| [`env.d/development`](https://github.com/suitenumerique/meet/tree/main/env.d/development) | One `.dist` template per service of the development stack, which [First run](develop.md#first-run) copies |
|
||||
| [`env.d/production.dist`](https://github.com/suitenumerique/meet/tree/main/env.d/production.dist) | The production templates. The directory carries the `.dist` suffix, not the files, so each keeps its name when the [Deployment guide](../self-hosting/compose/deployment-guide.md) downloads it |
|
||||
| [`Dockerfile`](https://github.com/suitenumerique/meet/blob/main/Dockerfile), [`src/frontend/Dockerfile`](https://github.com/suitenumerique/meet/blob/main/src/frontend/Dockerfile), [`docker/dinum-frontend`](https://github.com/suitenumerique/meet/tree/main/docker/dinum-frontend) | The backend image, the frontend image, and the frontend image with the French government's styles |
|
||||
| [`deploy/`](https://github.com/suitenumerique/meet/tree/main/deploy), [`Procfile`](https://github.com/suitenumerique/meet/blob/main/Procfile) | The Scalingo deployment, described in [Scalingo](../self-hosting/scalingo.md) |
|
||||
|
||||
## The audit log
|
||||
|
||||
[Audit logging](../self-hosting/configuration/audit-logging.md) describes what each event holds and how operators collect it.
|
||||
|
||||
### Declaring an action
|
||||
|
||||
Every action is declared once, in `core/auditing.py`, as an `audit.Action` constant. An action may carry its ECS category and types, which then apply to every event it emits; a type its category does not expect fails at import time:
|
||||
|
||||
```python
|
||||
APPLICATION_TOKEN_ISSUE = audit.Action(
|
||||
"application.token.issue",
|
||||
category=EventCategory.AUTHENTICATION,
|
||||
types=(EventType.START,),
|
||||
)
|
||||
ROOM_CREATE = audit.Action("room.create")
|
||||
```
|
||||
|
||||
`core/auditing.py` imports nothing but the audit facility and leaf helpers such as `core.services.transit_code`, so that any module can import it, authentication classes included. Models and authentication classes are registered separately, in `core/audit_registry.py`.
|
||||
|
||||
### Auditing a DRF view
|
||||
|
||||
A DRF view only declares the actions it audits: everything else is derived from the response.
|
||||
|
||||
CRUD actions are mapped in `audit_actions`. An extra action names its own on its route, so that renaming its method cannot silently stop auditing it:
|
||||
|
||||
```python
|
||||
from core import audit, auditing
|
||||
|
||||
|
||||
class RoomViewSet(audit.AuditViewMixin, viewsets.GenericViewSet):
|
||||
audit_actions = {"create": auditing.ROOM_CREATE, "retrieve": auditing.ROOM_RETRIEVE}
|
||||
|
||||
def perform_create(self, serializer):
|
||||
self.audit_target = serializer.save()
|
||||
|
||||
@action(detail=True, methods=["post"], audit_action=auditing.RECORDING_START)
|
||||
def start_room_recording(self, request, pk=None): ...
|
||||
```
|
||||
|
||||
`AuditViewMixin` fills in the rest:
|
||||
|
||||
- The ECS category and types come from the action, or default to `api` and the DRF action.
|
||||
- The outcome, reason and status code come from the response status: 401, 403 and 429 are `denied`, other errors are `failure`, filed as [Classification](../self-hosting/configuration/audit-logging.md#classification) describes.
|
||||
- The target is the object `get_object()` returned, unless the view assigns `audit_target`.
|
||||
- A view can also assign `audit_user_target`, `audit_details` and `audit_actor`, where `None` records no account, or override `get_audit_fields()`.
|
||||
|
||||
### Auditing from anywhere else
|
||||
|
||||
Outside of `AuditViewMixin`, from a view or deeper in a service, call `audit.log`. A `category` or `types` given here wins over the action's:
|
||||
|
||||
```python
|
||||
audit.log(auditing.USER_PROVISION, target=user)
|
||||
```
|
||||
|
||||
Without `request=`, the event reads the context of the request being served, `audit.request_context()`, which `AuditLogMiddleware` captures when the request comes in. Outside a request, as in a Celery task, the context is empty and the actor is the system.
|
||||
|
||||
!!! note
|
||||
That context holds the Django request. DRF copies the user and auth onto the Django request, but not the authenticator, so a call made inside a DRF view without `request=` should pass `auth_method=`.
|
||||
|
||||
### How fields are filled
|
||||
|
||||
- **Request fields** are read from the request: the real client address, the path, the user agent and the request id.
|
||||
- **The actor** comes from `request.user`, `request.auth` and the DRF authenticator, as [Actors](../self-hosting/configuration/audit-logging.md#actors) describes. `audit.register_auth_method` maps the authenticator's class to an auth method, see [Registering models](#registering-models-and-authentication-methods). Without a request, the actor is the system. Override the actor with `actor=`, `actor_type=`, `auth_method=` and `client_id=`; an explicit `actor_type=` keeps the signed-in account. `actor=None` records no account: for a caller failing to authenticate, an application acting before it is given a delegated user, or the system.
|
||||
- **The target** is described by its model name, its primary key and the `fields` its model is registered with, see [Targets](../self-hosting/configuration/audit-logging.md#targets). A model that is not registered is still identified. The account the action is about, `user.target`, is found from the target, unless given as `user_target=`. Name a service the backend calls with `target_service=`. Any other keyword argument is recorded under `lasuite.details`.
|
||||
|
||||
### Emission never raises
|
||||
|
||||
A broken configuration or value is reported on the application logger and to Sentry, and the business operation goes on. A registered field that cannot be read is left out of the target, and the event is still emitted.
|
||||
|
||||
### Admin pages need nothing
|
||||
|
||||
Every admin class, Django's own included, is audited as it is registered, by `AuditedAdminSite` in `core/audit/admin.py`. Registering a new admin's model only adds its category and allowed values.
|
||||
|
||||
### Registering models and authentication methods
|
||||
|
||||
The project describes itself to the audit facility in code, in `core/audit_registry.py`. Once the audit app is ready, it imports the `audit_registry` module of every installed app.
|
||||
|
||||
**`audit.register(Model, ...)`** tells the audit log how to handle a model:
|
||||
|
||||
- `fields`: the fields describing it as a target;
|
||||
- `admin_values`: the fields whose before and after values may be recorded for admin writes;
|
||||
- `category`: the ECS category of its admin writes;
|
||||
- `entity_type`: its ECS entity type, when one of the allowed values fits, such as `application` or `user`;
|
||||
- `user_target`: the attribute holding the account an event on it is about, such as `user` for an access.
|
||||
|
||||
A proxy model falls back to its concrete model. Registering a model twice raises `AlreadyRegistered`, and an entity type ECS does not allow raises `ValueError`.
|
||||
|
||||
**`audit.register_auth_method(klass, name)`** sets the `lasuite.auth.method` of a DRF authentication class or of a login backend. A DRF class inherits the name of its closest registered base, and DRF's own classes are built in. A login backend must be registered itself, because custom backends often subclass `ModelBackend` just for its permission checks. `ModelBackend` is built in as `password`.
|
||||
@@ -1,305 +0,0 @@
|
||||
# Develop locally
|
||||
|
||||
The whole stack runs on your machine in Docker Compose, driven by the [`Makefile`](https://github.com/suitenumerique/meet/blob/main/Makefile). The [Code tour](code-tour.md) shows where the code lives, and [Pull requests](https://github.com/suitenumerique/meet/blob/main/CONTRIBUTING.md) how a change gets merged.
|
||||
|
||||
## TL;DR
|
||||
|
||||
```bash
|
||||
# 1. Get the code; to propose a change, clone your fork instead, see Pull requests
|
||||
git clone https://github.com/suitenumerique/meet.git && cd meet
|
||||
# 2. Build the images, create the database and the demo data, start the stack
|
||||
make bootstrap FLUSH_ARGS='--no-input'
|
||||
# 3. Run the frontend with hot reload at localhost:3000, user meet / meet
|
||||
make frontend-development-install && make run-frontend-development
|
||||
# 4. Run every test suite, then every linter
|
||||
make test && make lint && make frontend-lint && make frontend-format
|
||||
# 5. Stop the stack, keeping its data
|
||||
make stop
|
||||
```
|
||||
|
||||
## Prerequisites
|
||||
|
||||
| Tool | What it is for |
|
||||
|---|---|
|
||||
| Git | Cloning the repository and committing |
|
||||
| Docker Engine with the Compose plugin | Every service of the stack. The commands call `docker compose`, not the old `docker-compose` |
|
||||
| GNU Make | The `make` targets on this page |
|
||||
| Node.js 22 and npm | The frontend dev server, linters and tests, which run on your machine. The frontend image builds on [Node 22](https://github.com/suitenumerique/meet/blob/main/src/frontend/Dockerfile) |
|
||||
| [uv](https://docs.astral.sh/uv/), optional | Adding or upgrading a Python dependency from your machine |
|
||||
|
||||
The `Makefile` runs every container under your user ID, through `DOCKER_USER`, so files a container writes into your checkout stay yours. Prefix a hand-typed `docker compose` the same way: `DOCKER_USER=$(id -u):$(id -g) docker compose ...`.
|
||||
|
||||
The stack publishes these ports, so they must be free: 3000, 8071, 8080, 8083, 8001, 9000, 1081, 6379, 15432, 5433, 7880, 7881, 7882/UDP, 3478/UDP and 30000 to 30100/UDP. All listen on `127.0.0.1` only, except LiveKit's 7880.
|
||||
|
||||
## Start the stack with Docker Compose
|
||||
|
||||
### First run
|
||||
|
||||
```bash
|
||||
# Once after cloning, and again to start over
|
||||
make bootstrap FLUSH_ARGS='--no-input'
|
||||
```
|
||||
|
||||
It empties the database, then creates the Django admin and 100 demo users. It keeps the files you already have in `env.d/development/`, and does not install the frontend's npm dependencies on your machine: `make frontend-development-install` does.
|
||||
|
||||
### Where everything answers
|
||||
|
||||
| Service | Address | Default login |
|
||||
|---|---|---|
|
||||
| Meet | <http://localhost:3000> | `meet` / `meet`, a user of the `meet` realm that Keycloak imports from [`docker/auth/realm.json`](https://github.com/suitenumerique/meet/blob/main/docker/auth/realm.json) |
|
||||
| Backend API | <http://localhost:8071/api/v1.0/>, schema at <http://localhost:8071/api/v1.0/swagger/> and <http://localhost:8071/api/v1.0/redoc/> | The browser session from signing in to Meet |
|
||||
| Django admin | <http://localhost:8071/admin/> | `admin@example.com` / `admin`, created by `make superuser` |
|
||||
| Keycloak | <http://localhost:8083>, behind the `nginx` container | `admin` / `admin` for the administration console |
|
||||
| LiveKit | `ws://localhost:7880` | API key `devkey`, secret `secret`, from [`docker/livekit/config/livekit-server.yaml`](https://github.com/suitenumerique/meet/blob/main/docker/livekit/config/livekit-server.yaml) |
|
||||
| Garage, the S3 storage | <http://localhost:9000>, bucket `meet-media-storage`, no web console | Access key `meet-access-key`, secret `meet-secret-access-key` |
|
||||
| Mailcatcher | <http://localhost:1081>, every email the backend sends | None |
|
||||
| Summary service API | <http://localhost:8001> | The tenant `api_key` in `env.d/development/summary`, `password` by default |
|
||||
| PostgreSQL | `localhost:15432`, database `meet` | `dinum` / `pass` |
|
||||
|
||||
### Everyday commands
|
||||
|
||||
| Command | What it does |
|
||||
|---|---|
|
||||
| `make run` | Starts the backend and its services, the summary service and the frontend container. Run it after `make stop`, and after editing `env.d/development/` to recreate the containers reading it |
|
||||
| `make run-backend` | Starts only what the backend needs: the Django server, its Celery worker, PostgreSQL, Redis, Mailcatcher, Garage, Keycloak behind nginx, and LiveKit with Egress. Use it when the frontend runs outside its container |
|
||||
| `make run-summary` | Starts the summary service API and its two Celery workers, the transcription one and the summary one |
|
||||
| `make stop` | Stops every container and keeps them, so the database survives until the next `make run` |
|
||||
| `make down` | Removes the containers and their network, and the database with the PostgreSQL container: run `make migrate` and `make demo` after the next start. Garage's files stay in `data/media` |
|
||||
| `make status` | Lists the containers and their state, as `docker compose ps` does |
|
||||
| `make logs` | Follows the Django server's log. For another service, run `docker compose logs -f <service>`, with a service name from [`compose.yml`](https://github.com/suitenumerique/meet/blob/main/compose.yml) |
|
||||
| `make demo` | Empties the database, recreates the Django admin and creates the demo users. It asks for confirmation unless you add `FLUSH_ARGS='--no-input'` |
|
||||
| `make resetdb` | Empties the database and recreates the Django admin, without the demo users |
|
||||
| `make superuser` | Creates the Django admin `admin@example.com` with password `admin`, or resets that password if the account exists |
|
||||
| `make help` | Lists the `make` targets with their one-line descriptions. A bare `make` runs it too |
|
||||
| `make clean` | Runs `git clean -idx`: lists every untracked or ignored file, your env files, `data/` and `node_modules/` included, and asks before deleting them |
|
||||
|
||||
### LiveKit agents
|
||||
|
||||
`make run` leaves the subtitles agent and the metadata collector off, since each costs CPU and memory. When a feature's agent is stopped, the feature fails silently: the backend still sends the agent work.
|
||||
|
||||
| Command | What it does |
|
||||
|---|---|
|
||||
| `make run-agent-multi-user-transcriber` | Starts the subtitles agent. Enable it with [`ROOM_SUBTITLE_ENABLED`](../reference/env-variables.md#ROOM_SUBTITLE_ENABLED) in `env.d/development/common`, and give it a speech-to-text provider in `env.d/development/multi_user_transcriber`, see [Subtitles agent](../reference/env-variables.md#subtitles-agent) |
|
||||
| `make run-agent-metadata-collector` | Starts the metadata collector, which records who speaks when during a transcription. Enable it with [`METADATA_COLLECTOR_ENABLED`](../reference/env-variables.md#METADATA_COLLECTOR_ENABLED) in `env.d/development/common` |
|
||||
| `make run-agents` | Starts both |
|
||||
|
||||
After changing either setting, run `make run-backend` so the backend reads the new value.
|
||||
|
||||
### Files in storage
|
||||
|
||||
Garage keeps recordings, transcripts and summaries in its own format under `data/media`: read them through these targets.
|
||||
|
||||
| Command | What it does |
|
||||
|---|---|
|
||||
| `make recordings-list` | Lists the recordings, most recent first, with date, key and size |
|
||||
| `make recordings-download-latest` | Copies the most recent recording into `data/recordings/` |
|
||||
| `make transcripts-list`, `make transcripts-download-latest` | The same for transcripts, into `data/transcripts/` |
|
||||
| `make summaries-list`, `make summaries-download-latest` | The same for summaries, into `data/summaries/` |
|
||||
|
||||
## Work on the backend
|
||||
|
||||
- The `app-dev` container runs Django's development server with [`src/backend`](https://github.com/suitenumerique/meet/tree/main/src/backend) mounted at `/app`: saving a Python file restarts it.
|
||||
- The Celery worker, `celery-dev`, does not reload: run `make run-backend` after changing a task.
|
||||
- The container runs the `Development` configuration, with debug mode and the API schema pages on, `/api/v1.0/swagger/` and `/api/v1.0/redoc/`. Its settings come from `env.d/development/common` and `env.d/development/postgresql`, documented in [Environment variables](../reference/env-variables.md).
|
||||
|
||||
| Command | What it does |
|
||||
|---|---|
|
||||
| `make makemigrations` | Starts PostgreSQL, then creates a migration in `src/backend/core/migrations/` for every model change. Commit the new file with the change |
|
||||
| `make migrate` | Starts PostgreSQL, then applies the migrations. Run it after pulling a branch that adds one |
|
||||
| `make shell` | Opens a Django shell in a new `app-dev` container |
|
||||
| `make dbshell` | Opens `psql` on the database, inside the running `app-dev` container. The stack must be up |
|
||||
| `bin/manage <command>` | Runs any `manage.py` command in a new `app-dev` container under `Development`, for example `bin/manage showmigrations` |
|
||||
| `make back-i18n-generate`, `make back-i18n-compile` | Extract and compile the backend's translatable strings, see [Translations](#translations) |
|
||||
|
||||
## Work on the frontend
|
||||
|
||||
The `frontend` container on port 3000 serves a production build of [`src/frontend`](https://github.com/suitenumerique/meet/tree/main/src/frontend): it shows a change only after `make build-frontend` and `make run`. The settings it reads at runtime come from the backend, under [Frontend](../reference/env-variables.md#frontend).
|
||||
|
||||
For daily work, start the backend with `make run-backend`, then run the Vite dev server on your machine, which reloads on every save:
|
||||
|
||||
| Command | What it does |
|
||||
|---|---|
|
||||
| `make frontend-development-install` | Runs `npm install` in `src/frontend`. Run it once, and again when `package-lock.json` changes |
|
||||
| `make run-frontend-development` | Stops the frontend container, then runs `npm run dev`: generates the Panda CSS code and serves the app on <http://localhost:3000> with hot reload, calling the API on <http://localhost:8071>, from [`.env.development`](https://github.com/suitenumerique/meet/blob/main/src/frontend/.env.development) |
|
||||
| `make build-frontend` | Rebuilds the frontend container's image. Run it before `make run` when you go back to the container |
|
||||
|
||||
Every `npm` script runs from `src/frontend`. The `make` targets call the main ones; the others are:
|
||||
|
||||
| Command | What it does |
|
||||
|---|---|
|
||||
| `npm run build` | Generates the Panda CSS code, type-checks with `tsc`, then builds into `dist/`. Catches the type errors that fail CI's image build |
|
||||
| `npm run build:debug` | Runs `npm run build` with a bundle size report, written to `rollup-plugin-visualizer/stats.html` |
|
||||
| `npm run preview` | Serves the last `npm run build` output, to check a production bundle |
|
||||
| `npm run lint:fix` | Fixes what ESLint can fix by itself |
|
||||
| `npm run check` | Checks the formatting without changing anything, as CI does: any file Prettier would change fails |
|
||||
|
||||
## Tests
|
||||
|
||||
| Command | What it does |
|
||||
|---|---|
|
||||
| `make test` | Runs the backend suite in parallel, then the summary service and frontend suites, stopping at the first failure. `ARGS` passes pytest arguments to the first two, as in `make test ARGS="-x"` |
|
||||
| `make test-back` | Runs the backend suite on one process. `make test-back ARGS="core/tests/rooms/"` limits it to a directory |
|
||||
| `make test-back-parallel` | Runs the backend suite on every CPU core, through pytest-xdist |
|
||||
| `make test-summary` | Runs the summary service suite |
|
||||
| `make test-frontend` | Runs `npm test` in `src/frontend`: generates the Panda CSS code, then runs Vitest once. Needs `make frontend-development-install` first |
|
||||
| `bin/pytest <arguments>` | Runs pytest in a new `app-dev` container, from any directory. Paths are relative to `src/backend` |
|
||||
| `bin/pytest-summary <arguments>` | Runs pytest in a new summary service container |
|
||||
|
||||
Examples of `bin/pytest`:
|
||||
|
||||
```bash
|
||||
# One file
|
||||
bin/pytest core/tests/rooms/test_api_rooms_list.py
|
||||
# One test
|
||||
bin/pytest core/tests/rooms/test_api_rooms_list.py::test_api_rooms_list_authenticated
|
||||
# Coverage, written as HTML to src/backend/htmlcov/index.html
|
||||
bin/pytest --cov=core --cov-report=html
|
||||
```
|
||||
|
||||
With `export PATH="$PWD/bin:$PATH"` from the repository root, `pytest` and `manage` run these wrappers directly.
|
||||
|
||||
The backend suite needs the `Test` configuration, which `bin/pytest` sets. A bare `docker compose run app-dev pytest` runs under `Development`, where the external API and add-ons tests fail.
|
||||
|
||||
**Backend tests** live in [`src/backend/core/tests/`](https://github.com/suitenumerique/meet/tree/main/src/backend/core/tests):
|
||||
|
||||
- Model tests as `test_models_<area>.py`, API tests as `test_api_<area>_*.py`, in a subdirectory such as `rooms/` or `recording/` where an area has many.
|
||||
- Plain pytest functions, marked `pytest.mark.django_db` when they touch the database, calling the API through DRF's `APIClient`.
|
||||
- Data comes from the factories in [`core/factories.py`](https://github.com/suitenumerique/meet/blob/main/src/backend/core/factories.py).
|
||||
- They use the real test database, and patch only what leaves the backend, such as `core.utils.create_livekit_client` for LiveKit or the S3 client.
|
||||
|
||||
**Frontend tests** sit next to the code they test, as `*.test.ts` files.
|
||||
|
||||
The agents have no test suite. The SDK has none either, and CI builds it instead, see [Lint and format](#lint-and-format).
|
||||
|
||||
## Lint and format
|
||||
|
||||
The `make` targets fix what they can in place. CI only checks, so run them before pushing and commit what they change.
|
||||
|
||||
| Command | What it does |
|
||||
|---|---|
|
||||
| `make lint` | Runs `make lint-back`, `make lint-agents` and `make lint-summary` |
|
||||
| `make lint-back` | Runs `ruff format`, `ruff check --fix`, then `pylint` on the `meet`, `demo` and `core` packages, in a backend container started without its services |
|
||||
| `make lint-agents`, `make lint-summary` | Runs `ruff format` and `ruff check --fix` on the agents or on the summary service |
|
||||
| `make lint-ruff-format`, `make lint-ruff-check`, `make lint-pylint` | Runs one backend step alone. `make lint-pylint` checks all of `meet`, `demo` and `core`, despite its help text saying only files changed from `main` |
|
||||
| `make frontend-lint` | Runs ESLint on the frontend, where any warning fails |
|
||||
| `make frontend-format` | Runs Prettier on `src/frontend/src`, rewriting the files |
|
||||
| `cd src/sdk/library && npm ci && npm run lint && npm run check && npm run build` | Lints, checks the formatting of, and builds the SDK, as CI does. Run it when you touch [`src/sdk`](https://github.com/suitenumerique/meet/tree/main/src/sdk) |
|
||||
|
||||
CI also checks commit messages, spelling and shell scripts: [What CI checks](https://github.com/suitenumerique/meet/blob/main/CONTRIBUTING.md#what-ci-checks) gives the local command for each.
|
||||
|
||||
## Translations
|
||||
|
||||
The interface ships in English, French, German, Dutch and Spanish, and every string is translated in the pull request that adds it.
|
||||
|
||||
**Frontend.** A component reads its strings through `t()` from `react-i18next`, by key, from a namespace file in [`src/frontend/src/locales/<language>/`](https://github.com/suitenumerique/meet/tree/main/src/frontend/src/locales). [`HandToggle.tsx`](https://github.com/suitenumerique/meet/blob/main/src/frontend/src/features/rooms/livekit/components/controls/HandToggle.tsx) reads `controls.hand.raise` or `controls.hand.lower` from `rooms.json`:
|
||||
|
||||
```tsx
|
||||
const { t } = useTranslation('rooms', { keyPrefix: 'controls.hand' })
|
||||
// ...
|
||||
const tooltipLabel = isHandRaised ? 'lower' : 'raise'
|
||||
// ...
|
||||
aria-label={t(tooltipLabel)} // controls.hand.raise or controls.hand.lower
|
||||
```
|
||||
|
||||
| Command | What it does |
|
||||
|---|---|
|
||||
| `make frontend-i18n-extract` | Runs `npm run i18n:extract`: adds each new `t()` key, empty, in all five languages, removes unused keys and sorts the files. Fill every empty value before pushing: it shows as blank text, not a fallback |
|
||||
|
||||
**Backend.** Emails and API messages use Django's gettext, with one catalog per language in [`src/backend/locale/`](https://github.com/suitenumerique/meet/tree/main/src/backend/locale).
|
||||
|
||||
| Command | What it does |
|
||||
|---|---|
|
||||
| `make back-i18n-generate` | Runs `makemessages` for every language, which adds new strings to each `django.po` file. Translate them there |
|
||||
| `make back-i18n-compile` | Compiles the `.po` files into the `.mo` files Django reads. `make bootstrap` runs it; run it again to see your translations |
|
||||
|
||||
The `crowdin-*`, `i18n-generate-and-upload` and `i18n-download-and-compile` targets sync the catalogs with Crowdin. They are for maintainers, and need a Crowdin token in `env.d/development/crowdin`.
|
||||
|
||||
## Email templates
|
||||
|
||||
The emails are written in MJML in [`src/mail/mjml/`](https://github.com/suitenumerique/meet/tree/main/src/mail/mjml) and compiled into the templates the backend sends.
|
||||
|
||||
| Command | What it does |
|
||||
|---|---|
|
||||
| `make mails-install` | Installs the generator's npm dependencies, in a Node container. `make bootstrap` runs it |
|
||||
| `make mails-build` | Compiles every `.mjml` file into HTML and plain text under `src/backend/core/templates/mail/`. Run it after editing a template; Mailcatcher shows the result |
|
||||
|
||||
## Add a dependency
|
||||
|
||||
Every dependency is pinned to an exact version. CI installs from the lock files, with `uv sync --locked` and `npm ci`, so a manifest edited without its lock file fails.
|
||||
|
||||
| Command | What it does |
|
||||
|---|---|
|
||||
| `cd src/backend && uv add "<package>==<version>"` | Adds a backend dependency to `pyproject.toml` and `uv.lock`. Add `--dev` for a tool only tests or linters use |
|
||||
| `make build-backend` | Rebuilds the backend image with the new dependency. `uv` exists only during the build, so it cannot install into a running container |
|
||||
| `DOCKER_USER=$(id -u):$(id -g) docker compose up -d --force-recreate --renew-anon-volumes app-dev celery-dev` | Restarts the backend on the new image. `--renew-anon-volumes` replaces the old container's virtual environment volume, which a plain restart keeps |
|
||||
| `cd src/agents && uv add "<package>==<version>"`, then `make build-agents` | The same for the agents. `make build-agents` rebuilds the subtitles agent; rebuild the metadata collector with `docker compose build metadata-collector-dev` |
|
||||
| `cd src/summary && uv add "<package>==<version>"`, then `docker compose build app-summary-dev celery-summary-transcribe celery-summary-summarize` | The same for the summary service, whose three containers each build their own image |
|
||||
| `cd src/frontend && npm install --save-exact <package>@<version>` | Adds a frontend dependency to `package.json` and `package-lock.json`. Run `make build-frontend` if you use the frontend container |
|
||||
|
||||
## Nix with devenv
|
||||
|
||||
On a Nix workstation, [`devenv.nix`](https://github.com/suitenumerique/meet/blob/main/devenv.nix) provides the tools of [Prerequisites](#prerequisites) instead:
|
||||
|
||||
| Command | What it does |
|
||||
|---|---|
|
||||
| `devenv shell` | Opens a shell with Python 3.13, Node.js 22, uv, gettext, the PostgreSQL client, the Docker and Podman clients, and installs gitlint as a commit-message hook. It points `docker` at the Podman socket: set `MEET_PODMAN_SOCKET=0` before entering to keep Docker |
|
||||
| `devenv --profile agents shell` | Adds what the LiveKit agents need, including the LiveKit CLI. The `summary` profile adds Redis, and `k8s` adds the tools listed under [Kubernetes with Tilt](#kubernetes-with-tilt) |
|
||||
| `meet-venv` | Inside the shell, creates or refreshes the virtual environments of `src/backend`, `src/agents` and `src/summary` |
|
||||
|
||||
## Kubernetes with Tilt
|
||||
|
||||
[Tilt](https://tilt.dev/) runs Meet in a local Kubernetes cluster with the [Helm chart](https://github.com/suitenumerique/meet/tree/main/src/helm) and copies your edits into the running pods. Use it only when a change touches the chart or depends on Kubernetes.
|
||||
|
||||
Besides Docker, it needs:
|
||||
|
||||
| Tool | What it is for |
|
||||
|---|---|
|
||||
| [kind](https://kind.sigs.k8s.io/) | The local cluster |
|
||||
| [kubectl](https://kubernetes.io/docs/tasks/tools/) | Talking to the cluster |
|
||||
| [Helm](https://helm.sh/) and [helmfile](https://helmfile.readthedocs.io/) | Rendering the chart and its development services from [`src/helm/helmfile.yaml.gotmpl`](https://github.com/suitenumerique/meet/blob/main/src/helm/helmfile.yaml.gotmpl) |
|
||||
| [Tilt](https://docs.tilt.dev/install.html) | Building the images, deploying them and syncing your edits |
|
||||
| [mkcert](https://github.com/FiloSottile/mkcert) | The local certificate authority behind the cluster's HTTPS |
|
||||
|
||||
| Command | What it does |
|
||||
|---|---|
|
||||
| [`./bin/start-kind.sh`](https://github.com/suitenumerique/meet/blob/main/bin/start-kind.sh) | Run it once. It creates a kind cluster `suite` serving `*.127.0.0.1.nip.io` over HTTPS, with a mkcert certificate authority and an image registry on `localhost:5001`. It pipes [`create_cluster.sh`](https://github.com/numerique-gouv/tools/blob/main/kind/create_cluster.sh) from `numerique-gouv/tools` to `bash`: read that script first |
|
||||
| `make build-k8s-cluster` | Copies `env.d/development/kube-secret.dist` if needed. It does not create the cluster |
|
||||
| `make start-tilt-keycloak` | Runs `tilt up` with [`bin/Tiltfile`](https://github.com/suitenumerique/meet/blob/main/bin/Tiltfile) in the `meet` namespace, with a Keycloak in the cluster. Builds the backend, frontend, summary, agents and LiveKit images, deploys the chart, applies the migrations and creates the Django admin once |
|
||||
| `make start-tilt-dinum` | The same, with the DINUM-styled frontend from [`docker/dinum-frontend`](https://github.com/suitenumerique/meet/tree/main/docker/dinum-frontend) |
|
||||
| `tilt down --namespace=meet -f ./bin/Tiltfile` | Deletes what Tilt deployed. Stopping `tilt up` with Ctrl+C leaves the deployment running |
|
||||
| `kind delete cluster --name suite` | Deletes the cluster |
|
||||
|
||||
Tilt's dashboard is at <http://localhost:10350/> and Meet at <https://meet.127.0.0.1.nip.io/>. On the `meet-backend` resource, the **Run makemigration** and **Run database migration** buttons run those commands in the backend pod.
|
||||
|
||||
## Work on this documentation site
|
||||
|
||||
[Zensical](https://zensical.org/) builds this site from the Markdown in [`docs/`](https://github.com/suitenumerique/meet/tree/main/docs), with its name and navigation in [`zensical.toml`](https://github.com/suitenumerique/meet/blob/main/zensical.toml). It needs only Docker; run each command from the repository root.
|
||||
|
||||
| Command | What it does |
|
||||
|---|---|
|
||||
| `docker run --rm -it -p 8000:8000 -v "$PWD":/docs zensical/zensical` | Serves the site on <http://localhost:8000> and rebuilds a page when you save its file |
|
||||
| `docker run --rm -v "$PWD":/docs zensical/zensical build` | Builds the static site into `site/`, which Git ignores |
|
||||
| `docker pull zensical/zensical` | Updates the Zensical image |
|
||||
|
||||
The home page is `docs/index.md`. Do not add a `docs/README.md`: Zensical would build it into the same `index.html`.
|
||||
|
||||
A page follows these rules:
|
||||
|
||||
- **One fact lives in one place.** Every other page links to it rather than repeating it.
|
||||
- **Environment variables are documented only in [Environment variables](../reference/env-variables.md).** Another page names the variable and links its row.
|
||||
- **Problems and their fixes go only in [Troubleshooting](../reference/troubleshooting.md).**
|
||||
- **Source files are linked on GitHub, not described line by line.** Link `https://github.com/suitenumerique/meet/blob/main/<path>`: a relative link to a file outside `docs/` works in the editor but is dead on the built site.
|
||||
- **Every screenshot is a figure with a caption:**
|
||||
|
||||
```html
|
||||
<figure markdown="span">
|
||||

|
||||
<figcaption>Participants panel, a menu per name</figcaption>
|
||||
</figure>
|
||||
```
|
||||
|
||||
Two screenshots side by side go in one `<div class="figure-row" markdown>`. Images live in [`docs/assets/`](https://github.com/suitenumerique/meet/tree/main/docs/assets).
|
||||
- **An icon inside a sentence or a table has `class="off-glb"`**, which keeps it out of the lightbox that opens screenshots full size: `<img class="off-glb" src="../assets/icons/mic-line.svg" width="20" />`.
|
||||
- **A new page is added to `nav` in `zensical.toml`**, or it builds without appearing in the navigation.
|
||||
|
||||
CI's spelling and shellcheck jobs cover `docs/` too, see [What CI checks](https://github.com/suitenumerique/meet/blob/main/CONTRIBUTING.md#what-ci-checks).
|
||||
@@ -0,0 +1,176 @@
|
||||
# Getting Started
|
||||
|
||||
Before setting up, let's review Visio's architecture.
|
||||
|
||||
Visio consists of four main components that run simultaneously:
|
||||
|
||||
- React frontend, built with Vite.js
|
||||
- Django server
|
||||
- LiveKit server
|
||||
- FastAPI server (optional, required for AI beta features)
|
||||
|
||||
These components rely on a few key services:
|
||||
|
||||
- PostgreSQL for storing data (users, rooms, recordings)
|
||||
- Redis for caching and inter-service communication
|
||||
- Garage for storing files (room recordings)
|
||||
- Celery workers for meeting transcript (optional, required for AI beta features)
|
||||
|
||||
We provide two stack options for getting Visio up and running for development:
|
||||
|
||||
- Docker Compose stack (recommended for most users)
|
||||
- Kubernetes stack powered by Tilt (Advanced)
|
||||
|
||||
We recommend starting with the **Docker Compose** option for simplicity. However, if you're comfortable with running Kubernetes locally, the advanced option mirrors the production environment and provides most of the tools required for development (e.g., hot reloading).
|
||||
|
||||
These instructions are for macOS or Ubuntu. For other distros, adjust as needed.
|
||||
|
||||
If any steps are outdated, please let us know!
|
||||
|
||||
---
|
||||
|
||||
We also provide **GNU make utilities**. To view all available Make rules, run:
|
||||
```shellscript
|
||||
$ make help
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Need Help?
|
||||
If you need any assistance or have questions while getting started, feel free to reach out to @lebaudantoine anytime! Antoine is available to help you onboard and guide you through the process. Chat with him @antoine.lebaud:matrix.org, or by email at [support-visio@numerique.gouv.fr](mailto:support-visio@numerique.gouv.fr).
|
||||
|
||||
---
|
||||
|
||||
## Option 1: Developing with Docker
|
||||
|
||||
### Prerequisites
|
||||
|
||||
1. Ensure you have a recent version of **Docker** and **Docker Compose** installed:
|
||||
```shellscript
|
||||
$ docker -v
|
||||
Docker version 20.10.2, build 2291f61
|
||||
|
||||
$ docker compose version
|
||||
Docker Compose version v2.32.4
|
||||
```
|
||||
|
||||
2. Install **LiveKit CLI** by following the instructions available in the [official repository](https://github.com/livekit/livekit-cli). After installation, verify that it's working:
|
||||
```shellscript
|
||||
$ lk --version
|
||||
lk version 2.3.1
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Project Bootstrap
|
||||
|
||||
1. Bootstrap the project using the **Make** command. This will build the `app` container, install dependencies, run database migrations, and compile translations:
|
||||
```shellscript
|
||||
$ make bootstrap FLUSH_ARGS='--no-input'
|
||||
```
|
||||
|
||||
2. Access the project:
|
||||
- The frontend is available at [http://localhost:3000](http://localhost:3000) with the default credentials:
|
||||
- username: meet
|
||||
- password: meet
|
||||
- The Django backend is available at [http://localhost:8071](http://localhost:8071)
|
||||
|
||||
---
|
||||
|
||||
## Developing
|
||||
|
||||
- To **stop** the application:
|
||||
```shellscript
|
||||
$ make stop
|
||||
```
|
||||
|
||||
- To **restart** the application:
|
||||
```shellscript
|
||||
$ make run
|
||||
```
|
||||
|
||||
- For **frontend development**, start all backend services without the frontend container:
|
||||
```shellscript
|
||||
$ make run-backend
|
||||
```
|
||||
|
||||
Then:
|
||||
```shellscript
|
||||
$ make frontend-development-install
|
||||
$ make run-frontend-development
|
||||
```
|
||||
|
||||
Which is equivalent to these direct npm commands:
|
||||
```shellscript
|
||||
$ cd src/frontend
|
||||
$ npm i
|
||||
$ npm run dev
|
||||
```
|
||||
|
||||
### LiveKit agents (optional)
|
||||
|
||||
The LiveKit agents are not started by `make run`. Each one runs its own
|
||||
container and stays connected to LiveKit, which costs CPU and memory you
|
||||
don't need unless you work on the features they power. Start them only
|
||||
when you need them.
|
||||
|
||||
| Agent | Feature | Make command | Setting in `env.d/development/common` |
|
||||
|---|---|---|---|
|
||||
| `metadata-collector-dev` | Recording metadata (used to identify speakers in transcripts) | `make run-agent-metadata-collector` | `METADATA_COLLECTOR_ENABLED=True` |
|
||||
| `multi-user-transcriber-dev` | Live subtitles | `make run-agent-multi-user-transcriber` | `ROOM_SUBTITLE_ENABLED=True` |
|
||||
|
||||
To start both at once:
|
||||
```shellscript
|
||||
$ make run-agents
|
||||
```
|
||||
|
||||
Then set the matching settings to `True` and restart the backend so it
|
||||
picks them up:
|
||||
```shellscript
|
||||
$ make run-backend
|
||||
```
|
||||
|
||||
The multi-user transcriber also needs a speech-to-text provider. Configure
|
||||
`STT_PROVIDER` and its credentials in
|
||||
`env.d/development/multi_user_transcriber`.
|
||||
|
||||
Keep the settings and the agents in sync: if a setting is `True` while its
|
||||
agent is stopped, the backend still dispatches jobs to it and the feature
|
||||
fails silently.
|
||||
|
||||
---
|
||||
|
||||
## Adding Content
|
||||
|
||||
You can bootstrap demo data with a single command:
|
||||
```shellscript
|
||||
$ make demo
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Option 2: Developing with Kubernetes
|
||||
|
||||
Visio is deployed across staging, preprod, and production environments using **Kubernetes (K8s)**. Reproducing the environment locally is crucial for developing new features or debugging.
|
||||
|
||||
This is facilitated by [Tilt](https://tilt.dev/), which provides Kubernetes-like development for local environments, enabling smart rebuilds and live updates.
|
||||
|
||||
### Getting Started
|
||||
|
||||
Make sure you have the following installed:
|
||||
- kubectl
|
||||
- helm
|
||||
- helmfile
|
||||
- tilt
|
||||
|
||||
To build and start the Kubernetes cluster using **Kind**:
|
||||
```shellscript
|
||||
$ make build-k8s-cluster
|
||||
```
|
||||
|
||||
Once the Kubernetes cluster is ready, start the application stack locally:
|
||||
```shellscript
|
||||
$ make start-tilt-keycloak
|
||||
```
|
||||
|
||||
Monitor Tilt’s progress at [http://localhost:10350/](http://localhost:10350/). After Tilt actions finish, you can access the app at [https://meet.127.0.0.1.nip.io/](https://meet.127.0.0.1.nip.io/).
|
||||
@@ -0,0 +1,89 @@
|
||||
services:
|
||||
postgresql:
|
||||
image: postgres:16
|
||||
healthcheck:
|
||||
test: ["CMD-SHELL", "pg_isready -d $${POSTGRES_DB} -U $${POSTGRES_USER}"]
|
||||
interval: 1s
|
||||
timeout: 2s
|
||||
retries: 300
|
||||
env_file:
|
||||
- env.d/postgresql
|
||||
- env.d/common
|
||||
volumes:
|
||||
- ./data/databases/backend:/var/lib/postgresql/data
|
||||
|
||||
redis:
|
||||
image: redis:5
|
||||
|
||||
backend:
|
||||
image: lasuite/meet-backend:latest
|
||||
user: ${DOCKER_USER:-1000}
|
||||
restart: always
|
||||
env_file:
|
||||
- .env
|
||||
- env.d/common
|
||||
- env.d/postgresql
|
||||
healthcheck:
|
||||
test: ["CMD", "python", "manage.py", "check"]
|
||||
interval: 15s
|
||||
timeout: 30s
|
||||
retries: 20
|
||||
start_period: 10s
|
||||
depends_on:
|
||||
postgresql:
|
||||
condition: service_healthy
|
||||
restart: true
|
||||
redis:
|
||||
condition: service_started
|
||||
livekit:
|
||||
condition: service_started
|
||||
|
||||
frontend:
|
||||
image: lasuite/meet-frontend:latest
|
||||
user: "${DOCKER_USER:-1000}"
|
||||
entrypoint:
|
||||
- /docker-entrypoint.sh
|
||||
command: ["nginx", "-g", "daemon off;"]
|
||||
env_file:
|
||||
- .env
|
||||
- env.d/common
|
||||
# Uncomment and set your values if using our nginx proxy example
|
||||
# environment:
|
||||
# - VIRTUAL_HOST=${MEET_HOST} # used by nginx proxy
|
||||
# - VIRTUAL_PORT=8083 # used by nginx proxy
|
||||
# - LETSENCRYPT_HOST=${MEET_HOST} # used by lets encrypt to generate TLS certificate
|
||||
depends_on:
|
||||
backend:
|
||||
condition: service_healthy
|
||||
volumes:
|
||||
- ./default.conf.template:/etc/nginx/templates/docs.conf.template
|
||||
# Uncomment if using our nginx proxy example
|
||||
# networks:
|
||||
# - proxy-tier
|
||||
# - default
|
||||
|
||||
livekit:
|
||||
image: livekit/livekit-server:latest
|
||||
command: --config /config.yaml
|
||||
ports:
|
||||
- 7881:7881/tcp
|
||||
- 7882:7882/udp
|
||||
volumes:
|
||||
- ./livekit-server.yaml:/config.yaml
|
||||
# Uncomment and set your values if using our nginx proxy example
|
||||
# environment:
|
||||
# - VIRTUAL_HOST=${LIVEKIT_HOST} # used by nginx proxy
|
||||
# - VIRTUAL_PORT=7880 # used by nginx proxy
|
||||
# - LETSENCRYPT_HOST=${LIVEKIT_HOST} # used by lets encrypt to generate TLS certificate
|
||||
depends_on:
|
||||
redis:
|
||||
condition: service_started
|
||||
# Uncomment if using our nginx proxy example
|
||||
# networks:
|
||||
# - proxy-tier
|
||||
# - default
|
||||
|
||||
# Uncomment if using our nginx proxy example
|
||||
#networks:
|
||||
# proxy-tier:
|
||||
# external: true
|
||||
@@ -0,0 +1,91 @@
|
||||
# Deploy and Configure Keycloak for Meet
|
||||
|
||||
## Installation
|
||||
|
||||
> [!CAUTION]
|
||||
> We provide those instructions as an example, for production environments, you should follow the [official documentation](https://www.keycloak.org/documentation).
|
||||
|
||||
### Step 1: Prepare your working environment:
|
||||
|
||||
```bash
|
||||
mkdir -p keycloak/env.d && cd keycloak
|
||||
curl -o compose.yaml https://raw.githubusercontent.com/suitenumerique/meet/refs/heads/main/docs/examples/compose/keycloak/compose.yaml
|
||||
curl -o env.d/kc_postgresql https://raw.githubusercontent.com/suitenumerique/meet/refs/heads/main/env.d/production.dist/kc_postgresql
|
||||
curl -o env.d/keycloak https://raw.githubusercontent.com/suitenumerique/meet/refs/heads/main/env.d/production.dist/keycloak
|
||||
```
|
||||
|
||||
### Step 2:. Update `env.d/` files
|
||||
|
||||
The following variables need to be updated with your own values, others can be left as is:
|
||||
|
||||
```env
|
||||
POSTGRES_PASSWORD=<generate postgres password>
|
||||
KC_HOSTNAME=https://id.yourdomain.tld # Change with your own URL
|
||||
KC_BOOTSTRAP_ADMIN_PASSWORD=<generate your password>
|
||||
```
|
||||
|
||||
### Step 3: Expose keycloak instance on https
|
||||
|
||||
> [!NOTE]
|
||||
> You can skip this section if you already have your own setup.
|
||||
|
||||
To access your Keycloak instance on the public network, it needs to be exposed on a domain with SSL termination. You can use our [example with nginx proxy and Let's Encrypt companion](../nginx-proxy/README.md) for automated creation/renewal of certificates using [acme.sh](http://acme.sh).
|
||||
|
||||
If following our example, uncomment the environment and network sections in compose file and update it with your values.
|
||||
|
||||
```yaml
|
||||
version: '3'
|
||||
services:
|
||||
keycloak:
|
||||
...
|
||||
# Uncomment and set your values if using our nginx proxy example
|
||||
# environment:
|
||||
# - VIRTUAL_HOST=id.yourdomain.tld # used by nginx proxy
|
||||
# - VIRTUAL_PORT=8080 # used by nginx proxy
|
||||
# - LETSENCRYPT_HOST=id.yourdomain.tld # used by lets encrypt to generate TLS certificate
|
||||
...
|
||||
# Uncomment if using our nginx proxy example
|
||||
# networks:
|
||||
# - proxy-tier
|
||||
# - default
|
||||
|
||||
# Uncomment if using our nginx proxy example
|
||||
#networks:
|
||||
# proxy-tier:
|
||||
# external: true
|
||||
```
|
||||
|
||||
### Step 4: Start the service
|
||||
|
||||
```bash
|
||||
`docker compose up -d`
|
||||
```
|
||||
|
||||
Your keycloak instance is now available on https://id.yourdomain.tld
|
||||
|
||||
> [!CAUTION]
|
||||
> Version of the images are set to latest, you should pin it to the desired version to avoid unwanted upgrades when pulling latest image. You can find available versions on [Keycloak registry](https://quay.io/repository/keycloak/keycloak?tab=tags).
|
||||
|
||||
## Creating an OIDC Client for Meet Application
|
||||
|
||||
### Step 1: Create a New Realm
|
||||
|
||||
1. Log in to the Keycloak administration console.
|
||||
2. Navigate to the realm tab and click on the "Create realm" button.
|
||||
3. Enter the name of the realm - `meet`.
|
||||
4. Click "Create".
|
||||
|
||||
### Step 2: Create a New Client
|
||||
|
||||
1. Navigate to the "Clients" tab.
|
||||
2. Click on the "Create client" button.
|
||||
3. Enter the client ID - e.g. `meet`.
|
||||
4. Enable "Client authentication" option.
|
||||
6. Set the "Valid redirect URIs" to the URL of your meet application suffixed with `/*` - e.g., "https://meet.example.com/*".
|
||||
1. Set the "Web Origins" to the URL of your meet application - e.g. `https://meet.example.com`.
|
||||
1. Click "Save".
|
||||
|
||||
### Step 3: Get Client Credentials
|
||||
|
||||
1. Go to the "Credentials" tab.
|
||||
2. Copy the client ID (`meet` in this example) and the client secret.
|
||||
@@ -0,0 +1,36 @@
|
||||
services:
|
||||
postgresql:
|
||||
image: postgres:16
|
||||
healthcheck:
|
||||
test: ["CMD-SHELL", "pg_isready -d $${POSTGRES_DB} -U $${POSTGRES_USER}"]
|
||||
interval: 1s
|
||||
timeout: 2s
|
||||
retries: 300
|
||||
env_file:
|
||||
- env.d/kc_postgresql
|
||||
volumes:
|
||||
- ./data/keycloak:/var/lib/postgresql/data/pgdata
|
||||
|
||||
keycloak:
|
||||
image: quay.io/keycloak/keycloak:latest
|
||||
command: ["start"]
|
||||
env_file:
|
||||
- env.d/kc_postgresql
|
||||
- env.d/keycloak
|
||||
# Uncomment and set your values if using our nginx proxy example
|
||||
# environment:
|
||||
# - VIRTUAL_HOST=id.yourdomain.tld # used by nginx proxy
|
||||
# - VIRTUAL_PORT=8080 # used by nginx proxy
|
||||
# - LETSENCRYPT_HOST=id.yourdomain.tld # used by lets encrypt to generate TLS certificate
|
||||
depends_on:
|
||||
postgresql:
|
||||
condition: service_healthy
|
||||
restart: true
|
||||
# Uncomment if using our nginx proxy example
|
||||
# networks:
|
||||
# - proxy-tier
|
||||
# - default
|
||||
#
|
||||
#networks:
|
||||
# proxy-tier:
|
||||
# external: true
|
||||
@@ -0,0 +1,39 @@
|
||||
# Nginx proxy with automatic SSL certificates
|
||||
|
||||
> [!CAUTION]
|
||||
> We provide those instructions as an example, for extended development or production environments, you should follow the [official documentation](https://github.com/nginx-proxy/acme-companion/tree/main/docs).
|
||||
|
||||
Nginx-proxy sets up a container running nginx and docker-gen. docker-gen generates reverse proxy configs for nginx and reloads nginx when containers are started and stopped.
|
||||
|
||||
Acme-companion is a lightweight companion container for nginx-proxy. It handles the automated creation, renewal and use of SSL certificates for proxied Docker containers through the ACME protocol.
|
||||
|
||||
## Installation
|
||||
|
||||
### Step 1: Prepare your working environment:
|
||||
|
||||
```bash
|
||||
mkdir nginx-proxy && cd nginx-proxy
|
||||
curl -o compose.yaml https://raw.githubusercontent.com/suitenumerique/meet/refs/heads/main/docs/examples/compose/nginx-proxy/compose.yaml
|
||||
```
|
||||
|
||||
### Step 2: Edit `DEFAULT_EMAIL` in the compose file.
|
||||
|
||||
Albeit optional, it is recommended to provide a valid default email address through the `DEFAULT_EMAIL` environment variable, so that Let's Encrypt can warn you about expiring certificates and allow you to recover your account.
|
||||
|
||||
### Step 3: Create docker network
|
||||
|
||||
Containers need share the same network for auto-discovery.
|
||||
|
||||
```bash
|
||||
docker network create proxy-tier
|
||||
```
|
||||
|
||||
### Step 4: Start service
|
||||
|
||||
```bash
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
Once both nginx-proxy and acme-companion containers are up and running, start any container you want proxied with environment variables `VIRTUAL_HOST` and `LETSENCRYPT_HOST` both set to the domain(s) your proxied container is going to use.
|
||||
@@ -0,0 +1,36 @@
|
||||
services:
|
||||
nginx-proxy:
|
||||
image: nginxproxy/nginx-proxy
|
||||
container_name: nginx-proxy
|
||||
ports:
|
||||
- "80:80"
|
||||
- "443:443"
|
||||
volumes:
|
||||
- html:/usr/share/nginx/html
|
||||
- certs:/etc/nginx/certs:ro
|
||||
- /var/run/docker.sock:/tmp/docker.sock:ro
|
||||
networks:
|
||||
- proxy-tier
|
||||
|
||||
acme-companion:
|
||||
image: nginxproxy/acme-companion
|
||||
container_name: nginx-proxy-acme
|
||||
environment:
|
||||
- DEFAULT_EMAIL=mail@yourdomain.tld
|
||||
volumes_from:
|
||||
- nginx-proxy
|
||||
volumes:
|
||||
- certs:/etc/nginx/certs:rw
|
||||
- acme:/etc/acme.sh
|
||||
- /var/run/docker.sock:/var/run/docker.sock:ro
|
||||
networks:
|
||||
- proxy-tier
|
||||
|
||||
networks:
|
||||
proxy-tier:
|
||||
external: true
|
||||
|
||||
volumes:
|
||||
html:
|
||||
certs:
|
||||
acme:
|
||||
@@ -1,14 +0,0 @@
|
||||
# Secret Garage nodes share to talk to each other. A single node still needs
|
||||
# one: generate it with `openssl rand -hex 32`.
|
||||
GARAGE_RPC_SECRET=<generate a secret>
|
||||
|
||||
# The key Garage creates on its first start. The Meet backend uses this pair as
|
||||
# AWS_S3_ACCESS_KEY_ID and AWS_S3_SECRET_ACCESS_KEY. Garage refuses to start
|
||||
# with an access key shorter than 8 characters or a secret key shorter than 16:
|
||||
# `openssl rand -hex 12` and `openssl rand -hex 32` give 24 and 64.
|
||||
GARAGE_ACCESS_KEY=<generate an access key>
|
||||
GARAGE_SECRET_KEY=<generate a secret key>
|
||||
|
||||
# Name of the Meet stack's internal network: <meet project name>_internal.
|
||||
# The default fits a Meet stack started from a directory named "meet".
|
||||
MEET_INTERNAL_NETWORK=meet_internal
|
||||
@@ -1,47 +0,0 @@
|
||||
# Garage stack
|
||||
#
|
||||
# S3-compatible object storage for Meet recording, on a single node.
|
||||
# Only needed if you want meeting recording.
|
||||
# Skip this if you use an external S3-compatible service (AWS S3, Scaleway, OVH, etc.)
|
||||
#
|
||||
# Usage:
|
||||
# cd ~/docker/garage
|
||||
# # fetch garage.toml and .env, then fill its secrets, as the Recording guide's Step 1 shows
|
||||
# docker compose up -d
|
||||
#
|
||||
# On its first start, Garage creates its layout, the access key named in .env
|
||||
# and the meet-media-storage bucket. It leaves them untouched on later starts.
|
||||
#
|
||||
# External network expected:
|
||||
# meet_internal - the Meet stack's internal network; set MEET_INTERNAL_NETWORK
|
||||
# in .env if yours has another name
|
||||
|
||||
services:
|
||||
|
||||
garage:
|
||||
image: dxflrs/garage:v2.4.1
|
||||
restart: unless-stopped
|
||||
command: /garage server --single-node --default-bucket
|
||||
environment:
|
||||
GARAGE_RPC_SECRET: ${GARAGE_RPC_SECRET}
|
||||
GARAGE_DEFAULT_ACCESS_KEY: ${GARAGE_ACCESS_KEY}
|
||||
GARAGE_DEFAULT_SECRET_KEY: ${GARAGE_SECRET_KEY}
|
||||
GARAGE_DEFAULT_BUCKET: meet-media-storage
|
||||
healthcheck:
|
||||
test: ["CMD", "/garage", "health"]
|
||||
interval: 5s
|
||||
timeout: 5s
|
||||
retries: 10
|
||||
volumes:
|
||||
- ./garage.toml:/etc/garage.toml:ro
|
||||
- garage_data:/var/lib/garage
|
||||
networks:
|
||||
- meet_internal # must match the 'internal' network name of your Meet stack
|
||||
|
||||
volumes:
|
||||
garage_data:
|
||||
|
||||
networks:
|
||||
meet_internal:
|
||||
external: true
|
||||
name: ${MEET_INTERNAL_NETWORK:-meet_internal}
|
||||
@@ -1,15 +0,0 @@
|
||||
# Garage configuration for a single node, with no replication.
|
||||
# See https://garagehq.deuxfleurs.fr/documentation/reference-manual/configuration/
|
||||
metadata_dir = "/var/lib/garage/meta"
|
||||
data_dir = "/var/lib/garage/data"
|
||||
db_engine = "lmdb"
|
||||
|
||||
replication_factor = 1
|
||||
|
||||
rpc_bind_addr = "127.0.0.1:3901"
|
||||
rpc_public_addr = "127.0.0.1:3901"
|
||||
|
||||
[s3_api]
|
||||
api_bind_addr = "[::]:9000"
|
||||
# The region this storage declares. Meet's AWS_S3_REGION_NAME names it.
|
||||
s3_region = "garage"
|
||||
@@ -0,0 +1,40 @@
|
||||
replicaCount: 1
|
||||
terminationGracePeriodSeconds: 18000
|
||||
|
||||
livekit:
|
||||
keys:
|
||||
devkey: secret
|
||||
log_level: debug
|
||||
rtc:
|
||||
use_external_ip: false
|
||||
port_range_start: 50000
|
||||
port_range_end: 60000
|
||||
tcp_port: 7881
|
||||
redis:
|
||||
address: redis-master:6379
|
||||
password: pass
|
||||
turn:
|
||||
enabled: true
|
||||
udp_port: 443
|
||||
domain: livekit.127.0.0.1.nip.io
|
||||
loadBalancerAnnotations: {}
|
||||
|
||||
|
||||
loadBalancer:
|
||||
type: nginx
|
||||
annotations:
|
||||
nginx.ingress.kubernetes.io/rewrite-target: /
|
||||
nginx.ingress.kubernetes.io/ssl-redirect: "true"
|
||||
tls:
|
||||
- hosts:
|
||||
- livekit.127.0.0.1.nip.io
|
||||
secretName: livekit-dinum-cert
|
||||
|
||||
autoscaling:
|
||||
enabled: false
|
||||
minReplicas: 1
|
||||
maxReplicas: 5
|
||||
targetCPUUtilizationPercentage: 60
|
||||
|
||||
nodeSelector: {}
|
||||
resources: {}
|
||||
@@ -0,0 +1,117 @@
|
||||
image:
|
||||
repository: lasuite/meet-backend
|
||||
pullPolicy: Always
|
||||
tag: "latest"
|
||||
|
||||
backend:
|
||||
replicas: 1
|
||||
envVars:
|
||||
DJANGO_CSRF_TRUSTED_ORIGINS: https://meet.127.0.0.1.nip.io,http://meet.127.0.0.1.nip.io
|
||||
DJANGO_CONFIGURATION: Production
|
||||
DJANGO_ALLOWED_HOSTS: meet.127.0.0.1.nip.io
|
||||
DJANGO_SECRET_KEY: ThisCouldBeAReallyGoodOrPerhapsABadKeyToUseSometimes
|
||||
DJANGO_SETTINGS_MODULE: meet.settings
|
||||
DJANGO_SILENCED_SYSTEM_CHECKS: security.W004, security.W008
|
||||
DJANGO_SUPERUSER_PASSWORD: admin
|
||||
DJANGO_EMAIL_HOST: "mailcatcher"
|
||||
DJANGO_EMAIL_PORT: 1025
|
||||
DJANGO_EMAIL_USE_SSL: False
|
||||
OIDC_OP_JWKS_ENDPOINT: https://keycloak.127.0.0.1.nip.io/realms/meet/protocol/openid-connect/certs
|
||||
OIDC_OP_AUTHORIZATION_ENDPOINT: https://keycloak.127.0.0.1.nip.io/realms/meet/protocol/openid-connect/auth
|
||||
OIDC_OP_TOKEN_ENDPOINT: https://keycloak.127.0.0.1.nip.io/realms/meet/protocol/openid-connect/token
|
||||
OIDC_OP_USER_ENDPOINT: https://keycloak.127.0.0.1.nip.io/realms/meet/protocol/openid-connect/userinfo
|
||||
OIDC_OP_LOGOUT_ENDPOINT: https://keycloak.127.0.0.1.nip.io/realms/meet/protocol/openid-connect/session/end
|
||||
OIDC_RP_CLIENT_ID: meet
|
||||
OIDC_RP_CLIENT_SECRET: ThisIsAnExampleKeyForDevPurposeOnly
|
||||
OIDC_RP_SIGN_ALGO: RS256
|
||||
OIDC_RP_SCOPES: "openid email"
|
||||
OIDC_REDIRECT_ALLOWED_HOSTS: https://meet.127.0.0.1.nip.io
|
||||
OIDC_AUTH_REQUEST_EXTRA_PARAMS: "{'acr_values': 'eidas1'}"
|
||||
LOGIN_REDIRECT_URL: https://meet.127.0.0.1.nip.io
|
||||
LOGIN_REDIRECT_URL_FAILURE: https://meet.127.0.0.1.nip.io
|
||||
LOGOUT_REDIRECT_URL: https://meet.127.0.0.1.nip.io
|
||||
DB_HOST: postgresql
|
||||
DB_NAME: meet
|
||||
DB_USER: dinum
|
||||
DB_PASSWORD: pass
|
||||
DB_PORT: 5432
|
||||
REDIS_URL: redis://default:pass@redis-master:6379/1
|
||||
STORAGES_STATICFILES_BACKEND: django.contrib.staticfiles.storage.StaticFilesStorage
|
||||
LIVEKIT_API_SECRET: secret
|
||||
LIVEKIT_API_KEY: devkey
|
||||
LIVEKIT_API_URL: https://livekit.127.0.0.1.nip.io/
|
||||
ALLOW_UNREGISTERED_ROOMS: False
|
||||
FRONTEND_SILENCE_LIVEKIT_DEBUG: False
|
||||
|
||||
|
||||
migrate:
|
||||
command:
|
||||
- "/bin/sh"
|
||||
- "-c"
|
||||
- |
|
||||
python manage.py migrate --no-input &&
|
||||
python manage.py create_demo --force
|
||||
restartPolicy: Never
|
||||
|
||||
command:
|
||||
- "gunicorn"
|
||||
- "-c"
|
||||
- "/usr/local/etc/gunicorn/meet.py"
|
||||
- "meet.wsgi:application"
|
||||
- "--reload"
|
||||
|
||||
createsuperuser:
|
||||
command:
|
||||
- "/bin/sh"
|
||||
- "-c"
|
||||
- |
|
||||
python manage.py createsuperuser --email admin@example.com --password admin
|
||||
restartPolicy: Never
|
||||
|
||||
# Extra volume to manage our local custom CA and avoid to set ssl_verify: false
|
||||
extraVolumeMounts:
|
||||
- name: certs
|
||||
mountPath: /app/.venv/lib/python3.13/site-packages/certifi/cacert.pem
|
||||
subPath: cacert.pem
|
||||
|
||||
# Extra volume to manage our local custom CA and avoid to set ssl_verify: false
|
||||
extraVolumes:
|
||||
- name: certs
|
||||
configMap:
|
||||
name: certifi
|
||||
items:
|
||||
- key: cacert.pem
|
||||
path: cacert.pem
|
||||
|
||||
frontend:
|
||||
envVars:
|
||||
VITE_PORT: 8080
|
||||
VITE_HOST: 0.0.0.0
|
||||
VITE_API_BASE_URL: https://meet.127.0.0.1.nip.io/
|
||||
|
||||
replicas: 1
|
||||
|
||||
image:
|
||||
repository: lasuite/meet-frontend
|
||||
pullPolicy: Always
|
||||
tag: "latest"
|
||||
|
||||
ingress:
|
||||
enabled: true
|
||||
host: meet.127.0.0.1.nip.io
|
||||
|
||||
ingressAdmin:
|
||||
enabled: true
|
||||
host: meet.127.0.0.1.nip.io
|
||||
|
||||
posthog:
|
||||
ingress:
|
||||
enabled: false
|
||||
ingressAssets:
|
||||
enabled: false
|
||||
|
||||
summary:
|
||||
replicas: 0
|
||||
|
||||
celery:
|
||||
replicas: 0
|
||||
@@ -0,0 +1,7 @@
|
||||
auth:
|
||||
username: dinum
|
||||
password: pass
|
||||
database: meet
|
||||
tls:
|
||||
enabled: true
|
||||
autoGenerated: true
|
||||
@@ -0,0 +1,3 @@
|
||||
auth:
|
||||
password: pass
|
||||
architecture: standalone
|
||||
@@ -1,66 +0,0 @@
|
||||
# Keycloak stack
|
||||
#
|
||||
# Standalone identity provider for Meet.
|
||||
# Skip this entirely if you already have an OIDC provider (Authentik, Auth0, etc.)
|
||||
#
|
||||
# Usage:
|
||||
# cd ~/docker/keycloak
|
||||
# # download your proxy's override as docker-compose.override.yml, see the Deployment Guide
|
||||
# cp ~/docker/hosts .env
|
||||
# # fill the placeholders of env.d/keycloak, env.d/kc_postgresql and
|
||||
# # keycloak-realm.json, as the Deployment Guide shows
|
||||
# docker compose up -d
|
||||
#
|
||||
# External network expected:
|
||||
# proxy - shared with your reverse proxy
|
||||
|
||||
services:
|
||||
|
||||
keycloak:
|
||||
image: quay.io/keycloak/keycloak:${KEYCLOAK_VERSION:-latest}
|
||||
restart: unless-stopped
|
||||
command:
|
||||
- start
|
||||
- --import-realm
|
||||
env_file:
|
||||
- .env
|
||||
- env.d/kc_postgresql
|
||||
- env.d/keycloak
|
||||
healthcheck:
|
||||
# see https://www.keycloak.org/observability/health#_healthcheck
|
||||
test: ["CMD-SHELL", "{ printf 'HEAD /health/ready HTTP/1.0\\r\\n\\r\\n' >&0; grep 'HTTP/1.0 200'; } 0<>/dev/tcp/localhost/9000"]
|
||||
interval: 10s
|
||||
timeout: 5s
|
||||
retries: 20
|
||||
start_period: 30s
|
||||
volumes:
|
||||
- ./keycloak-realm.json:/opt/keycloak/data/import/realm.json:ro
|
||||
depends_on:
|
||||
postgresql:
|
||||
condition: service_healthy
|
||||
networks:
|
||||
- proxy
|
||||
- internal
|
||||
|
||||
postgresql:
|
||||
image: postgres:16
|
||||
restart: unless-stopped
|
||||
env_file:
|
||||
- env.d/kc_postgresql
|
||||
healthcheck:
|
||||
test: ["CMD-SHELL", "pg_isready -d keycloak -U keycloak"]
|
||||
interval: 1s
|
||||
timeout: 2s
|
||||
retries: 300
|
||||
volumes:
|
||||
- kc_db:/var/lib/postgresql/data
|
||||
networks:
|
||||
- internal
|
||||
|
||||
volumes:
|
||||
kc_db:
|
||||
|
||||
networks:
|
||||
proxy:
|
||||
external: true
|
||||
internal:
|
||||
@@ -1,12 +0,0 @@
|
||||
# nginx-proxy override for Keycloak
|
||||
#
|
||||
# Usage:
|
||||
# saved as docker-compose.override.yml, see the Deployment Guide
|
||||
|
||||
services:
|
||||
keycloak:
|
||||
environment:
|
||||
VIRTUAL_HOST: ${IDP_HOST}
|
||||
VIRTUAL_PORT: "8080"
|
||||
LETSENCRYPT_HOST: ${IDP_HOST}
|
||||
LETSENCRYPT_EMAIL: ${LETSENCRYPT_EMAIL}
|
||||
@@ -1,14 +0,0 @@
|
||||
# Traefik override for Keycloak
|
||||
#
|
||||
# Usage:
|
||||
# saved as docker-compose.override.yml, see the Deployment Guide
|
||||
|
||||
services:
|
||||
keycloak:
|
||||
labels:
|
||||
traefik.enable: "true"
|
||||
traefik.http.routers.keycloak.rule: "Host(`${IDP_HOST}`)"
|
||||
traefik.http.routers.keycloak.entrypoints: websecure
|
||||
traefik.http.routers.keycloak.tls: "true"
|
||||
traefik.http.routers.keycloak.tls.certresolver: letsencrypt
|
||||
traefik.http.services.keycloak.loadbalancer.server.port: "8080"
|
||||
@@ -1,27 +0,0 @@
|
||||
{
|
||||
"realm": "meet",
|
||||
"enabled": true,
|
||||
"sslRequired": "external",
|
||||
"clients": [
|
||||
{
|
||||
"clientId": "meet",
|
||||
"enabled": true,
|
||||
"protocol": "openid-connect",
|
||||
"publicClient": false,
|
||||
"secret": "REPLACE_ME",
|
||||
"standardFlowEnabled": true,
|
||||
"redirectUris": ["https://meet.example.com/api/v1.0/callback/"],
|
||||
"webOrigins": ["https://meet.example.com"],
|
||||
"attributes": {"post.logout.redirect.uris": "https://meet.example.com/*"}
|
||||
}
|
||||
],
|
||||
"users": [
|
||||
{
|
||||
"username": "meet-admin",
|
||||
"email": "admin@example.com",
|
||||
"enabled": true,
|
||||
"emailVerified": true,
|
||||
"credentials": [{"type": "password", "value": "MEET_ADMIN_PASSWORD_PLACEHOLDER", "temporary": true}]
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -1,94 +0,0 @@
|
||||
# Garage, the recording storage of the Recording guide, on Kubernetes:
|
||||
# one node, no replication, a 50 GiB volume, behind a Service named garage.
|
||||
apiVersion: v1
|
||||
kind: ConfigMap
|
||||
metadata:
|
||||
name: garage-config
|
||||
namespace: meet
|
||||
data:
|
||||
garage.toml: |
|
||||
metadata_dir = "/var/lib/garage/meta"
|
||||
data_dir = "/var/lib/garage/data"
|
||||
db_engine = "lmdb"
|
||||
replication_factor = 1
|
||||
rpc_bind_addr = "127.0.0.1:3901"
|
||||
rpc_public_addr = "127.0.0.1:3901"
|
||||
|
||||
[s3_api]
|
||||
api_bind_addr = "[::]:9000"
|
||||
s3_region = "garage"
|
||||
---
|
||||
apiVersion: v1
|
||||
kind: Service
|
||||
metadata:
|
||||
name: garage
|
||||
namespace: meet
|
||||
spec:
|
||||
selector:
|
||||
app: garage
|
||||
ports:
|
||||
- name: s3
|
||||
port: 9000
|
||||
targetPort: s3
|
||||
---
|
||||
apiVersion: apps/v1
|
||||
kind: StatefulSet
|
||||
metadata:
|
||||
name: garage
|
||||
namespace: meet
|
||||
spec:
|
||||
serviceName: garage
|
||||
replicas: 1
|
||||
selector:
|
||||
matchLabels:
|
||||
app: garage
|
||||
template:
|
||||
metadata:
|
||||
labels:
|
||||
app: garage
|
||||
spec:
|
||||
# Garage never calls the Kubernetes API
|
||||
automountServiceAccountToken: false
|
||||
containers:
|
||||
- name: garage
|
||||
image: dxflrs/garage:v2.4.1
|
||||
command: ["/garage", "server", "--single-node", "--default-bucket"]
|
||||
env:
|
||||
- name: GARAGE_DEFAULT_BUCKET
|
||||
value: meet-media-storage
|
||||
envFrom:
|
||||
- secretRef:
|
||||
name: garage-secrets
|
||||
ports:
|
||||
- name: s3
|
||||
containerPort: 9000
|
||||
resources:
|
||||
requests:
|
||||
cpu: 100m
|
||||
memory: 256Mi
|
||||
ephemeral-storage: 100Mi
|
||||
limits:
|
||||
memory: 1Gi
|
||||
ephemeral-storage: 1Gi
|
||||
readinessProbe:
|
||||
exec:
|
||||
command: ["/garage", "health"]
|
||||
periodSeconds: 5
|
||||
volumeMounts:
|
||||
- name: config
|
||||
mountPath: /etc/garage.toml
|
||||
subPath: garage.toml
|
||||
- name: data
|
||||
mountPath: /var/lib/garage
|
||||
volumes:
|
||||
- name: config
|
||||
configMap:
|
||||
name: garage-config
|
||||
volumeClaimTemplates:
|
||||
- metadata:
|
||||
name: data
|
||||
spec:
|
||||
accessModes: ["ReadWriteOnce"]
|
||||
resources:
|
||||
requests:
|
||||
storage: 50Gi
|
||||
@@ -1,46 +0,0 @@
|
||||
# LiveKit Egress, the recorder of the Recording guide, on Kubernetes.
|
||||
apiVersion: apps/v1
|
||||
kind: Deployment
|
||||
metadata:
|
||||
name: livekit-egress
|
||||
namespace: meet
|
||||
spec:
|
||||
replicas: 1
|
||||
selector:
|
||||
matchLabels:
|
||||
app: livekit-egress
|
||||
template:
|
||||
metadata:
|
||||
labels:
|
||||
app: livekit-egress
|
||||
spec:
|
||||
# Egress never calls the Kubernetes API
|
||||
automountServiceAccountToken: false
|
||||
containers:
|
||||
- name: livekit-egress
|
||||
# Pin the release you tested, from github.com/livekit/egress/releases
|
||||
image: livekit/egress:v1.15.0
|
||||
env:
|
||||
- name: EGRESS_CONFIG_FILE
|
||||
value: /config/livekit-egress.yaml
|
||||
- name: LIVEKIT_API_SECRET
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: meet-backend-env
|
||||
key: LIVEKIT_API_SECRET
|
||||
volumeMounts:
|
||||
- name: config
|
||||
mountPath: /config
|
||||
resources:
|
||||
requests:
|
||||
cpu: 500m
|
||||
memory: 512Mi
|
||||
# Egress writes each recording here before uploading it: no limit,
|
||||
# so a long recording is never evicted
|
||||
ephemeral-storage: 1Gi
|
||||
limits:
|
||||
memory: 2Gi
|
||||
volumes:
|
||||
- name: config
|
||||
configMap:
|
||||
name: livekit-egress-config
|
||||
@@ -1,14 +0,0 @@
|
||||
# LiveKit Egress, the recorder of the Recording guide, on Kubernetes.
|
||||
# The Deployment passes LIVEKIT_API_SECRET from the meet-backend-env Secret.
|
||||
|
||||
api_key: meet
|
||||
ws_url: ws://livekit-server:7880
|
||||
|
||||
# Required: Egress crashes at start without it
|
||||
redis:
|
||||
address: redis-master:6379
|
||||
|
||||
cpu_cost:
|
||||
room_composite_cpu_cost: 1.5
|
||||
track_composite_cpu_cost: 1.0
|
||||
track_cpu_cost: 0.5
|
||||
@@ -1,30 +0,0 @@
|
||||
# Values for LiveKit's Helm chart, from the Helm Deployment guide.
|
||||
# The guide's commands put your domain and Meet's LIVEKIT_API_SECRET in.
|
||||
|
||||
livekit:
|
||||
keys:
|
||||
meet: <LIVEKIT_API_SECRET>
|
||||
# Your Redis, the one Meet uses
|
||||
redis:
|
||||
address: redis-master.meet.svc.cluster.local:6379
|
||||
rtc:
|
||||
use_external_ip: true
|
||||
# Required for UDP media
|
||||
udp_port: 7882
|
||||
logging:
|
||||
level: info
|
||||
webhook:
|
||||
api_key: meet
|
||||
urls:
|
||||
- https://meet.example.com/api/v1.0/rooms/webhooks-livekit/
|
||||
|
||||
# The chart has no ingress: block. type: nginx renders a plain Ingress with no
|
||||
# ingressClassName, so the cluster's default IngressClass serves it.
|
||||
loadBalancer:
|
||||
type: nginx
|
||||
annotations:
|
||||
cert-manager.io/cluster-issuer: letsencrypt-prod
|
||||
tls:
|
||||
- hosts:
|
||||
- livekit.example.com
|
||||
secretName: livekit-tls
|
||||
@@ -1,325 +0,0 @@
|
||||
# Values for the Meet Helm chart, from the Helm Deployment guide.
|
||||
# The guide's sed puts your domain in every host below.
|
||||
# Each optional feature below is off: commented out, or behind enabled: false.
|
||||
# Its guide says which lines to turn on.
|
||||
|
||||
backend:
|
||||
replicas: 2
|
||||
pdb:
|
||||
enabled: true
|
||||
resources:
|
||||
requests:
|
||||
cpu: 200m
|
||||
memory: 512Mi
|
||||
limits:
|
||||
memory: 1Gi
|
||||
# The restricted Pod Security Standard: Helm Deployment, Security context.
|
||||
# Uncomment this block first: the other components reuse its anchor.
|
||||
# podSecurityContext:
|
||||
# fsGroup: 1000
|
||||
# securityContext: &restrictedContext
|
||||
# runAsNonRoot: true
|
||||
# runAsUser: 1000
|
||||
# allowPrivilegeEscalation: false
|
||||
# readOnlyRootFilesystem: true
|
||||
# seccompProfile:
|
||||
# type: RuntimeDefault
|
||||
# capabilities:
|
||||
# drop:
|
||||
# - ALL
|
||||
# # A read-only root filesystem needs a writable /tmp for the gunicorn workers.
|
||||
# extraVolumes:
|
||||
# - name: tmp
|
||||
# emptyDir: {}
|
||||
# extraVolumeMounts:
|
||||
# - name: tmp
|
||||
# mountPath: /tmp
|
||||
# The meet-backend-env Secret of the guide, one environment variable per key
|
||||
envFrom:
|
||||
- secretRef:
|
||||
name: meet-backend-env
|
||||
envVars:
|
||||
DJANGO_SETTINGS_MODULE: "meet.settings"
|
||||
DJANGO_CONFIGURATION: "Production"
|
||||
DJANGO_ALLOWED_HOSTS: "meet.example.com"
|
||||
DJANGO_CSRF_TRUSTED_ORIGINS: "https://meet.example.com"
|
||||
PYTHONPATH: "/app"
|
||||
ALLOW_UNREGISTERED_ROOMS: "False"
|
||||
|
||||
# The admin account the chart creates, with the password from the Secret
|
||||
DJANGO_SUPERUSER_EMAIL: "admin@example.com"
|
||||
|
||||
# Your PostgreSQL
|
||||
DB_HOST: "postgresql.meet.svc.cluster.local"
|
||||
DB_PORT: "5432"
|
||||
DB_NAME: "meet"
|
||||
DB_USER: "meet"
|
||||
# The password from a Secret of another shape: Helm, Secrets management
|
||||
# DB_PASSWORD:
|
||||
# secretKeyRef:
|
||||
# name: my-database
|
||||
# key: password
|
||||
|
||||
# Your Redis. Without CELERY_BROKER_URL, the celeryBackend worker looks for
|
||||
# a host named "redis".
|
||||
REDIS_URL: "redis://redis-master:6379/0"
|
||||
CELERY_BROKER_URL: "redis://redis-master:6379/0"
|
||||
|
||||
LIVEKIT_API_KEY: "meet"
|
||||
LIVEKIT_API_URL: "https://livekit.example.com"
|
||||
|
||||
# Keycloak's endpoints for a realm named meet. Another provider's are in
|
||||
# the SSO & Authentication guide.
|
||||
OIDC_RP_CLIENT_ID: "meet"
|
||||
OIDC_RP_SIGN_ALGO: "RS256"
|
||||
OIDC_RP_SCOPES: "openid email"
|
||||
OIDC_OP_AUTHORIZATION_ENDPOINT: >-
|
||||
https://auth.example.com/realms/meet/protocol/openid-connect/auth
|
||||
OIDC_OP_TOKEN_ENDPOINT: >-
|
||||
https://auth.example.com/realms/meet/protocol/openid-connect/token
|
||||
OIDC_OP_USER_ENDPOINT: >-
|
||||
https://auth.example.com/realms/meet/protocol/openid-connect/userinfo
|
||||
OIDC_OP_JWKS_ENDPOINT: >-
|
||||
https://auth.example.com/realms/meet/protocol/openid-connect/certs
|
||||
OIDC_OP_LOGOUT_ENDPOINT: >-
|
||||
https://auth.example.com/realms/meet/protocol/openid-connect/logout
|
||||
|
||||
# Email: the Email (SMTP) guide. The password is in the meet-smtp Secret.
|
||||
# DJANGO_EMAIL_HOST: "smtp.example.com"
|
||||
# DJANGO_EMAIL_PORT: "587"
|
||||
# DJANGO_EMAIL_HOST_USER: "meet@example.com"
|
||||
# DJANGO_EMAIL_HOST_PASSWORD:
|
||||
# secretKeyRef:
|
||||
# name: meet-smtp
|
||||
# key: password
|
||||
# DJANGO_EMAIL_USE_TLS: "True"
|
||||
# DJANGO_EMAIL_FROM: "meet@example.com"
|
||||
# DJANGO_EMAIL_APP_BASE_URL: "https://meet.example.com"
|
||||
# DJANGO_EMAIL_DOMAIN: "meet.example.com"
|
||||
|
||||
# Recording: the Recording guide. The keys are in the garage-secrets Secret.
|
||||
# RECORDING_ENABLE: "True"
|
||||
# AWS_S3_ENDPOINT_URL: "http://garage.meet.svc.cluster.local:9000"
|
||||
# AWS_S3_ACCESS_KEY_ID:
|
||||
# secretKeyRef:
|
||||
# name: garage-secrets
|
||||
# key: GARAGE_DEFAULT_ACCESS_KEY
|
||||
# AWS_S3_SECRET_ACCESS_KEY:
|
||||
# secretKeyRef:
|
||||
# name: garage-secrets
|
||||
# key: GARAGE_DEFAULT_SECRET_KEY
|
||||
# AWS_S3_REGION_NAME: "garage"
|
||||
# AWS_STORAGE_BUCKET_NAME: "meet-media-storage"
|
||||
# RECORDING_DOWNLOAD_BASE_URL: "https://meet.example.com/recording"
|
||||
|
||||
# AI transcription: the AI Transcription guide. The two tokens are the
|
||||
# api_key and webhook_api_key of summary's AUTHORIZED_TENANTS below.
|
||||
# SUMMARY_SERVICE_VERSION: "2"
|
||||
# SUMMARY_SERVICE_ENDPOINT: "http://meet-summary:80/api/v2/async-jobs/transcribe"
|
||||
# SUMMARY_SERVICE_API_TOKEN: "<same-api_key-you-set-in-AUTHORIZED_TENANTS>"
|
||||
# SUMMARY_SERVICE_WEBHOOK_API_TOKEN: "<same-webhook_api_key-you-set-in-AUTHORIZED_TENANTS>"
|
||||
# Speaker names, with agentMetadata below
|
||||
# METADATA_COLLECTOR_ENABLED: "True"
|
||||
# LLM summaries for every user, without an analytics backend
|
||||
# ANALYTICS_BACKEND_SETTINGS: '{"feature_flags": {"summary-enabled": True}}'
|
||||
|
||||
# Live subtitles: the Real-time Subtitles guide, with agentSubtitles below
|
||||
# ROOM_SUBTITLE_ENABLED: "True"
|
||||
|
||||
# Your CSS: the Theming guide, with frontend's custom-css volume below
|
||||
# FRONTEND_CUSTOM_CSS_URL: "/custom.css"
|
||||
|
||||
frontend:
|
||||
replicas: 2
|
||||
pdb:
|
||||
enabled: true
|
||||
resources:
|
||||
requests:
|
||||
cpu: 50m
|
||||
memory: 64Mi
|
||||
limits:
|
||||
memory: 128Mi
|
||||
# securityContext: *restrictedContext # needs backend's block uncommented
|
||||
# Uncomment both list keys below for either use: the tmp entries go with the
|
||||
# security context, the others with the Theming guide, one per ConfigMap.
|
||||
# extraVolumes:
|
||||
# # A read-only root filesystem needs a writable /tmp for nginx.
|
||||
# - name: tmp
|
||||
# emptyDir: {}
|
||||
# - name: custom-css
|
||||
# configMap:
|
||||
# name: meet-custom-css
|
||||
# - name: custom-assets
|
||||
# configMap:
|
||||
# name: meet-custom-assets
|
||||
# extraVolumeMounts:
|
||||
# - name: tmp
|
||||
# mountPath: /tmp
|
||||
# - name: custom-css
|
||||
# mountPath: /usr/share/nginx/html/custom.css
|
||||
# subPath: custom.css
|
||||
# readOnly: true
|
||||
# - name: custom-assets
|
||||
# mountPath: /usr/share/nginx/html/assets/logo.svg
|
||||
# subPath: logo.svg
|
||||
# readOnly: true
|
||||
# - name: custom-assets
|
||||
# mountPath: /usr/share/nginx/html/assets/intro-slider/1.png
|
||||
# subPath: intro-slider-1.png
|
||||
# readOnly: true
|
||||
|
||||
# Meet and its /admin path, with cert-manager certificates
|
||||
ingress:
|
||||
enabled: true
|
||||
className: nginx
|
||||
host: meet.example.com
|
||||
path: /
|
||||
annotations:
|
||||
cert-manager.io/cluster-issuer: letsencrypt-prod
|
||||
tls:
|
||||
enabled: true
|
||||
secretName: meet-tls
|
||||
|
||||
ingressAdmin:
|
||||
enabled: true
|
||||
className: nginx
|
||||
host: meet.example.com
|
||||
path: /admin
|
||||
annotations:
|
||||
cert-manager.io/cluster-issuer: letsencrypt-prod
|
||||
tls:
|
||||
enabled: true
|
||||
secretName: meet-tls
|
||||
|
||||
# Recording downloads at /media/, with nginx-ingress only: the Recording guide
|
||||
ingressMedia:
|
||||
enabled: false
|
||||
className: nginx
|
||||
host: meet.example.com
|
||||
annotations:
|
||||
cert-manager.io/cluster-issuer: letsencrypt-prod
|
||||
nginx.ingress.kubernetes.io/auth-url: "https://meet.example.com/api/v1.0/recordings/media-auth/"
|
||||
nginx.ingress.kubernetes.io/auth-response-headers: "Authorization, X-Amz-Date, X-Amz-Content-SHA256"
|
||||
# The Host header sent to the storage: its host:port
|
||||
nginx.ingress.kubernetes.io/upstream-vhost: "garage.meet.svc.cluster.local:9000"
|
||||
# Sends /media/<path> to /<bucket>/<path> on the storage
|
||||
nginx.ingress.kubernetes.io/rewrite-target: /meet-media-storage/$1
|
||||
nginx.ingress.kubernetes.io/configuration-snippet: |
|
||||
add_header Content-Security-Policy "default-src 'none'" always;
|
||||
tls:
|
||||
enabled: true
|
||||
secretName: meet-tls
|
||||
|
||||
# The storage ingressMedia fetches the files from
|
||||
serviceMedia:
|
||||
host: garage.meet.svc.cluster.local
|
||||
port: 9000
|
||||
|
||||
# The chart runs the optional services below by default. They are off here:
|
||||
# each guide says which to turn back on.
|
||||
|
||||
# Background tasks, run only with CELERY_ENABLED="True" in backend.envVars;
|
||||
# without it, the backend deletes files and sends emails itself.
|
||||
celeryBackend:
|
||||
replicas: 0
|
||||
# securityContext: *restrictedContext # needs backend's block uncommented
|
||||
|
||||
# Transcription and summaries: the AI Transcription guide. Each worker takes
|
||||
# the summary service's environment through the summaryEnv anchor.
|
||||
summary:
|
||||
replicas: 0
|
||||
# securityContext: *restrictedContext # needs backend's block uncommented
|
||||
# envVars: &summaryEnv
|
||||
# CELERY_BROKER_URL: "redis://redis-master:6379/1"
|
||||
# CELERY_RESULT_BACKEND: "redis://redis-master:6379/1"
|
||||
# AWS_S3_ENDPOINT_URL: "http://garage.meet.svc.cluster.local:9000"
|
||||
# AWS_S3_ACCESS_KEY_ID:
|
||||
# secretKeyRef:
|
||||
# name: garage-secrets
|
||||
# key: GARAGE_DEFAULT_ACCESS_KEY
|
||||
# AWS_S3_SECRET_ACCESS_KEY:
|
||||
# secretKeyRef:
|
||||
# name: garage-secrets
|
||||
# key: GARAGE_DEFAULT_SECRET_KEY
|
||||
# AWS_S3_REGION_NAME: "garage"
|
||||
# AWS_STORAGE_BUCKET_NAME: "meet-media-storage"
|
||||
# AWS_S3_SECURE_ACCESS: "False"
|
||||
# AUTHORIZED_TENANTS: |
|
||||
# [{
|
||||
# "id": "meet",
|
||||
# "api_key": "<generate-a-strong-secret>",
|
||||
# "webhook_url": "https://meet.example.com/api/v1.0/recordings/external-process-hook/",
|
||||
# "webhook_api_key": "<generate-a-strong-secret>",
|
||||
# "allowed_push_to_docs": true
|
||||
# }]
|
||||
# WHISPERX_BASE_URL: "http://whisperx:8000/v1"
|
||||
# WHISPERX_ASR_MODEL: "large-v3"
|
||||
# WHISPERX_API_KEY: "your-api-key"
|
||||
# LLM_BASE_URL: "https://your-llm-api.example.com/v1"
|
||||
# LLM_API_KEY: "your-llm-api-key"
|
||||
# LLM_MODEL: "gpt-4o-mini"
|
||||
# IS_LASUITE_DOCS_INTEGRATION_ENABLED: "True"
|
||||
# LASUITE_DOCS_BASE_URL: "https://docs.example.com"
|
||||
# LASUITE_DOCS_SERVER_TO_SERVER_API_KEY: "your-docs-api-key"
|
||||
celeryTranscribe:
|
||||
# securityContext: *restrictedContext # needs backend's block uncommented
|
||||
# envVars: *summaryEnv
|
||||
instances: []
|
||||
# In place of instances: [] above
|
||||
# instances:
|
||||
# - name: transcribe-1
|
||||
# replicas: 1
|
||||
# LLM summaries only
|
||||
celerySummarize:
|
||||
replicas: 0
|
||||
# securityContext: *restrictedContext # needs backend's block uncommented
|
||||
# envVars: *summaryEnv
|
||||
celerySummaryBackend:
|
||||
replicas: 0
|
||||
# securityContext: *restrictedContext # needs backend's block uncommented
|
||||
# envVars: *summaryEnv
|
||||
|
||||
# The metadata collector, which names the speakers: the AI Transcription guide
|
||||
agentMetadata:
|
||||
replicas: 0
|
||||
# securityContext: *restrictedContext # needs backend's block uncommented
|
||||
# command: ["python", "metadata_collector.py", "start"]
|
||||
# envVars:
|
||||
# LIVEKIT_URL: "ws://livekit-server:7880"
|
||||
# LIVEKIT_API_KEY: "meet"
|
||||
# LIVEKIT_API_SECRET:
|
||||
# secretKeyRef:
|
||||
# name: meet-backend-env
|
||||
# key: LIVEKIT_API_SECRET
|
||||
# AWS_S3_ENDPOINT_URL: "garage.meet.svc.cluster.local:9000"
|
||||
# AWS_S3_ACCESS_KEY_ID:
|
||||
# secretKeyRef:
|
||||
# name: garage-secrets
|
||||
# key: GARAGE_DEFAULT_ACCESS_KEY
|
||||
# AWS_S3_SECRET_ACCESS_KEY:
|
||||
# secretKeyRef:
|
||||
# name: garage-secrets
|
||||
# key: GARAGE_DEFAULT_SECRET_KEY
|
||||
# AWS_S3_REGION_NAME: "garage"
|
||||
# AWS_STORAGE_BUCKET_NAME: "meet-media-storage"
|
||||
|
||||
# Live subtitles: the Real-time Subtitles guide. The Deepgram key is in the
|
||||
# meet-deepgram Secret.
|
||||
agentSubtitles:
|
||||
replicas: 0
|
||||
# securityContext: *restrictedContext # needs backend's block uncommented
|
||||
# envVars:
|
||||
# LIVEKIT_URL: "ws://livekit-server:7880"
|
||||
# LIVEKIT_API_KEY: "meet"
|
||||
# LIVEKIT_API_SECRET:
|
||||
# secretKeyRef:
|
||||
# name: meet-backend-env
|
||||
# key: LIVEKIT_API_SECRET
|
||||
# STT_PROVIDER: "deepgram"
|
||||
# DEEPGRAM_STT_MODEL: "nova-3"
|
||||
# DEEPGRAM_STT_LANGUAGE: "multi"
|
||||
# ENABLE_SILERO_VAD: "true"
|
||||
# DEEPGRAM_API_KEY:
|
||||
# secretKeyRef:
|
||||
# name: meet-deepgram
|
||||
# key: api-key
|
||||
@@ -19,9 +19,4 @@ rtc:
|
||||
# the host has a public IP address, but is not exposed to the process.
|
||||
# LiveKit will attempt to use STUN to discover the true IP, and advertise
|
||||
# that IP with its clients
|
||||
use_external_ip: true
|
||||
# Sends room and participant events to the backend: lobby, presence, telephony and recording rely on them.
|
||||
webhook:
|
||||
api_key: meet
|
||||
urls:
|
||||
- https://meet.example.com/api/v1.0/rooms/webhooks-livekit/
|
||||
use_external_ip: true
|
||||
@@ -1,248 +0,0 @@
|
||||
# Meet core stack
|
||||
#
|
||||
# Runs: backend, frontend, celery, livekit, postgresql, redis
|
||||
#
|
||||
# The optional features' services sit at the end, each under a profile that
|
||||
# COMPOSE_PROFILES in .env turns on, e.g. COMPOSE_PROFILES=recording,subtitles.
|
||||
#
|
||||
# This file is proxy-agnostic.
|
||||
#
|
||||
# Usage:
|
||||
# cd ~/docker/meet
|
||||
# # download your proxy's override as docker-compose.override.yml, see the Deployment Guide
|
||||
# cp ~/docker/hosts .env
|
||||
# # fill the placeholders of env.d/common, env.d/postgresql and
|
||||
# # livekit-server.yaml, as the Deployment Guide shows
|
||||
# docker compose up -d
|
||||
# docker compose exec backend python manage.py migrate
|
||||
#
|
||||
# Networks:
|
||||
# proxy - external, shared with your reverse proxy (nginx-proxy or Traefik)
|
||||
# internal - created automatically by this stack
|
||||
|
||||
services:
|
||||
|
||||
backend:
|
||||
image: lasuite/meet-backend:${MEET_VERSION:-latest}
|
||||
restart: unless-stopped
|
||||
user: ${DOCKER_USER:-1000}
|
||||
env_file:
|
||||
- .env
|
||||
- env.d/common
|
||||
- env.d/postgresql
|
||||
healthcheck:
|
||||
test: ["CMD", "python", "manage.py", "check"]
|
||||
interval: 15s
|
||||
timeout: 30s
|
||||
retries: 20
|
||||
start_period: 10s
|
||||
depends_on:
|
||||
postgresql:
|
||||
condition: service_healthy
|
||||
redis:
|
||||
condition: service_started
|
||||
livekit:
|
||||
condition: service_started
|
||||
networks:
|
||||
- internal
|
||||
|
||||
frontend:
|
||||
image: lasuite/meet-frontend:${MEET_VERSION:-latest}
|
||||
restart: unless-stopped
|
||||
entrypoint: [/docker-entrypoint.sh]
|
||||
command: ["nginx", "-g", "daemon off;"]
|
||||
env_file:
|
||||
- .env
|
||||
- env.d/common
|
||||
volumes:
|
||||
- ./nginx-routing.conf:/etc/nginx/conf.d/routing.conf:ro
|
||||
# Your CSS, logo and images, see the Theming guide
|
||||
# - ./custom.css:/usr/share/nginx/html/custom.css:ro
|
||||
# - ./custom-assets/logo.svg:/usr/share/nginx/html/assets/logo.svg:ro
|
||||
# - ./custom-assets/intro-slider:/usr/share/nginx/html/assets/intro-slider:ro
|
||||
depends_on:
|
||||
backend:
|
||||
condition: service_healthy
|
||||
networks:
|
||||
- proxy
|
||||
- internal
|
||||
|
||||
celery:
|
||||
image: lasuite/meet-backend:${MEET_VERSION:-latest}
|
||||
restart: unless-stopped
|
||||
user: ${DOCKER_USER:-1000}
|
||||
command: ["celery", "-A", "meet.celery_app", "worker", "-l", "INFO"]
|
||||
env_file:
|
||||
- .env
|
||||
- env.d/common
|
||||
- env.d/postgresql
|
||||
depends_on:
|
||||
- backend
|
||||
networks:
|
||||
- internal
|
||||
|
||||
postgresql:
|
||||
image: postgres:16
|
||||
restart: unless-stopped
|
||||
env_file:
|
||||
- env.d/postgresql
|
||||
healthcheck:
|
||||
test: ["CMD-SHELL", "pg_isready -d meet -U meet"]
|
||||
interval: 1s
|
||||
timeout: 2s
|
||||
retries: 300
|
||||
volumes:
|
||||
- meet_db:/var/lib/postgresql/data
|
||||
networks:
|
||||
- internal
|
||||
|
||||
redis:
|
||||
image: redis:7
|
||||
restart: unless-stopped
|
||||
networks:
|
||||
- internal
|
||||
|
||||
livekit:
|
||||
image: livekit/livekit-server:${LIVEKIT_VERSION:-latest}
|
||||
restart: unless-stopped
|
||||
command: --config /config.yaml
|
||||
ports:
|
||||
- "7881:7881/tcp"
|
||||
- "7882:7882/udp"
|
||||
# TURN over UDP on 443, and over TLS, see the LiveKit & TURN guide
|
||||
# - "443:443/udp"
|
||||
# - "5349:5349/tcp"
|
||||
volumes:
|
||||
- ./livekit-server.yaml:/config.yaml:ro
|
||||
depends_on:
|
||||
- redis
|
||||
networks:
|
||||
- proxy
|
||||
- internal
|
||||
|
||||
# ---- Optional features, off until COMPOSE_PROFILES names their profile ----
|
||||
|
||||
# Recording: the Recording guide
|
||||
livekit-egress:
|
||||
profiles: [recording]
|
||||
image: livekit/egress:${EGRESS_VERSION:-latest}
|
||||
restart: unless-stopped
|
||||
environment:
|
||||
EGRESS_CONFIG_FILE: /livekit-egress.yaml
|
||||
volumes:
|
||||
- ./livekit-egress.yaml:/livekit-egress.yaml:ro
|
||||
depends_on:
|
||||
- redis
|
||||
- livekit
|
||||
networks:
|
||||
- internal
|
||||
|
||||
# AI transcription: the AI Transcription guide. The summary service's
|
||||
# Celery broker, its API, the worker that transcribes and the one that
|
||||
# sends the result back to Meet.
|
||||
redis-summary:
|
||||
profiles: [transcription]
|
||||
image: redis:7
|
||||
restart: unless-stopped
|
||||
networks:
|
||||
- internal
|
||||
|
||||
app-summary:
|
||||
profiles: [transcription]
|
||||
image: lasuite/meet-summary:${MEET_VERSION:-latest}
|
||||
restart: unless-stopped
|
||||
env_file:
|
||||
- env.d/summary
|
||||
depends_on:
|
||||
- redis-summary
|
||||
networks:
|
||||
- internal
|
||||
|
||||
celery-summary-transcribe:
|
||||
profiles: [transcription]
|
||||
image: lasuite/meet-summary:${MEET_VERSION:-latest}
|
||||
restart: unless-stopped
|
||||
command: celery -A summary.core.celery_worker worker --pool=solo -Q transcribe-queue-v2
|
||||
env_file:
|
||||
- env.d/summary
|
||||
depends_on:
|
||||
- redis-summary
|
||||
networks:
|
||||
- internal
|
||||
|
||||
celery-summary-webhook:
|
||||
profiles: [transcription]
|
||||
image: lasuite/meet-summary:${MEET_VERSION:-latest}
|
||||
restart: unless-stopped
|
||||
command: celery -A summary.core.celery_worker worker --pool=solo -Q call-webhook-queue-v2
|
||||
env_file:
|
||||
- env.d/summary
|
||||
depends_on:
|
||||
- redis-summary
|
||||
networks:
|
||||
- internal
|
||||
|
||||
# LLM summaries, with transcription: the AI Transcription guide
|
||||
celery-summary-summarize:
|
||||
profiles: [summaries]
|
||||
image: lasuite/meet-summary:${MEET_VERSION:-latest}
|
||||
restart: unless-stopped
|
||||
command: celery -A summary.core.celery_worker worker --pool=solo -Q summarize-queue-v2
|
||||
env_file:
|
||||
- env.d/summary
|
||||
depends_on:
|
||||
- redis-summary
|
||||
networks:
|
||||
- internal
|
||||
|
||||
# Speaker names in transcripts: the AI Transcription guide
|
||||
metadata-collector:
|
||||
profiles: [metadata-collector]
|
||||
image: lasuite/meet-agents:${MEET_VERSION:-latest}
|
||||
command: python metadata_collector.py start
|
||||
restart: unless-stopped
|
||||
env_file:
|
||||
- env.d/metadata-collector
|
||||
depends_on:
|
||||
- livekit
|
||||
networks:
|
||||
- internal
|
||||
|
||||
# Live subtitles: the Real-time Subtitles guide
|
||||
multi-user-transcriber:
|
||||
profiles: [subtitles]
|
||||
image: lasuite/meet-agents:${MEET_VERSION:-latest}
|
||||
command: python multi_user_transcriber.py start
|
||||
restart: unless-stopped
|
||||
env_file:
|
||||
- env.d/multi-user-transcriber
|
||||
depends_on:
|
||||
- livekit
|
||||
networks:
|
||||
- internal
|
||||
|
||||
# Dial-in by phone: the Telephony guide
|
||||
livekit-sip:
|
||||
profiles: [telephony]
|
||||
image: livekit/sip:${LIVEKIT_SIP_VERSION:-latest}
|
||||
restart: unless-stopped
|
||||
environment:
|
||||
SIP_CONFIG_FILE: /sip-config.yaml
|
||||
volumes:
|
||||
- ./livekit-sip.yaml:/sip-config.yaml:ro
|
||||
ports:
|
||||
- "5060:5060/udp"
|
||||
- "10000-20000:10000-20000/udp"
|
||||
depends_on:
|
||||
- redis
|
||||
- livekit
|
||||
networks:
|
||||
- internal
|
||||
|
||||
volumes:
|
||||
meet_db:
|
||||
|
||||
networks:
|
||||
proxy:
|
||||
external: true
|
||||
internal:
|
||||
@@ -1,45 +0,0 @@
|
||||
/* Your theme for Meet, from the Theming guide, loaded through
|
||||
FRONTEND_CUSTOM_CSS_URL. Put your colors in place of this teal. */
|
||||
|
||||
/* A custom font: the Theming guide shows the two lines to add. */
|
||||
|
||||
:root {
|
||||
/* Semantic tokens */
|
||||
--colors-primary: #00796B;
|
||||
--colors-primary-hover: #00695C;
|
||||
--colors-primary-active: #004D40;
|
||||
--colors-primary-text: #ffffff;
|
||||
--colors-primary-subtle: #E0F2F1;
|
||||
--colors-primary-subtle-text: #00695C;
|
||||
--colors-primary-warm: #80CBC4;
|
||||
|
||||
/* Raw palette scale */
|
||||
--colors-primary-50: #E0F2F1;
|
||||
--colors-primary-100: #B2DFDB;
|
||||
--colors-primary-200: #80CBC4;
|
||||
--colors-primary-300: #4DB6AC;
|
||||
--colors-primary-400: #26A69A;
|
||||
--colors-primary-500: #009688;
|
||||
--colors-primary-600: #00897B;
|
||||
--colors-primary-700: #00796B;
|
||||
--colors-primary-800: #00695C;
|
||||
--colors-primary-900: #004D40;
|
||||
--colors-primary-950: #003D33;
|
||||
/* Saturated shade for action buttons, Meet's #1212FF */
|
||||
--colors-primary-action: #00897B;
|
||||
|
||||
/* Dark scale, inside a room: 50 is the darkest, 950 the lightest */
|
||||
--colors-primary-dark-50: #162221;
|
||||
--colors-primary-dark-75: #223432;
|
||||
--colors-primary-dark-100: #2D4644;
|
||||
--colors-primary-dark-200: #436A66;
|
||||
--colors-primary-dark-300: #5A8F8A;
|
||||
--colors-primary-dark-400: #70B3AD;
|
||||
--colors-primary-dark-500: #87D7D0;
|
||||
--colors-primary-dark-600: #9DDFD9;
|
||||
--colors-primary-dark-700: #B3E7E2;
|
||||
--colors-primary-dark-800: #C9EEEB;
|
||||
--colors-primary-dark-900: #DFF6F4;
|
||||
--colors-primary-dark-950: #F5FEFD;
|
||||
--colors-primary-dark-action: #C1FBF6;
|
||||
}
|
||||
@@ -1,32 +0,0 @@
|
||||
# nginx-proxy override for Meet
|
||||
#
|
||||
# Adds VIRTUAL_HOST / LETSENCRYPT_HOST env vars so nginx-proxy + acme-companion
|
||||
# automatically route and issue TLS certificates for each service.
|
||||
#
|
||||
# Usage:
|
||||
# saved as docker-compose.override.yml, see the Deployment Guide
|
||||
# docker compose up -d
|
||||
|
||||
services:
|
||||
|
||||
frontend:
|
||||
environment:
|
||||
VIRTUAL_HOST: ${MEET_HOST}
|
||||
VIRTUAL_PORT: "8083"
|
||||
LETSENCRYPT_HOST: ${MEET_HOST}
|
||||
LETSENCRYPT_EMAIL: ${LETSENCRYPT_EMAIL}
|
||||
|
||||
livekit:
|
||||
environment:
|
||||
VIRTUAL_HOST: ${LIVEKIT_HOST}
|
||||
VIRTUAL_PORT: "7880"
|
||||
LETSENCRYPT_HOST: ${LIVEKIT_HOST}
|
||||
LETSENCRYPT_EMAIL: ${LETSENCRYPT_EMAIL}
|
||||
# TURN over TLS reads acme-companion's certificates: uncomment these two
|
||||
# lines and the volumes block below, see the LiveKit & TURN guide
|
||||
# volumes:
|
||||
# - nginx-proxy_certs:/certs:ro
|
||||
|
||||
# volumes:
|
||||
# nginx-proxy_certs:
|
||||
# external: true
|
||||
@@ -1,28 +0,0 @@
|
||||
# Traefik override for Meet
|
||||
#
|
||||
# Adds Traefik router labels so Traefik automatically routes and issues
|
||||
# TLS certificates for each service.
|
||||
#
|
||||
# Usage:
|
||||
# saved as docker-compose.override.yml, see the Deployment Guide
|
||||
# docker compose up -d
|
||||
|
||||
services:
|
||||
|
||||
frontend:
|
||||
labels:
|
||||
traefik.enable: "true"
|
||||
traefik.http.routers.meet-frontend.rule: "Host(`${MEET_HOST}`)"
|
||||
traefik.http.routers.meet-frontend.entrypoints: websecure
|
||||
traefik.http.routers.meet-frontend.tls: "true"
|
||||
traefik.http.routers.meet-frontend.tls.certresolver: letsencrypt
|
||||
traefik.http.services.meet-frontend.loadbalancer.server.port: "8083"
|
||||
|
||||
livekit:
|
||||
labels:
|
||||
traefik.enable: "true"
|
||||
traefik.http.routers.meet-livekit.rule: "Host(`${LIVEKIT_HOST}`)"
|
||||
traefik.http.routers.meet-livekit.entrypoints: websecure
|
||||
traefik.http.routers.meet-livekit.tls: "true"
|
||||
traefik.http.routers.meet-livekit.tls.certresolver: letsencrypt
|
||||
traefik.http.services.meet-livekit.loadbalancer.server.port: "7880"
|
||||
@@ -1,7 +0,0 @@
|
||||
{
|
||||
"trunk": {
|
||||
"name": "Main dial-in number",
|
||||
"numbers": ["<ROOM_TELEPHONY_PHONE_NUMBER>"],
|
||||
"allowed_addresses": ["<your provider's signaling IP or CIDR range>"]
|
||||
}
|
||||
}
|
||||
@@ -1,15 +0,0 @@
|
||||
# LiveKit Egress, the recorder of the Recording guide.
|
||||
# generate-secrets.sh fills the LiveKit API secret.
|
||||
|
||||
api_key: meet
|
||||
api_secret: <your LiveKit API secret>
|
||||
ws_url: ws://livekit:7880
|
||||
|
||||
# Required: Egress crashes at start without it
|
||||
redis:
|
||||
address: redis:6379
|
||||
|
||||
cpu_cost:
|
||||
room_composite_cpu_cost: 1.5
|
||||
track_composite_cpu_cost: 1.0
|
||||
track_cpu_cost: 0.5
|
||||
@@ -1,9 +0,0 @@
|
||||
# LiveKit SIP, the phone bridge of the Telephony guide.
|
||||
# generate-secrets.sh fills the LiveKit API secret.
|
||||
|
||||
api_key: meet
|
||||
api_secret: <your LiveKit API secret>
|
||||
ws_url: ws://livekit:7880
|
||||
|
||||
redis:
|
||||
address: redis:6379
|
||||
@@ -1,74 +0,0 @@
|
||||
# Replaces docker/files/production/default.conf.template for the compose
|
||||
# examples. It adds X-Forwarded-Proto, which Django's SSL redirect needs behind
|
||||
# the TLS proxy, and client_max_body_size for uploads.
|
||||
upstream meet_backend {
|
||||
server backend:8000 fail_timeout=0;
|
||||
}
|
||||
|
||||
upstream meet_frontend {
|
||||
server frontend:8080 fail_timeout=0;
|
||||
}
|
||||
|
||||
server {
|
||||
listen 8083;
|
||||
server_name localhost;
|
||||
charset utf-8;
|
||||
server_tokens off;
|
||||
client_max_body_size 100M;
|
||||
|
||||
location @proxy_to_meet_backend {
|
||||
proxy_set_header Host $http_host;
|
||||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||
proxy_set_header X-Forwarded-Proto https;
|
||||
proxy_redirect off;
|
||||
proxy_read_timeout 300s;
|
||||
proxy_pass http://meet_backend;
|
||||
}
|
||||
|
||||
location @proxy_to_meet_frontend {
|
||||
proxy_set_header Host $http_host;
|
||||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||
proxy_redirect off;
|
||||
proxy_pass http://meet_frontend;
|
||||
}
|
||||
|
||||
location / { try_files $uri @proxy_to_meet_frontend; }
|
||||
location /api { try_files $uri @proxy_to_meet_backend; }
|
||||
# Only reachable when EXTERNAL_API_ENABLED=True on the backend.
|
||||
location /external-api { try_files $uri @proxy_to_meet_backend; }
|
||||
location /admin { try_files $uri @proxy_to_meet_backend; }
|
||||
location /static { try_files $uri @proxy_to_meet_backend; }
|
||||
location /__heartbeat__ { try_files $uri @proxy_to_meet_backend; }
|
||||
location /__lbheartbeat__ { try_files $uri @proxy_to_meet_backend; }
|
||||
|
||||
# ---- Recording downloads: uncomment them as the Recording guide says ----
|
||||
# Set for the Recording guide's Garage. nginx fails to start while the
|
||||
# name garage does not resolve, so uncomment once Garage runs. With another
|
||||
# storage, put AWS_S3_ENDPOINT_URL and AWS_STORAGE_BUCKET_NAME in
|
||||
# proxy_pass, and that endpoint without http:// or https:// in Host.
|
||||
#
|
||||
# location /media/ {
|
||||
# auth_request /media-auth;
|
||||
# auth_request_set $authHeader $upstream_http_authorization;
|
||||
# auth_request_set $authDate $upstream_http_x_amz_date;
|
||||
# auth_request_set $authContentSha256 $upstream_http_x_amz_content_sha256;
|
||||
#
|
||||
# proxy_set_header Authorization $authHeader;
|
||||
# proxy_set_header X-Amz-Date $authDate;
|
||||
# proxy_set_header X-Amz-Content-SHA256 $authContentSha256;
|
||||
#
|
||||
# proxy_pass http://garage:9000/meet-media-storage/;
|
||||
# proxy_set_header Host garage:9000;
|
||||
# }
|
||||
#
|
||||
# location = /media-auth {
|
||||
# internal;
|
||||
# proxy_pass http://meet_backend/api/v1.0/recordings/media-auth/;
|
||||
# proxy_set_header Host $host;
|
||||
# proxy_set_header X-Forwarded-Proto https;
|
||||
# proxy_set_header X-Original-URL $request_uri;
|
||||
#
|
||||
# proxy_pass_request_body off;
|
||||
# proxy_set_header Content-Length "";
|
||||
# }
|
||||
}
|
||||
@@ -1,49 +0,0 @@
|
||||
# nginx-proxy + acme-companion stack
|
||||
#
|
||||
# Reverse proxy with automatic TLS via Let's Encrypt.
|
||||
# Run this once on your server; it stays up permanently and serves
|
||||
# all other stacks that join the 'proxy' network.
|
||||
#
|
||||
# Usage:
|
||||
# docker network create proxy
|
||||
# cd ~/docker/nginx-proxy
|
||||
# cp ~/docker/hosts .env
|
||||
# docker compose up -d
|
||||
|
||||
services:
|
||||
|
||||
nginx-proxy:
|
||||
image: nginxproxy/nginx-proxy
|
||||
restart: unless-stopped
|
||||
ports:
|
||||
- "80:80"
|
||||
- "443:443"
|
||||
volumes:
|
||||
- html:/usr/share/nginx/html
|
||||
- certs:/etc/nginx/certs:ro
|
||||
- /var/run/docker.sock:/tmp/docker.sock:ro
|
||||
networks:
|
||||
- proxy
|
||||
|
||||
acme-companion:
|
||||
image: nginxproxy/acme-companion
|
||||
restart: unless-stopped
|
||||
environment:
|
||||
DEFAULT_EMAIL: ${LETSENCRYPT_EMAIL}
|
||||
volumes_from:
|
||||
- nginx-proxy
|
||||
volumes:
|
||||
- certs:/etc/nginx/certs:rw
|
||||
- acme:/etc/acme.sh
|
||||
- /var/run/docker.sock:/var/run/docker.sock:ro
|
||||
networks:
|
||||
- proxy
|
||||
|
||||
volumes:
|
||||
html:
|
||||
certs:
|
||||
acme:
|
||||
|
||||
networks:
|
||||
proxy:
|
||||
external: true
|
||||
@@ -1,30 +0,0 @@
|
||||
services:
|
||||
|
||||
traefik:
|
||||
image: traefik:v3
|
||||
container_name: traefik
|
||||
restart: unless-stopped
|
||||
ports:
|
||||
- "80:80"
|
||||
- "443:443"
|
||||
volumes:
|
||||
- /var/run/docker.sock:/var/run/docker.sock:ro
|
||||
- ./acme.json:/etc/traefik/acme/acme.json
|
||||
command:
|
||||
- --providers.docker=true
|
||||
- --providers.docker.exposedByDefault=false
|
||||
- --providers.docker.network=proxy
|
||||
- --entrypoints.web.address=:80
|
||||
- --entrypoints.web.http.redirections.entryPoint.to=websecure
|
||||
- --entrypoints.web.http.redirections.entryPoint.scheme=https
|
||||
- --entrypoints.websecure.address=:443
|
||||
- --certificatesresolvers.letsencrypt.acme.email=${LETSENCRYPT_EMAIL}
|
||||
- --certificatesresolvers.letsencrypt.acme.storage=/etc/traefik/acme/acme.json
|
||||
- --certificatesresolvers.letsencrypt.acme.httpchallenge.entrypoint=web
|
||||
- --log.level=INFO
|
||||
networks:
|
||||
- proxy
|
||||
|
||||
networks:
|
||||
proxy:
|
||||
external: true
|
||||
@@ -1,112 +0,0 @@
|
||||
# Frequently Asked Questions
|
||||
|
||||
Here are answers for participants and hosts about joining and using Meet, and for anyone who wants to run their own Meet server or contribute to the project.
|
||||
|
||||
## Joining
|
||||
|
||||
### Do I need to install anything?
|
||||
|
||||
No. Meet runs in a recent Chrome, Firefox, Safari or Edge, on a computer or a phone, with the differences listed in [Browser support](user/features-controls.md#browser-support).
|
||||
|
||||
A mobile app in beta, not officially supported, is at [github.com/mmaudet/visio-mobile](https://github.com/mmaudet/visio-mobile).
|
||||
|
||||
### Do I need an account?
|
||||
|
||||
- Not to join an **Open** room through its link. Other rooms may make you wait until someone admits you, see [Access levels](user/features-controls.md#access-levels).
|
||||
- Where your Meet server allows it, you can also start a meeting without signing in, though no one will own it, see [Start a meeting](user/getting-started.md#start-a-meeting).
|
||||
|
||||
### Can I join from my phone?
|
||||
|
||||
Yes, in the phone's browser. What works there is in [Joining from a phone](user/guides/phone-or-weak-connection.md), dial-in by phone included.
|
||||
|
||||
### Can I plan a meeting for later?
|
||||
|
||||
Yes: **Create a meeting** → **Create a meeting for a later date**, then send the link. Where your Meet server has it, the [Outlook add-in](https://github.com/suitenumerique/meet/tree/main/src/addons/outlook) adds the link to calendar invitations.
|
||||
|
||||
### Is Meet accessible?
|
||||
|
||||
It works with a keyboard alone and with screen readers, see [Accessibility & Shortcuts](user/accessibility.md). A guide for each need is on the [home page](index.md#where-to-start).
|
||||
|
||||
### Why does the link say the meeting has been deleted?
|
||||
|
||||
Its host deleted the room, see [Deleted rooms](user/features-controls.md#deleted-rooms). Ask them for a new link.
|
||||
|
||||
### Why am I stuck in the waiting room?
|
||||
|
||||
Someone already in the meeting has to admit you. [Permissions](user/features-controls.md#permissions) lists who can.
|
||||
|
||||
### How many people can join, and for how long?
|
||||
|
||||
- People: Meet sets no cap and is built for meetings of more than 100; the limit is the media server's capacity.
|
||||
- Time: no limit. The meeting lasts until the last person leaves, see [When the meeting ends](overview/how-meet-works.md#when-the-meeting-ends).
|
||||
|
||||
## Audio, video and screen
|
||||
|
||||
### My microphone or camera does not work
|
||||
|
||||
1. Allow the browser to use them, from the site settings in its address bar
|
||||
2. Pick the right device in **More Options** → **Settings** → **Audio** or **Video**
|
||||
3. Close any other application using the device, then reload the page
|
||||
|
||||
### My audio echoes
|
||||
|
||||
The echo comes from someone else's speakers feeding back into their microphone, since Meet always cancels echo on yours. Ask them to use headphones or lower their volume.
|
||||
|
||||
### Others sound choppy
|
||||
|
||||
Usually a network problem on one side. Close bandwidth-heavy tabs and apps, move closer to the Wi-Fi router, or ask the choppy participant to check their connection.
|
||||
|
||||
### How do I check my connection before a meeting?
|
||||
|
||||
Click **Test your configuration** in the page footer, where your Meet server offers it, then **Run test**.
|
||||
|
||||
**Suboptimal connection** means your network blocks the direct route: you can join, but quality may drop. Your IT department can open the [ports](self-hosting/configuration/firewall.md) that fix it.
|
||||
|
||||
### I cannot share my screen
|
||||
|
||||
Phones cannot share their screen, see [Browser support](user/features-controls.md#browser-support). On macOS, allow your browser to record the screen in **System Settings → Privacy & Security**.
|
||||
|
||||
## During a meeting
|
||||
|
||||
### How do I change my name, or blur my background?
|
||||
|
||||
Your name is in **More Options** → **Settings** → **Profile**. Blur and background images are under [Backgrounds and effects](user/features-controls.md#more-in-the-call).
|
||||
|
||||
### How do I make someone a co-host?
|
||||
|
||||
In **See everyone**, click **Make co-host** in the menu beside their name, as [For hosts](user/features-controls.md#for-hosts) shows.
|
||||
|
||||
### How do I remove someone, and keep them out?
|
||||
|
||||
Set the room to **Restricted**, then in **See everyone** click **Remove from the call** in the menu beside their name, and **Deny** their request to come back. A current or former co-host still walks in, as [Remove someone](user/guides/large-meeting-host.md#remove-someone) shows.
|
||||
|
||||
## Recording and transcription
|
||||
|
||||
### Who gets the recording, and for how long?
|
||||
|
||||
The [download link](user/recording.md#recording) goes by email to whoever started it, the host and the co-hosts, and whoever runs your Meet server decides [how long the file is kept](overview/how-meet-works.md#what-is-stored-where).
|
||||
|
||||
### Why don't I see the recording or transcription buttons?
|
||||
|
||||
- Not in **More tools**: your Meet server has not set them up.
|
||||
- Shown but you cannot start them: signing in is often enough; otherwise click **Request** and someone allowed can start it. [Permissions](user/features-controls.md#permissions) lists who can.
|
||||
|
||||
## Security and privacy
|
||||
|
||||
### Are meetings encrypted?
|
||||
|
||||
Every stream is encrypted between your browser and the media server with [DTLS-SRTP](https://datatracker.ietf.org/doc/html/rfc5764), the [WebRTC](https://webrtc.org/) standard. Meet has no end-to-end encryption: the media server can read the streams it forwards.
|
||||
|
||||
### Is chat history stored?
|
||||
|
||||
No, unless a transcription is running and your Meet server saves the chat with it, see [What is stored where](overview/how-meet-works.md#what-is-stored-where).
|
||||
|
||||
## Hosting and contributing
|
||||
|
||||
### Can I run my own instance?
|
||||
|
||||
Yes, with your own [LiveKit](https://livekit.io/) media server beside it and any standard [OpenID Connect](https://openid.net/developers/how-connect-works/) provider for sign-in. See [Self-Hosting](self-hosting/index.md).
|
||||
|
||||
### How do I contribute or report a bug?
|
||||
|
||||
Start with [Develop locally](contributing/develop.md), [open an issue](https://github.com/suitenumerique/meet/issues/new?assignees=&labels=bug&template=Bug_report.md) for a bug, and see where Meet is heading on the [roadmap](https://github.com/orgs/suitenumerique/projects/3/views/2).
|
||||