diff --git a/doc/ADMIN.md b/doc/ADMIN.md index 8508257..08c5709 100644 --- a/doc/ADMIN.md +++ b/doc/ADMIN.md @@ -1,17 +1,3 @@ -### Not totally free licence -Outline is a softwared licenced under [BUSL 1.1 licence](https://spdx.org/licenses/BUSL-1.1.html). -⚠️ That licence **is not totally free**. Please read it very carefully if you have any commercial use in mind. -The Outline version shipped with this package (v0.73.1) will be released under Apache-2.0 licence [after August 18th 2027](https://github.com/outline/outline/blob/ebeb201a9f48e2c6b619a0d152e051946849aa10/LICENSE). - -### Known limitations - -1. The app can now run in the CI server and reach level 8. However, it is still very young and not broadly tested. **Please use it with extreme care if it's on a prod server** -2. The app requires [Dex app](https://github.com/YunoHost-apps/dex_ynh) to be installed (Dex installation and setup is automatic, though) -3. The app is requiring two domains including one fully dedicated (one for Dex, one for Outline) -4. ARM architectures are not yet supported (But it should be achievable soon) -5. Because it's built from sources, the app requires an important amount of RAM, disk and time to install properly - - ### How to create an admin user The first user to login will automatically be granted admin rights diff --git a/doc/DESCRIPTION.md b/doc/DESCRIPTION.md index 436faaf..d6c1700 100644 --- a/doc/DESCRIPTION.md +++ b/doc/DESCRIPTION.md @@ -1,7 +1,7 @@ -The fastest wiki and knowledge base for growing teams. Beautiful, feature rich, and markdown compatible. +Outline is a wiki and knowledge base for growing teams. Beautiful, feature rich, and markdown compatible. ### Features - Fully working installation of Outline wiki -- Including a Dex server to connect to Yunohost's LDAP userbase using an OIDC auth flow +- Including a Dex server to connect to YunoHost's LDAP userbase using an OIDC auth flow - Using Yunohost's built-in SMTP server for notifications diff --git a/doc/DESCRIPTION_fr.md b/doc/DESCRIPTION_fr.md new file mode 100644 index 0000000..17c049b --- /dev/null +++ b/doc/DESCRIPTION_fr.md @@ -0,0 +1,7 @@ +Outile est un wiki et la base de connaissances les plus rapides pour les équipes en pleine croissance. Beau, riche en fonctionnalités et compatible avec les démarques. + +### Caractéristiques + +- Installation entièrement fonctionnelle du wiki Outline +- Y compris un serveur Dex pour se connecter à la base d'utilisateurs LDAP de YunoHost à l'aide d'un flux d'authentification OIDC +- Utilisation du serveur SMTP intégré de Yunohost pour les notifications \ No newline at end of file diff --git a/doc/PRE_INSTALL.md b/doc/PRE_INSTALL.md new file mode 100644 index 0000000..724c20a --- /dev/null +++ b/doc/PRE_INSTALL.md @@ -0,0 +1,7 @@ +### Known limitations + +1. The app can now run in the CI server and reach level 8. However, it is still very young and not broadly tested. **Please use it with extreme care if it's on a prod server** +2. The app requires [Dex app](https://github.com/YunoHost-apps/dex_ynh) to be installed (Dex installation and setup is automatic, though) +3. The app is requiring two domains including one fully dedicated (one for Dex, one for Outline) +4. ARM architectures are not yet supported (But it should be achievable soon) +5. Because it's built from sources, the app requires an important amount of RAM, disk and time to install properly diff --git a/doc/PRE_INSTALL_fr.md b/doc/PRE_INSTALL_fr.md new file mode 100644 index 0000000..ac990c5 --- /dev/null +++ b/doc/PRE_INSTALL_fr.md @@ -0,0 +1,7 @@ +### Limites connues + +1. L'application peut désormais s'exécuter sur le serveur CI et atteindre le niveau 8. Cependant, elle est encore très jeune et n'a pas été largement testée. **Veuillez l'utiliser avec une extrême prudence s'il est sur un serveur de production** +2. L'application nécessite l'installation de [l'application Dex](https://github.com/YunoHost-apps/dex_ynh) (l'installation et la configuration de Dex sont cependant automatiques) +3. L'application nécessite deux domaines dont un entièrement dédié (un pour Dex, un pour Outline) +4. Les architectures ARM ne sont pas encore supportées (mais cela devrait être réalisable prochainement) +5. Parce qu'elle est construite à partir de sources, l'application nécessite une quantité importante de RAM, de disque et de temps pour s'installer correctement. \ No newline at end of file