outline_ynh/doc/ADMIN.md

### 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.73.1) will be released under Apache-2.0 licence [after August 18th 2027](https://github.com/outline/outline/blob/ebeb201a9f48e2c6b619a0d152e051946849aa10/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 two domains including one fully dedicated (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
Update DISCLAIMER.md 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.`
Test upgrade 0.73.1 2023-11-26 17:35:30 +01:00			`The Outline version shipped with this package (v0.73.1) will be released under Apache-2.0 licence [after August 18th 2027](https://github.com/outline/outline/blob/ebeb201a9f48e2c6b619a0d152e051946849aa10/LICENSE).`
Update DISCLAIMER.md 2022-03-30 16:19:37 +02:00
Notes to update readme 2021-11-17 06:12:38 +01:00			`### Known limitations`

Updates 2023-09-29 17:43:15 +02:00			`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)`
Other updates 2023-10-07 10:19:31 +02:00			`3. The app is requiring two domains including one fully dedicated (one for Dex, one for Outline)`
Updates 2023-09-29 17:43:15 +02:00			`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`
Notes to update readme 2021-11-17 06:12:38 +01:00

Setup LDAP auth for Outline through Dex app 2022-03-24 09:31:29 +01:00			`### How to create an admin user`
Notes to update readme 2021-11-17 06:12:38 +01:00
Setup LDAP auth for Outline through Dex app 2022-03-24 09:31:29 +01:00			`The first user to login will automatically be granted admin rights`
Update DISCLAIMER.md 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`