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

Auto-update README

Browse source
This commit is contained in:
yunohost-bot 2022-03-24 15:26:12 +00:00
parent acb754557f
commit 294d446de5
2 changed files with 8 additions and 28 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -38,25 +38,15 @@ The fastest wiki and knowledge base for growing teams. Beautiful, feature rich,
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)
3. The app is requiring three domains including two fully dedicated (one for MinIO server, one for Dex, 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"
### How to create an admin user
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](https://user-images.githubusercontent.com/24638389/134668089-3b1a73f2-dbca-47c4-8e57-1ee26d1c034a.png)
6. 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
7. Go to "Features" then "OAuth & Permissions"
8. 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)
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

18
README_fr.md
View file

@ -34,25 +34,15 @@ The fastest wiki and knowledge base for growing teams. Beautiful, feature rich,
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)
3. The app is requiring three domains including two fully dedicated (one for MinIO server, one for Dex, 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"
### How to create an admin user
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](https://user-images.githubusercontent.com/24638389/134668089-3b1a73f2-dbca-47c4-8e57-1ee26d1c034a.png)
6. 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
7. Go to "Features" then "OAuth & Permissions"
8. 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)
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
## Documentations et ressources
* Site officiel de l'app : www.getoutline.com