YunoHost-Apps/outline_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/outline_ynh.git synced 2024-09-03 19:56:12 +02:00
Code Issues Activity Actions
An open, extensible, wiki for your team built using React and Node.js
219 commits 8 branches 12 tags 2.3 MiB
Shell 100%
Find a file
Limezy e69f37f6fc Cover the dex path /example case
2022-04-01 21:42:10 +07:00
.github Initial commit 2021-09-21 04:55:53 +06:30
conf Cover the dex path /example case 2022-04-01 21:42:10 +07:00
doc Update DISCLAIMER.md 2022-03-31 20:27:47 +07:00
scripts Cover the dex path /example case 2022-04-01 21:42:10 +07:00
sources Update app-01-branding.patch 2022-03-02 12:44:55 +07:00
.gitignore Remove .DS_Store 2021-11-09 14:42:41 +07:00
check_process Update check_process 2022-03-31 20:10:45 +07:00
LICENSE Create LICENSE 2021-09-21 06:35:08 +08:00
manifest.json Update manifest.json 2022-04-01 10:08:34 +07:00
README.md Auto-update README 2022-03-31 13:27:51 +00:00
README_fr.md Auto-update README 2022-03-31 13:27:51 +00:00

README.md

Outline wiki for YunoHost

Integration level
Install Outline wiki with YunoHost

Lire ce readme en français.

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~ynh2

Demo: https://app.getoutline.com/create

Screenshots

Disclaimers / important information

Not totally free licence

Outline is a softwared licenced under BUSL 1.1 licence. ⚠️ 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.62.0) will be released under Apache-2.0 licence after March 1st 2026.

Known limitations

  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 yet on a prod server
  2. For some technical reasons I'm still trying to understand, related to Dex app, the app can't be installed through the web UI yet. You need to run the installation command from the command line : sudo yunohost app install https://github.com/YunoHost-apps/outline_ynh
  3. The app requires MinIO app to be installed (MinIO installation and setup is automatic, though)
  4. The app requires Dex app to be installed (Dex installation and setup is automatic, though)
  5. The app is requiring three domains including two fully dedicated (one for MinIO server, one for Dex, one for Outline)
  6. ARM architectures are not yet supported (But it should be achievable soon)
  7. 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

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