Skip to content

armgit / meet

Public Imported from GitHub
0

Open source video conferencing app powered by LiveKit. Built with Django and React.

📝(docs) enhance installation documentation for Docker Compose deployment

lebaudantoine6bb22ae6f10a
diff --git a/README.md b/README.md
index bc872240..25959c0c 100644
--- a/README.md
+++ b/README.md
@@ -73,6 +73,8 @@ We're currently working on both technical and user documentation for La Suite Me
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).
+
> [!NOTE]
> Some advanced features (ex: recording, transcription) lack detailed documentation. We're working hard to provide comprehensive guides soon.
diff --git a/docs/installation/README.md b/docs/installation/README.md
new file mode 100644
index 00000000..75416678
--- /dev/null
+++ b/docs/installation/README.md
@@ -0,0 +1,28 @@
+# Installation
+If you want to install La Suite Meet you've come to the right place.
+Here are a bunch of resources to help you install the project.
+
+## Kubernetes
+La Suite Meet maintainers use only the Kubernetes deployment method in production, so advanced support is available exclusively for this setup. Please follow the instructions provided [here](/docs/installation/kubernetes.md).
+
+## Docker Compose
+We understand that not everyone has a Kubernetes cluster available.
+We also provide [Docker images](https://hub.docker.com/u/lasuite?page=1&search=meet) that can be deployed using Compose.
+
+> [!WARNING]
+> Under construction: A PR is in progress to support deploying La Suite Meet via Docker Compose.
+
+## Other ways to install La Suite Meet
+Community members have contributed alternative ways to install La Suite Meet 🙏. While maintainers may not provide direct support, we help keep these instructions up to date, and you can reach out to contributors or the community for assistance.
+
+Here is the list of other methods in alphabetical order:
+- Nix: [Packages](https://search.nixos.org/packages?channel=unstable&show=lasuite-meet&query=lasuite-meet), ⚠️ unstable
+- Yunohost: [Packages](https://github.com/YunoHost-Apps/meet_ynh), ⚠️ under construction (for small instances only)
+
+> [!TIP]
+> Feel free to make a PR to add ones that are not listed above
+
+## Cloud providers
+Currently, no cloud providers are listed for deploying La Suite Meet.
+> [!TIP]
+> Feel free to make a PR to add ones that are not listed above
diff --git a/docs/installation.md b/docs/installation/kubernetes.md
similarity index 100%
rename from docs/installation.md
rename to docs/installation/kubernetes.md