1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/outline_ynh.git synced 2024-09-03 19:56:12 +02:00
outline_ynh/doc/DISCLAIMER.md

20 lines
1.4 KiB
Markdown
Raw Normal View History

2022-03-30 16:19:37 +02:00
### 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.
2022-05-25 11:24:13 +02:00
The Outline version shipped with this package (v0.64.3) will be released under Apache-2.0 licence [after May 23rd 2026](https://github.com/outline/outline/blob/151c2c731a94eefdda4e62f311308e9bd4615838/LICENSE).
2022-03-30 16:19:37 +02:00
2021-11-17 06:12:38 +01:00
### Known limitations
2022-04-18 18:18:28 +02:00
1. The app can now run in the CI server and reach level 7. 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 [MinIO app](https://github.com/YunoHost-apps/minio_ynh) to be installed (MinIO installation and setup is automatic, though)
3. The app requires [Dex app](https://github.com/YunoHost-apps/dex_ynh) to be installed (Dex installation and setup is automatic, though)
4. The app is requiring three domains including two fully dedicated (one for MinIO server, one for Dex, one for Outline)
5. ARM architectures are not yet supported (But it should be achievable soon)
6. Because it's built from sources, the app requires an important amount of RAM, disk and time to install properly
2021-11-17 06:12:38 +01:00
### How to create an admin user
2021-11-17 06:12:38 +01:00
The first user to login will automatically be granted admin rights
2022-03-31 15:27:47 +02:00
You can then change the user rights by default and/or change the admin user afterwards from the Outline settings page