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

Merge branch 'master' into v0.72.1

This commit is contained in:
Limezy 2023-10-07 15:25:04 +07:00 committed by GitHub
commit b261b9037d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 40 additions and 41 deletions

View file

@ -5,7 +5,8 @@ It shall NOT be edited by hand.
# Outline for YunoHost # Outline for YunoHost
[![Integration level](https://dash.yunohost.org/integration/outline.svg)](https://dash.yunohost.org/appci/app/outline) ![Working status](https://ci-apps.yunohost.org/ci/badges/outline.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/outline.maintain.svg) [![Integration level](https://dash.yunohost.org/integration/outline.svg)](https://dash.yunohost.org/appci/app/outline) ![Working status](https://ci-apps.yunohost.org/ci/badges/outline.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/outline.maintain.svg)
[![Install Outline with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=outline) [![Install Outline with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=outline)
*[Lire ce readme en français.](./README_fr.md)* *[Lire ce readme en français.](./README_fr.md)*
@ -20,13 +21,11 @@ The fastest wiki and knowledge base for growing teams. Beautiful, feature rich,
### Features ### Features
- Fully working installation of Outline wiki - Fully working installation of Outline wiki
- Including a MinIO server for avatars and picture object storage
- Including a Dex server to connect to Yunohost's LDAP userbase using an OIDC auth flow - Including a Dex server to connect to Yunohost's LDAP userbase using an OIDC auth flow
- Using Yunohost's built-in SMTP server for notifications - Using Yunohost's built-in SMTP server for notifications
**Shipped version:** 0.66.0~ynh1 **Shipped version:** 0.72.0.3~ynh2
**Demo:** https://app.getoutline.com/create **Demo:** https://app.getoutline.com/create
@ -39,16 +38,15 @@ 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.65.2) will be released under Apache-2.0 licence [after May 23rd 2026](https://github.com/outline/outline/blob/151c2c731a94eefdda4e62f311308e9bd4615838/LICENSE). 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 ### Known limitations
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** 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 [MinIO app](https://github.com/YunoHost-apps/minio_ynh) to be installed (MinIO installation and setup is automatic, though) 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 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. 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. 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
6. 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
@ -56,13 +54,16 @@ The Outline version shipped with this package (v0.65.2) will be released under A
The first user to login will automatically be granted admin rights 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 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.
## Documentation and resources ## Documentation and resources
* Official app website: <www.getoutline.com> * Official app website: <https://www.getoutline.com>
* Official user documentation: <https://www.getoutline.com/about> * Official user documentation: <https://www.getoutline.com/about>
* Official admin documentation: <https://www.getoutline.com/developers> * Official admin documentation: <https://www.getoutline.com/developers>
* Upstream app code repository: <https://github.com/outline/outline> * Upstream app code repository: <https://github.com/outline/outline>
* YunoHost documentation for this app: <https://yunohost.org/app_outline>
* Report a bug: <https://github.com/YunoHost-Apps/outline_ynh/issues> * Report a bug: <https://github.com/YunoHost-Apps/outline_ynh/issues>
## Developer info ## Developer info

View file

@ -5,50 +5,48 @@ It shall NOT be edited by hand.
# Outline pour YunoHost # Outline pour YunoHost
[![Niveau d'intégration](https://dash.yunohost.org/integration/outline.svg)](https://dash.yunohost.org/appci/app/outline) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/outline.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/outline.maintain.svg) [![Niveau dintégration](https://dash.yunohost.org/integration/outline.svg)](https://dash.yunohost.org/appci/app/outline) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/outline.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/outline.maintain.svg)
[![Installer Outline avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=outline) [![Installer Outline avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=outline)
*[Read this readme in english.](./README.md)* *[Read this readme in english.](./README.md)*
> *Ce package vous permet d'installer Outline rapidement et simplement sur un serveur YunoHost. > *Ce package vous permet dinstaller Outline rapidement et simplement sur un serveur YunoHost.
Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.* Si vous navez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment linstaller et en profiter.*
## Vue d'ensemble ## Vue densemble
The fastest wiki and knowledge base for growing teams. Beautiful, feature rich, and markdown compatible. The fastest wiki and knowledge base for growing teams. Beautiful, feature rich, and markdown compatible.
### Features ### Features
- Fully working installation of Outline wiki - Fully working installation of Outline wiki
- Including a MinIO server for avatars and picture object storage
- Including a Dex server to connect to Yunohost's LDAP userbase using an OIDC auth flow - Including a Dex server to connect to Yunohost's LDAP userbase using an OIDC auth flow
- Using Yunohost's built-in SMTP server for notifications - Using Yunohost's built-in SMTP server for notifications
**Version incluse :** 0.66.0~ynh1 **Version incluse :** 0.72.0.3~ynh2
**Démo :** https://app.getoutline.com/create **Démo :** https://app.getoutline.com/create
## Captures d'écran ## Captures décran
![Capture d'écran de Outline](./doc/screenshots/outline_screenshot.png) ![Capture décran de Outline](./doc/screenshots/outline_screenshot.png)
## Avertissements / informations importantes ## Avertissements / informations importantes
### 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.65.2) will be released under Apache-2.0 licence [after May 23rd 2026](https://github.com/outline/outline/blob/151c2c731a94eefdda4e62f311308e9bd4615838/LICENSE). 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 ### Known limitations
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** 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 [MinIO app](https://github.com/YunoHost-apps/minio_ynh) to be installed (MinIO installation and setup is automatic, though) 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 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. 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. 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
6. 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
@ -56,13 +54,16 @@ The Outline version shipped with this package (v0.65.2) will be released under A
The first user to login will automatically be granted admin rights 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 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.
## Documentations et ressources ## Documentations et ressources
* Site officiel de l'app : <www.getoutline.com> * Site officiel de lapp : <https://www.getoutline.com>
* Documentation officielle utilisateur : <https://www.getoutline.com/about> * Documentation officielle utilisateur : <https://www.getoutline.com/about>
* Documentation officielle de l'admin : <https://www.getoutline.com/developers> * Documentation officielle de ladmin : <https://www.getoutline.com/developers>
* Dépôt de code officiel de l'app : <https://github.com/outline/outline> * Dépôt de code officiel de lapp : <https://github.com/outline/outline>
* Documentation YunoHost pour cette app : <https://yunohost.org/app_outline>
* Signaler un bug : <https://github.com/YunoHost-Apps/outline_ynh/issues> * Signaler un bug : <https://github.com/YunoHost-Apps/outline_ynh/issues>
## Informations pour les développeurs ## Informations pour les développeurs
@ -77,4 +78,4 @@ ou
sudo yunohost app upgrade outline -u https://github.com/YunoHost-Apps/outline_ynh/tree/testing --debug sudo yunohost app upgrade outline -u https://github.com/YunoHost-Apps/outline_ynh/tree/testing --debug
``` ```
**Plus d'infos sur le packaging d'applications :** <https://yunohost.org/packaging_apps> **Plus dinfos sur le packaging dapplications :** <https://yunohost.org/packaging_apps>

View file

@ -8,9 +8,6 @@
language="fr" language="fr"
dex_domain="dex.domain.tld" dex_domain="dex.domain.tld"
dex_path="/example" dex_path="/example"
minio_domain="minio.domain.tld"
minio_admin="package_checker"
minio_password="1Strong-Password"
; Checks ; Checks
pkg_linter=1 pkg_linter=1
setup_sub_dir=1 setup_sub_dir=1
@ -19,7 +16,7 @@
setup_private=1 setup_private=1
setup_public=1 setup_public=1
upgrade=1 upgrade=1
#upgrade=1 from_commit=CommitHash #upgrade=1 from_commit=f56cd7d
backup_restore=1 backup_restore=1
multi_instance=0 multi_instance=0
change_url=0 change_url=0
@ -27,6 +24,6 @@
Email= Email=
Notification=none Notification=none
;;; Upgrade options ;;; Upgrade options
; commit=CommitHash ; commit=f56cd7d
name=Name and date of the commit. name=Name and date of the commit.
manifest_arg=domain=DOMAIN&path=PATH&admin=USER&language=fr&is_public=1&password=pass&port=666& manifest_arg=domain=DOMAIN&path=PATH&admin=USER&language=fr&is_public=1&password=pass&port=666&

View file

@ -10,7 +10,7 @@
"url": "www.getoutline.com", "url": "www.getoutline.com",
"upstream": { "upstream": {
"license": "BUSL-1.1", "license": "BUSL-1.1",
"website": "www.getoutline.com", "website": "https://www.getoutline.com",
"demo": "https://app.getoutline.com/create", "demo": "https://app.getoutline.com/create",
"admindoc": "https://www.getoutline.com/developers", "admindoc": "https://www.getoutline.com/developers",
"userdoc": "https://www.getoutline.com/about", "userdoc": "https://www.getoutline.com/about",

View file

@ -104,7 +104,7 @@ ynh_script_progression --message="Restoring the app local storage..." --weight=1
ynh_restore_file --origin_path="/var/lib/outline" ynh_restore_file --origin_path="/var/lib/outline"
chmod -R 750 "/var/lib/outline" chmod -R o-rwx "/var/lib/outline"
chown -R $app:www-data "/var/lib/outline" chown -R $app:www-data "/var/lib/outline"
#================================================= #=================================================