lasuite-docs/documentation/installation

Installation

If you want to install Docs you've come to the right place. Here are a bunch of resources to help you install the project.

Whichever method you pick, Docs is made of four services: the frontend, the Django backend, the collaboration server (yhub), which holds the content of the documents and syncs the editors over the websocket, and the conversion service (y-provider), which converts documents between formats. The collaboration server needs a PostgreSQL database and a Redis/Valkey instance of its own, beside the ones the backend uses. See the collaboration documentation for how the services find and authenticate each other.

Kubernetes

We (Docs maintainers) are only using the Kubernetes deployment method in production. We can only provide advanced support for this method. Please follow the instructions laid out here.

Docker Compose

We are aware that not everyone has Kubernetes Cluster laying around 😆. We also provide Docker images that you can deploy using Compose. Please follow the instructions here. ⚠️ Please keep in mind that we do not use it ourselves in production. Let us know in the issues if you run into troubles, we'll try to help.

Scalingo

You can deploy Docs on Scalingo using a custom buildpack. This method handles both frontend and backend builds, serving them through Nginx with the conversion service (y-provider). ⚠️ The buildpack does not start the collaboration server, which has to be run separately. Please follow the instructions here.

Other ways to install Docs

Community members have contributed several other ways to install Docs. While we owe them a big thanks 🙏, please keep in mind we (Docs maintainers) can't provide support on these installation methods as we don't use them ourselves and there are too many options out there for us to keep track of. Of course you can contact the contributors and the broader community for assistance.

Here is the list of other methods in alphabetical order:

• Coop-Cloud: code
• Nix: Packages, ⚠️ unstable
• Podman: [code][https://codeberg.org/philo/lasuite-docs-podman], ⚠️ experimental
• YunoHost: code, app store

Feel free to make a PR to add ones that are not listed above 🙏

Cloud providers

Some cloud providers are making it easy to deploy Docs on their infrastructure.

Here is the list in alphabetical order:

• Clever Cloud 🇫🇷 : [market place][https://www.clever-cloud.com/product/docs/], technical doc

Feel free to make a PR to add ones that are not listed above 🙏