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

Merge branch 'version-2' of https://github.com/YunoHost-Apps/outline_ynh into version-2

Browse source
This commit is contained in:
Limezy 2023-10-03 00:03:07 +07:00
commit a95cebfc5b
2 changed files with 2 additions and 44 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
README.md
View file

@ -25,7 +25,7 @@ The fastest wiki and knowledge base for growing teams. Beautiful, feature rich,
- Using Yunohost's built-in SMTP server for notifications
**Shipped version:** 0.72.0.3~ynh2
**Shipped version:** 0.72.0.3.4~ynh1
**Demo:** https://app.getoutline.com/create
@ -33,27 +33,6 @@ The fastest wiki and knowledge base for growing teams. Beautiful, feature rich,
![Screenshot of Outline](./doc/screenshots/outline_screenshot.png)
## Disclaimers / important information
### Not totally free licence
Outline is a softwared licenced under [BUSL 1.1 licence](https://spdx.org/licenses/BUSL-1.1.html).
⚠️ 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.0) will be released under Apache-2.0 licence [after May 23rd 2026](https://github.com/outline/outline/blob/151c2c731a94eefdda4e62f311308e9bd4615838/LICENSE).
### 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](https://github.com/YunoHost-apps/dex_ynh) to be installed (Dex installation and setup is automatic, though)
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 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
## :red_circle: Antifeatures
- **Not totally free upstream**: The packaged app is under an overall free licence, but with clauses that restrict its use.

23
README_fr.md
View file

@ -25,7 +25,7 @@ The fastest wiki and knowledge base for growing teams. Beautiful, feature rich,
- Using Yunohost's built-in SMTP server for notifications
**Version incluse :** 0.72.0.3~ynh2
**Version incluse :** 0.72.0.3.4~ynh1
**Démo :** https://app.getoutline.com/create
@ -33,27 +33,6 @@ The fastest wiki and knowledge base for growing teams. Beautiful, feature rich,
![Capture d’écran de Outline](./doc/screenshots/outline_screenshot.png)
## Avertissements / informations importantes
### Not totally free licence
Outline is a softwared licenced under [BUSL 1.1 licence](https://spdx.org/licenses/BUSL-1.1.html).
⚠️ 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.0) will be released under Apache-2.0 licence [after May 23rd 2026](https://github.com/outline/outline/blob/151c2c731a94eefdda4e62f311308e9bd4615838/LICENSE).
### 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](https://github.com/YunoHost-apps/dex_ynh) to be installed (Dex installation and setup is automatic, though)
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 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
## :red_circle: Fonctions indésirables
- **Not totally free upstream**: The packaged app is under an overall free licence, but with clauses that restrict its use.