From f050b44f768c41684c46de8cf727e7346d17ca87 Mon Sep 17 00:00:00 2001 From: virgile-dev Date: Tue, 19 Aug 2025 18:06:56 +0200 Subject: [PATCH 1/2] =?UTF-8?q?=F0=9F=93=9D(doc)=20add=20community=20insta?= =?UTF-8?q?llation=20methods?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit To showcase the work of the community to make docs deployment easier Signed-off-by: virgile-dev --- README.md | 20 ++++++++++++++++---- docs/installation/README.md | 32 ++++++++++++++++++++++++++++++++ 2 files changed, 48 insertions(+), 4 deletions(-) create mode 100644 docs/installation/README.md diff --git a/README.md b/README.md index 72baa7f31b..cd427766ca 100644 --- a/README.md +++ b/README.md @@ -49,13 +49,25 @@ Docs is a collaborative text editor designed to address common challenges in kno * ๐Ÿ“š Turn your team's collaborative work into organized knowledge with Subpages. ### Self-host -๐Ÿš€ Docs is easy to install on your own servers -Available methods: Helm chart, Nix package +#### ๐Ÿš€ Docs is easy to install on your own servers +We use Kubernetes for our [production instance](https://docs.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. -In the works: Docker Compose, YunoHost +#### ๐ŸŒ Known instances +We hope to see many more, here is an incomplete list of public Docs instances (urls listed in alphabetical order). Feel free to make a PR to add ones that are not listed below๐Ÿ™ + +| | | | +| --- | --- | ------- | +| Url | Org | Public | +| docs.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| +| docs.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| +| notes.demo.opendesk.eu | ZenDiS | Demo instance of OpenDesk. Request access to get credentials | +| notes.liiib.re | lasuite.coop | Free and open demo to all. Content and acocunts are reset after one month | -โš ๏ธ For some advanced features (ex: Export as PDF) Docs relies on XL packages from BlockNote. These are licenced under AGPL-3.0 and are not MIT compatible. You can perfectly use Docs without these packages by setting the environment variable `PUBLISH_AS_MIT` to true. That way you'll build an image of the application without the features that are not MIT compatible. Read the [environment variables documentation](/docs/env.md) for more information. + + +#### โš ๏ธ Advanced features +For some advanced features (ex: Export as PDF) Docs relies on XL packages from BlockNote. These are licenced under AGPL-3.0 and are not MIT compatible. You can perfectly use Docs without these packages by setting the environment variable `PUBLISH_AS_MIT` to true. That way you'll build an image of the application without the features that are not MIT compatible. Read the [environment variables documentation](/docs/env.md) for more information. ## Getting started ๐Ÿ”ง diff --git a/docs/installation/README.md b/docs/installation/README.md new file mode 100644 index 0000000000..9d8b1e17f7 --- /dev/null +++ b/docs/installation/README.md @@ -0,0 +1,32 @@ +# 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](/docs/installation/kubernetes.md). + +## Docker Compose +We are aware that not everyone has Kubernetes Cluster laying around ๐Ÿ˜†. +We also provide [Docker images](https://hub.docker.com/u/lasuite?page=1&search=impress) that you can deploy using Compose. +Please follow the instructions [here](/docs/installation/compose.md). +โš ๏ธ 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: +- Coop-Cloud: [code](https://git.coopcloud.tech/coop-cloud/lasuite-docs) +- Nix: [Packages](https://search.nixos.org/packages?channel=unstable&query=lasuite-docs), โš ๏ธ unstable +- Podman: [code][https://codeberg.org/philo/lasuite-docs-podman], โš ๏ธ experimental +- YunoHost: [code](https://github.com/YunoHost-Apps/lasuite-docs_ynh), [app store](https://apps.yunohost.org/app/lasuite-docs) + +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](https://www.clever.cloud/developers/guides/docs/#deploy-docs) + +Feel free to make a PR to add ones that are not listed above ๐Ÿ™ \ No newline at end of file From 43d57f2ffe46617da96ffe5b279b8f62df2ee5a9 Mon Sep 17 00:00:00 2001 From: virgile-dev Date: Thu, 21 Aug 2025 17:20:42 +0200 Subject: [PATCH 2/2] =?UTF-8?q?=F0=9F=93=9D(doc)=20update=20AGPL=20warning?= =?UTF-8?q?=20to=20GPL?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit XL packages from BlockNote licence changed to GPL Signed-off-by: virgile-dev --- README.md | 6 ++---- docs/env.md | 6 +++--- 2 files changed, 5 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index cd427766ca..c772d37442 100644 --- a/README.md +++ b/README.md @@ -62,12 +62,10 @@ We hope to see many more, here is an incomplete list of public Docs instances (u | docs.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| | docs.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| | notes.demo.opendesk.eu | ZenDiS | Demo instance of OpenDesk. Request access to get credentials | -| notes.liiib.re | lasuite.coop | Free and open demo to all. Content and acocunts are reset after one month | - - +| notes.liiib.re | lasuite.coop | Free and open demo to all. Content and accounts are reset after one month | #### โš ๏ธ Advanced features -For some advanced features (ex: Export as PDF) Docs relies on XL packages from BlockNote. These are licenced under AGPL-3.0 and are not MIT compatible. You can perfectly use Docs without these packages by setting the environment variable `PUBLISH_AS_MIT` to true. That way you'll build an image of the application without the features that are not MIT compatible. Read the [environment variables documentation](/docs/env.md) for more information. +For some advanced features (ex: Export as PDF) Docs relies on XL packages from BlockNote. These are licenced under GPL and are not MIT compatible. You can perfectly use Docs without these packages by setting the environment variable `PUBLISH_AS_MIT` to true. That way you'll build an image of the application without the features that are not MIT compatible. Read the [environment variables documentation](/docs/env.md) for more information. ## Getting started ๐Ÿ”ง diff --git a/docs/env.md b/docs/env.md index ebb48215ef..0b3f9b3bf6 100644 --- a/docs/env.md +++ b/docs/env.md @@ -135,9 +135,9 @@ NODE_ENV=production NEXT_PUBLIC_PUBLISH_AS_MIT=false yarn build | PUBLISH_AS_MIT | Removes packages whose licences are incompatible with the MIT licence (see below) | true | Packages with licences incompatible with the MIT licence: -* `xl-docx-exporter`: [AGPL-3.0](https://github.com/TypeCellOS/BlockNote/blob/main/packages/xl-docx-exporter/LICENSE), -* `xl-pdf-exporter`: [AGPL-3.0](https://github.com/TypeCellOS/BlockNote/blob/main/packages/xl-pdf-exporter/LICENSE), -* `xl-multi-column`: [AGPL-3.0](https://github.com/TypeCellOS/BlockNote/blob/main/packages/xl-multi-column/LICENSE). +* `xl-docx-exporter`: [GPL](https://github.com/TypeCellOS/BlockNote/blob/main/packages/xl-docx-exporter/LICENSE), +* `xl-pdf-exporter`: [GPL](https://github.com/TypeCellOS/BlockNote/blob/main/packages/xl-pdf-exporter/LICENSE), +* `xl-multi-column`: [GPL](https://github.com/TypeCellOS/BlockNote/blob/main/packages/xl-multi-column/LICENSE). In `.env.development`, `PUBLISH_AS_MIT` is set to `false`, allowing developers to test Docs with all its features.