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
167 commits 8 branches 12 tags 2.3 MiB
Shell 100%
Find a file
Limezy 6a2e19bf08 Removal of minio_id
2022-02-17 15:01:40 +07:00
.github Initial commit 2021-09-21 04:55:53 +06:30
conf Removal of minio_id 2022-02-17 15:01:40 +07:00
doc Update DISCLAIMER.md 2021-11-17 12:22:43 +07:00
scripts Removal of minio_id 2022-02-17 15:01:40 +07:00
sources Temporary remove patches 2022-02-17 12:11:48 +07:00
.gitignore Remove .DS_Store 2021-11-09 14:42:41 +07:00
check_process First test v0.61.1 2022-02-17 12:03:17 +07:00
LICENSE Create LICENSE 2021-09-21 06:35:08 +08:00
manifest.json First test v0.61.1 2022-02-17 12:03:17 +07:00
README.md First test v0.61.1 2022-02-17 12:03:17 +07:00
README_fr.md First test v0.61.1 2022-02-17 12:03:17 +07: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
  • Setup using Yunohost's built-in SMTP server for notifications

Shipped version: 0.61.1~ynh1

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

Screenshots

Disclaimers / important information

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 on a prod server
  2. The app requires MinIO app to be installed (MinIO installation is automatic, though)
  3. The app is requiring two full dedicated domains (one for MinIO server, one for Outline)
  4. ARM architectures are not supported (and may never be as Outline was built for AMD64)
  5. Not yet working Yunohost SSO integration (for now it requires a Slack account and Slack app - see below)
  6. 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 :

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

image

  1. 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
  2. Go to "Features" then "OAuth & Permissions"
  3. 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)

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