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
419 commits 8 branches 12 tags 2.2 MiB
Shell 100%
Find a file
Éric Gaspar 50380de400 v2
2023-10-09 12:14:47 +02:00
.github Initial commit 2021-09-21 04:55:53 +06:30
conf v2 2023-10-09 12:14:47 +02:00
doc Other updates 2023-10-07 15:19:31 +07:00
scripts v2 2023-10-09 12:14:47 +02:00
sources Update for public version 2023-10-07 15:22:25 +07:00
.gitignore Remove .DS_Store 2021-11-09 14:42:41 +07:00
check_process Update check_process 2023-09-29 23:31:47 +07:00
LICENSE Create LICENSE 2021-09-21 06:35:08 +08:00
manifest.json Merge branch 'master' into v0.72.1 2023-10-07 15:25:04 +07:00
manifest.toml v2 2023-10-09 12:14:47 +02:00
README.md Auto-update README 2023-10-07 16:26:29 +00:00
README_fr.md Auto-update README 2023-10-07 16:26:29 +00:00

README.md

Outline for YunoHost

Integration level Working status Maintenance status

Install Outline with YunoHost

Lire ce readme en français.

This package allows you to install Outline 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 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.72.1~ynh1

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

Screenshots

Screenshot of Outline

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.72.1) will be released under Apache-2.0 licence after August 18th 2027.

Known limitations

  1. The app can now run in the CI server and reach level 8. 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 Dex app to be installed (Dex installation and setup is automatic, though)
  3. The app is requiring two domains including one fully dedicated (one for Dex, one for Outline)
  4. ARM architectures are not yet supported (But it should be achievable soon)
  5. 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

🔴 Antifeatures

  • Not totally free upstream: The packaged app is under an overall free licence, but with clauses that restrict its use.

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