This repository has been archived on 2026-03-24. You can view files and clone it. You cannot open issues or pull requests or push a commit.
Files
docs/docs/installation/README.md
virgile-dev 4ab9edcd57 📝(doc) update readme and add community installation methods (#1292)
## Purpose

To showcase the work of the community to make docs deployment easier


## Proposal

- [x] Added README.md in /docs/installation with methods contributed by
the community
- [x] Added a list of public instances on the main README.md
- [x] Updated the warnings around Blocknote XL packages from AGPL to GPL

Please ensure the following items are checked before submitting your
pull request:
- [x] I have read and followed the [contributing
guidelines](https://github.com/suitenumerique/docs/blob/main/CONTRIBUTING.md)
- [x] I have read and agreed to the [Code of
Conduct](https://github.com/suitenumerique/docs/blob/main/CODE_OF_CONDUCT.md)
- [x] I have signed off my commits with `git commit --signoff` (DCO
compliance)
- [x] I have signed my commits with my SSH or GPG key (`git commit -S`)
- [x] My commit messages follow the required format: `<gitmoji>(type)
title description`
- [ ] I have added a changelog entry under `## [Unreleased]` section (if
noticeable change)
- [ ] I have added corresponding tests for new features or bug fixes (if
applicable)

---------

Signed-off-by: virgile-dev <virgile.deville@beta.gouv.fr>
2025-08-26 16:03:39 +03:00

2.1 KiB

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.

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.

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 two 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:

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:

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