Outline wiki pour YunoHost

Read this readme in english. Lire ce readme en français.

Ce package vous permet d'installer Outline wiki rapidement et simplement sur un serveur YunoHost. Si vous n'avez pas YunoHost, regardez ici 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
Setup using Yunohost's built-in SMTP server for notifications

Version incluse : 0.62.0~ynh1

Démo : https://app.getoutline.com/create

Captures d'écran

Avertissements / informations importantes

Known limitations

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
The app requires MinIO app to be installed (MinIO installation is automatic, though)
The app is requiring two full dedicated domains (one for MinIO server, one for Outline)
ARM architectures are not supported (and may never be as Outline was built for AMD64)
Not yet working Yunohost SSO integration (for now it requires a Slack account and Slack app - see below)
Because it's built from sources, the app requires an important amount of RAM, disk and time to install properly

How to create a "Slack app" and get your "Client ID" and "Signing Secret"

You should perform all below steps before starting the package installation on Yunohost :

Visit https://api.slack.com/apps
Sign in into a Slack workspace
Create a new app from scratch
Give it a name and associate it to your workspace

In the basic information tab, you'll find a "Client ID" and a "Signing Secret" - keep both as you'll need them to run the package installation
Go to "Features" then "OAuth & Permissions"
Add a new redirect URL. Use https://example.mydomain.fr/auth/slack.callback (assuming https://example.mydomain.fr is the domain on which you will install outline package)

Documentations et ressources

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

Informations pour les développeurs

Merci de faire vos pull request sur la branche testing.

Pour essayer la branche testing, procédez comme suit.

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

3.7 KiB Raw Blame History