mirror of
https://github.com/YunoHost-Apps/outline_ynh.git
synced 2024-09-03 19:56:12 +02:00
84 lines
No EOL
4.1 KiB
Markdown
84 lines
No EOL
4.1 KiB
Markdown
<!--
|
||
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
|
||
It shall NOT be edited by hand.
|
||
-->
|
||
|
||
# Outline pour YunoHost
|
||
|
||
[](https://dash.yunohost.org/appci/app/outline)  
|
||
|
||
[](https://install-app.yunohost.org/?app=outline)
|
||
|
||
*[Read this readme in english.](./README.md)*
|
||
|
||
> *Ce package vous permet d’installer Outline rapidement et simplement sur un serveur YunoHost.
|
||
Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l’installer et en profiter.*
|
||
|
||
## Vue d’ensemble
|
||
|
||
The fastest wiki and knowledge base for growing teams. Beautiful, feature rich, and markdown compatible.
|
||
|
||
### Features
|
||
|
||
- Fully working installation of Outline wiki
|
||
- Including a MinIO server for avatars and picture object storage
|
||
- 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
|
||
|
||
|
||
**Version incluse :** 0.68.0.4~ynh1
|
||
|
||
**Démo :** https://app.getoutline.com/create
|
||
|
||
## 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.68.0) will be released under Apache-2.0 licence [after May 23rd 2026](https://github.com/outline/outline/blob/151c2c731a94eefdda4e62f311308e9bd4615838/LICENSE).
|
||
|
||
### Known limitations
|
||
|
||
1. The app can now run in the CI server and reach level 7. 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 [MinIO app](https://github.com/YunoHost-apps/minio_ynh) to be installed (MinIO installation and setup is automatic, though)
|
||
3. The app requires [Dex app](https://github.com/YunoHost-apps/dex_ynh) to be installed (Dex installation and setup is automatic, though)
|
||
4. The app is requiring three domains including two fully dedicated (one for MinIO server, one for Dex, one for Outline)
|
||
5. ARM architectures are not yet supported (But it should be achievable soon)
|
||
6. 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
|
||
|
||
- **Not totally free upstream**: The packaged app is under an overall free licence, but with clauses that restrict its use.
|
||
|
||
## Documentations et ressources
|
||
|
||
* Site officiel de l’app : <https://www.getoutline.com>
|
||
* Documentation officielle utilisateur : <https://www.getoutline.com/about>
|
||
* Documentation officielle de l’admin : <https://www.getoutline.com/developers>
|
||
* Dépôt de code officiel de l’app : <https://github.com/outline/outline>
|
||
* Documentation YunoHost pour cette app : <https://yunohost.org/app_outline>
|
||
* Signaler un bug : <https://github.com/YunoHost-Apps/outline_ynh/issues>
|
||
|
||
## Informations pour les développeurs
|
||
|
||
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/outline_ynh/tree/testing).
|
||
|
||
Pour essayer la branche testing, procédez comme suit.
|
||
|
||
``` bash
|
||
sudo yunohost app install https://github.com/YunoHost-Apps/outline_ynh/tree/testing --debug
|
||
ou
|
||
sudo yunohost app upgrade outline -u https://github.com/YunoHost-Apps/outline_ynh/tree/testing --debug
|
||
```
|
||
|
||
**Plus d’infos sur le packaging d’applications :** <https://yunohost.org/packaging_apps> |