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-04-18 17:28:28 +00:00
parent 8c4a468e25
commit 5ffb60aa3a
2 changed files with 16 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
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 - Using Yunohost's built-in SMTP server for notifications
**Shipped version:** 0.63.0~ynh1 **Shipped version:** 0.63.0~ynh2
**Demo:** https://app.getoutline.com/create **Demo:** https://app.getoutline.com/create
@ -38,17 +38,16 @@ The fastest wiki and knowledge base for growing teams. Beautiful, feature rich,
### Not totally free licence ### Not totally free licence
Outline is a softwared licenced under [BUSL 1.1 licence](https://spdx.org/licenses/BUSL-1.1.html). 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. ⚠️ 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.62.0) will be released under Apache-2.0 licence [after March 1st 2026](https://github.com/outline/outline/blob/7216551164536e8abddfabc95b785ef5f8d51de7/LICENSE). The Outline version shipped with this package (v0.63.0) will be released under Apache-2.0 licence [after April 15th 2026](https://github.com/outline/outline/blob/1a8f2c3bb08df1ac3fa9cea5a2a7491757b7cf28/LICENSE).
### Known limitations ### Known limitations
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 yet on a prod server** 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. For some technical reasons I'm still trying to understand, related to [Dex app](https://github.com/YunoHost-apps/dex_ynh), the app can't be installed through the web UI yet. You need to run the installation command from the command line : `sudo yunohost app install https://github.com/YunoHost-apps/outline_ynh` 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 [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 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. 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. 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
7. 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 ### How to create an admin user

17
README_fr.md
View file

@ -21,7 +21,7 @@ The fastest wiki and knowledge base for growing teams. Beautiful, feature rich,
- Using Yunohost's built-in SMTP server for notifications - Using Yunohost's built-in SMTP server for notifications
**Version incluse :** 0.63.0~ynh1 **Version incluse :** 0.63.0~ynh2
**Démo :** https://app.getoutline.com/create **Démo :** https://app.getoutline.com/create
@ -34,17 +34,16 @@ The fastest wiki and knowledge base for growing teams. Beautiful, feature rich,
### Not totally free licence ### Not totally free licence
Outline is a softwared licenced under [BUSL 1.1 licence](https://spdx.org/licenses/BUSL-1.1.html). 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. ⚠️ 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.62.0) will be released under Apache-2.0 licence [after March 1st 2026](https://github.com/outline/outline/blob/7216551164536e8abddfabc95b785ef5f8d51de7/LICENSE). The Outline version shipped with this package (v0.63.0) will be released under Apache-2.0 licence [after April 15th 2026](https://github.com/outline/outline/blob/1a8f2c3bb08df1ac3fa9cea5a2a7491757b7cf28/LICENSE).
### Known limitations ### Known limitations
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 yet on a prod server** 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. For some technical reasons I'm still trying to understand, related to [Dex app](https://github.com/YunoHost-apps/dex_ynh), the app can't be installed through the web UI yet. You need to run the installation command from the command line : `sudo yunohost app install https://github.com/YunoHost-apps/outline_ynh` 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 [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 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. 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. 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
7. 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 ### How to create an admin user