mirror of
https://github.com/YunoHost-Apps/outline_ynh.git
synced 2024-09-03 19:56:12 +02:00
Auto-update README
This commit is contained in:
yunohost-bot
parent
48acaf4ff9
commit
0e61b3d690
2 changed files with 9 additions and 52 deletions
27
README.md
27
README.md
|
|
@ -16,12 +16,12 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in
|
|||
|
||||
## Overview
|
||||
|
||||
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
|
||||
|
||||
|
||||
|
|
@ -31,28 +31,7 @@ The fastest wiki and knowledge base for growing teams. Beautiful, feature rich,
|
|||
|
||||
## Screenshots
|
||||
|
||||
|
||||
|
||||
## Disclaimers / important information
|
||||
|
||||
### 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
|
||||
You can then change the user rights by default and/or change the admin user afterwards from the Outline settings page
|
||||
|
||||
|
||||
## :red_circle: Antifeatures
|
||||
|
||||
|
|
|
|||
34
README_fr.md
34
README_fr.md
|
|
@ -16,14 +16,13 @@ Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) po
|
|||
|
||||
## Vue d’ensemble
|
||||
|
||||
The fastest wiki and knowledge base for growing teams. Beautiful, feature rich, and markdown compatible.
|
||||
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.
|
||||
|
||||
### Features
|
||||
|
||||
- Fully working installation of Outline wiki
|
||||
- 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
|
||||
### 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
|
||||
|
||||
**Version incluse :** 0.74.0~ynh1
|
||||
|
||||
|
|
@ -31,28 +30,7 @@ The fastest wiki and knowledge base for growing teams. Beautiful, feature rich,
|
|||
|
||||
## Captures d’écran
|
||||
|
||||
|
||||
|
||||
## Avertissements / informations importantes
|
||||
|
||||
### 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
|
||||
You can then change the user rights by default and/or change the admin user afterwards from the Outline settings page
|
||||
|
||||
|
||||
## :red_circle: Fonctions indésirables
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue