mirror of
https://github.com/YunoHost-Apps/outline_ynh.git
synced 2024-09-03 19:56:12 +02:00
3.1 KiB
3.1 KiB
Outline wiki for YunoHost
This package allows you to install Outline wiki quickly and simply on a YunoHost server. If you don't have YunoHost, please consult the guide to learn how to install it.
Overview
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
Shipped version: 0.62.0~ynh1
Demo: https://app.getoutline.com/create
Screenshots
Disclaimers / important information
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 three domains including two fully dedicated (one for MinIO server, one for Dex, one for Outline)
- ARM architectures are not supported (and may never be as Outline was built for AMD64)
- 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
Documentation and resources
- Official app website: www.getoutline.com
- Official user documentation: https://www.getoutline.com/about
- Official admin documentation: https://www.getoutline.com/developers
- Upstream app code repository: https://github.com/outline/outline
- YunoHost documentation for this app: https://yunohost.org/app_outline
- Report a bug: https://github.com/YunoHost-Apps/outline_ynh/issues
Developer info
Please send your pull request to the testing branch.
To try the testing branch, please proceed like that.
sudo yunohost app install https://github.com/YunoHost-Apps/outline_ynh/tree/testing --debug
or
sudo yunohost app upgrade outline -u https://github.com/YunoHost-Apps/outline_ynh/tree/testing --debug
More info regarding app packaging: https://yunohost.org/packaging_apps