1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/outline_ynh.git synced 2024-09-03 19:56:12 +02:00
outline_ynh/README_fr.md

67 lines
3.1 KiB
Markdown
Raw Normal View History

2021-11-15 06:56:16 +01:00
# Outline wiki pour YunoHost
2021-11-11 04:24:15 +01:00
2021-11-15 06:56:16 +01:00
[![Niveau d'intégration](https://dash.yunohost.org/integration/outline.svg)](https://dash.yunohost.org/appci/app/outline) ![](https://ci-apps.yunohost.org/ci/badges/outline.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/outline.maintain.svg)
[![Installer Outline wiki avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=outline)
2021-09-21 00:25:53 +02:00
*[Read this readme in english.](./README.md)*
*[Lire ce readme en français.](./README_fr.md)*
2021-11-15 06:56:16 +01:00
> *Ce package vous permet d'installer Outline wiki 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.*
2021-09-21 00:25:53 +02:00
## Vue d'ensemble
2021-11-17 06:16:56 +01:00
The fastest wiki and knowledge base for growing teams. Beautiful, feature rich, and markdown compatible.
2021-09-21 00:25:53 +02:00
2021-11-15 06:56:16 +01:00
### Features
2021-09-21 00:25:53 +02:00
2021-11-17 06:16:56 +01:00
- Fully working installation of Outline wiki
- Including a MinIO server for avatars and picture object storage
2022-03-24 18:41:44 +01:00
- 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
2021-09-21 00:25:53 +02:00
2022-03-01 18:17:56 +01:00
**Version incluse :** 0.62.0~ynh1
2021-09-21 00:25:53 +02:00
2021-11-15 06:56:16 +01:00
**Démo :** https://app.getoutline.com/create
2021-09-21 00:25:53 +02:00
2021-11-17 06:16:56 +01:00
## Captures d'écran
![](./doc/screenshots/outline_screenshot.png)
2021-09-21 00:25:53 +02:00
## Avertissements / informations importantes
2021-11-17 06:16:56 +01:00
### Known limitations
2021-11-17 06:23:18 +01:00
1. Because this app can't yet run in the CI server, its integration level is unkonwn at the moment and standard Yunohost packages testing couldn't run yet. **Please don't use it on a prod server**
2. The app requires MinIO app to be installed (MinIO installation is automatic, though)
2022-03-24 16:26:12 +01:00
3. The app is requiring three domains including two fully dedicated (one for MinIO server, one for Dex, one for Outline)
2021-11-17 06:23:18 +01:00
4. ARM architectures are not supported (and may never be as Outline was built for AMD64)
6. Because it's built from sources, the app requires an important amount of RAM, disk and time to install properly
2021-11-17 06:16:56 +01:00
2022-03-24 16:26:12 +01:00
### How to create an admin user
2021-11-17 06:16:56 +01:00
2022-03-24 16:26:12 +01:00
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
2021-09-21 00:25:53 +02:00
## Documentations et ressources
2021-11-15 06:56:16 +01:00
* Site officiel de l'app : 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
2021-09-21 00:25:53 +02:00
## Informations pour les développeurs
2021-11-15 06:56:16 +01:00
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/outline_ynh/tree/testing).
2021-09-21 00:25:53 +02:00
Pour essayer la branche testing, procédez comme suit.
```
2021-11-15 06:56:16 +01:00
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
2021-09-21 00:25:53 +02:00
```
2021-11-15 06:56:16 +01:00
**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps