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
112 commits 8 branches 12 tags 2.3 MiB
Shell 100%
Find a file
Limezy 7bf24b6e60 Updates
2021-11-12 23:44:18 +07:00
.github Initial commit 2021-09-21 04:55:53 +06:30
conf Updates 2021-11-12 23:23:47 +07:00
doc Update NOTES.md 2021-09-22 02:26:47 +02:00
scripts Updates 2021-11-12 23:44:18 +07:00
sources Delete app-02-branding.patch 2021-11-12 22:48:43 +07:00
.gitignore Remove .DS_Store 2021-11-09 14:42:41 +07:00
check_process Update check_process 2021-11-11 23:38:32 +07:00
LICENSE Create LICENSE 2021-09-21 06:35:08 +08:00
manifest.json Prompt for admin user 2021-11-12 23:20:30 +07:00
README.md Integration level in readme 2021-11-11 10:24:15 +07:00
README_fr.md Integration level in readme 2021-11-11 10:24:15 +07:00

README.md

Outline wiki for Yunohost

Integration level

110356468-26374600-7fef-11eb-9f6a-f2cc2c8c6590

Important points to read before installation

This is a Yunohost package

YunoHost is an operating system aiming to simplify as much as possible the administration of a server. You can visit yunohost.org or forum.yunohost.org for more information or help.

What you will need for installation

  • A testing Yunohost server (please don't install this on a production server yet!)
  • Two domains free of any apps (one for Outline, one for MinIO, an object storage server required by Outline)
  • A correctly configured "Slack app" and the value of its "Client ID" and "Signing Secret" (see below for details)

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)

How to launch installation

That app is not yet on the official Yunohost-Apps repo, so you'll need to follow the below steps :

  1. Log in your webadmin
  2. Go to Applications > Install
  3. Scroll to the bottom and copy paste `https://github.com/Limezy/outline_ynh/tree/v0.3 into the "Install custom app" box4.
  4. Fill in all fields and validate
  5. Be patient as the installation can take up to 15 minutes ! (There is package building involved)