Merge pull request #149 from YunoHost-Apps/bullseye

Bullseye
2021-07-06 08:09:37 +02:00 · 2021-07-06 08:09:37 +02:00 · efc9dd3e13
commit efc9dd3e13
parent 5a0dcef89a 3fc125854f
13 changed files with 128 additions and 52 deletions
--- a/README.md
+++ b/README.md
@ -1,60 +1,54 @@
+<!--
+N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
+It shall NOT be edited by hand.
+-->
+
 # Wiki.js for YunoHost

 [![Integration level](https://dash.yunohost.org/integration/wikijs.svg)](https://dash.yunohost.org/appci/app/wikijs) ![](https://ci-apps.yunohost.org/ci/badges/wikijs.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/wikijs.maintain.svg)  
 [![Install Wiki.js with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=wikijs)

-> *This package allows you to install Wiki.js quickly and simply on a YunoHost server.  
+*[Lire ce readme en français.](./README_fr.md)*
+
+> *This package allows you to install Wiki.js quickly and simply on a YunoHost server.
 If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*

 ## Overview
-Wiki.js is a copylefted libre software, modern and powerful wiki app built on Node.js, Git and Markdown for YunoHost.

-**Shipped version:** 2.5.201
+Open source, modern and powerful wiki app built on Node.js, Git and Markdown.

-## Important points before installing
+**Shipped version:** 2.5.201~ynh3

-**Wiki.js** requires a dedicated **root domain**, e.g. wikijs.domain.tld
+**Demo:** https://docs-beta.requarks.io/

 ## Screenshots

-![wikijs-screenshot1](https://user-images.githubusercontent.com/30271971/52230053-b9ed3400-28b6-11e9-945e-355a752b8391.png)
+![](./doc/screenshots/screenshot2.png)
+![](./doc/screenshots/screenshot1.png)

-![wikijs-screenshot2](https://user-images.githubusercontent.com/30271971/52230062-beb1e800-28b6-11e9-99c1-2bd04857600e.png)
+## Disclaimers / important information

-## Demo
+* Any known limitations, constrains or stuff not working, such as (but not limited to):
+    * **Wiki.js** requires a dedicated **root domain**, e.g. wikijs.domain.tld
+    * LDAP is implemented, root will receive an e-mail at the end of the installation or the upgrade with the info on how to configure LDAP.
+    * No HTTP auth for now, but planned for the future.
+    * the app requires an important amount of RAM / disk / .. to install or to work properly
+    * etc...

-* [Official demo](https://docs-beta.requarks.io/)
+* Other infos that people should be aware of, such as:
+    * any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...)
+    * how to configure / administrate the application if it ain't obvious
+    * upgrade process / specificities / things to be aware of ?
+    * security considerations ?

-## Documentation
+## Documentation and resources

- * Official documentation: https://docs-beta.requarks.io/
- * YunoHost documentation: https://yunohost.org/en/app_wikijs
-
-## YunoHost specific features
-
-#### Multi-user support
-
-LDAP is implemented, root will receive an e-mail at the end of the installation or the upgrade with the info on how to configure LDAP.
-No HTTP auth for now, but planned for the future.
-The app can be used by multiple users.
-
-#### Supported architectures
-
-* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/wikijs.svg)](https://ci-apps.yunohost.org/ci/apps/wikijs/)
-* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/wikijs.svg)](https://ci-apps-arm.yunohost.org/ci/apps/wikijs/)
-
-## Limitations
-
-* No known limitations.
-
-## Links
-
- * Report a bug: https://github.com/YunoHost-Apps/wikijs_ynh/issues
- * App website: https://wiki.js.org/
- * Upstream app repository: https://github.com/Requarks/wiki
- * YunoHost website: https://yunohost.org/
-
---
+* Official app website: https://wiki.js.org/
+* Official user documentation: https://docs-beta.requarks.io/
+* Official admin documentation: https://yunohost.org/en/app_wikijs
+* Upstream app code repository: https://github.com/Requarks/wiki
+* YunoHost documentation for this app: https://yunohost.org/app_wikijs
+* Report a bug: https://github.com/YunoHost-Apps/wikijs_ynh/issues

 ## Developer info

@ -66,3 +60,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/wikijs_ynh/tree/testi
 or
 sudo yunohost app upgrade wikijs -u https://github.com/YunoHost-Apps/wikijs_ynh/tree/testing --debug
 ```
+
+**More info regarding app packaging:** https://yunohost.org/packaging_apps
--- a/README_fr.md
+++ b/README_fr.md
@ -0,0 +1,60 @@
+# Wiki.js pour YunoHost
+
+[![Niveau d'intégration](https://dash.yunohost.org/integration/wikijs.svg)](https://dash.yunohost.org/appci/app/wikijs) ![](https://ci-apps.yunohost.org/ci/badges/wikijs.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/wikijs.maintain.svg)  
+[![Installer Wiki.js avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=wikijs)
+
+*[Read this readme in english.](./README.md)*
+*[Lire ce readme en français.](./README_fr.md)*
+
+> *Ce package vous permet d'installer Wiki.js 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.*
+
+## Vue d'ensemble
+
+Wiki moderne et open source propulsé Node.js, Git et Markdown.
+
+**Version incluse :** 2.5.201~ynh3
+
+**Démo :** https://docs-beta.requarks.io/
+
+## Captures d'écran
+
+![](./doc/screenshots/screenshot2.png)
+![](./doc/screenshots/screenshot1.png)
+
+## Avertissements / informations importantes
+
+* Any known limitations, constrains or stuff not working, such as (but not limited to):
+    * **Wiki.js** requires a dedicated **root domain**, e.g. wikijs.domain.tld
+    * LDAP is implemented, root will receive an e-mail at the end of the installation or the upgrade with the info on how to configure LDAP.
+    * No HTTP auth for now, but planned for the future.
+    * the app requires an important amount of RAM / disk / .. to install or to work properly
+    * etc...
+
+* Other infos that people should be aware of, such as:
+    * any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...)
+    * how to configure / administrate the application if it ain't obvious
+    * upgrade process / specificities / things to be aware of ?
+    * security considerations ?
+
+## Documentations et ressources
+
+* Site officiel de l'app : https://wiki.js.org/
+* Documentation officielle utilisateur : https://docs-beta.requarks.io/
+* Documentation officielle de l'admin : https://yunohost.org/en/app_wikijs
+* Dépôt de code officiel de l'app : https://github.com/Requarks/wiki
+* Documentation YunoHost pour cette app : https://yunohost.org/app_wikijs
+* Signaler un bug : https://github.com/YunoHost-Apps/wikijs_ynh/issues
+
+## Informations pour les développeurs
+
+Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/wikijs_ynh/tree/testing).
+
+Pour essayer la branche testing, procédez comme suit.
+```
+sudo yunohost app install https://github.com/YunoHost-Apps/wikijs_ynh/tree/testing --debug
+ou
+sudo yunohost app upgrade wikijs -u https://github.com/YunoHost-Apps/wikijs_ynh/tree/testing --debug
+```
+
+**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps
--- a/6
+++ b/6
@ -1,10 +1,10 @@
 ;; Test complet
 	; Manifest
-		domain="domain.tld"	(DOMAIN)
-		is_public=1	(PUBLIC|public=1|private=0)
+		domain="domain.tld"
+		is_public=1
 	; Checks
 		pkg_linter=1
-		setup_sub_dir=0
+		setup_sub_dir=1
 		setup_root=1
 		setup_nourl=0
 		setup_private=1
--- a/doc/.gitkeep
+++ b/doc/.gitkeep
--- a/doc/DISCLAIMER.md
+++ b/doc/DISCLAIMER.md
@ -0,0 +1,12 @@
+* Any known limitations, constrains or stuff not working, such as (but not limited to):
+    * **Wiki.js** requires a dedicated **root domain**, e.g. wikijs.domain.tld
+    * LDAP is implemented, root will receive an e-mail at the end of the installation or the upgrade with the info on how to configure LDAP.
+    * No HTTP auth for now, but planned for the future.
+    * the app requires an important amount of RAM / disk / .. to install or to work properly
+    * etc...
+
+* Other infos that people should be aware of, such as:
+    * any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...)
+    * how to configure / administrate the application if it ain't obvious
+    * upgrade process / specificities / things to be aware of ?
+    * security considerations ?
--- a/doc/screenshots/.gitkeep
+++ b/doc/screenshots/.gitkeep
--- a/doc/screenshots/screenshot1.png
+++ b/doc/screenshots/screenshot1.png
--- a/doc/screenshots/screenshot2.png
+++ b/doc/screenshots/screenshot2.png
--- a/manifest.json
+++ b/manifest.json
@ -8,6 +8,14 @@
    },
    "version": "2.5.201~ynh3",
    "url": "https://wiki.js.org/",
+    "upstream": {
+        "license": "AGPL-3.0-or-later",
+        "website": "https://wiki.js.org/",
+        "demo": "https://docs-beta.requarks.io/",
+        "admindoc": "https://yunohost.org/en/app_wikijs",
+        "userdoc": "https://docs-beta.requarks.io/",
+        "code": "https://github.com/Requarks/wiki"
+    },
    "license": "AGPL-3.0-or-later",
    "maintainer": {
        "name": "yalh76"
--- a/scripts/backup
+++ b/scripts/backup
@ -15,7 +15,7 @@ source /usr/share/yunohost/helpers
 #=================================================

 ynh_clean_setup () {
-	ynh_clean_check_starting
+	true
 }
 # Exit if an error occurs during the execution of the script
 ynh_abort_if_errors
--- a/scripts/install
+++ b/scripts/install
@ -70,9 +70,9 @@ ynh_app_setting_set --app=$app --key=port --value=$port
 #=================================================
 ynh_script_progression --message="Installing dependencies..."

+ynh_install_app_dependencies $pkg_dependencies
 ynh_install_nodejs --nodejs_version=$NODEJS_VERSION
 ynh_use_nodejs
-ynh_install_app_dependencies $pkg_dependencies

 #=================================================
 # CREATE DEDICATED USER
@ -80,7 +80,7 @@ ynh_install_app_dependencies $pkg_dependencies
 ynh_script_progression --message="Configuring system user..."

 # Create a system user
-ynh_system_user_create --username=$app --home_dir="$final_path"
+ynh_system_user_create --username=$app --home_dir=$final_path

 #=================================================
 # CREATE A POSTGRESQL DATABASE
@ -124,7 +124,7 @@ ynh_add_nginx_config
 #=================================================
 ynh_script_progression --message="Creating LDAP user..."

-yunohost user create $ldap_user --firstname "SvcWikijsLdap" --lastname "SvcWikijsLdap" --mail ${ldap_user}@$domain --password $ldap_password -q 0
+yunohost user create $ldap_user --firstname "SvcWikijsLdap" --lastname "SvcWikijsLdap" --domain $domain --password $ldap_password -q 0

 #=================================================
 # ADD A CONFIGURATION
--- a/scripts/restore
+++ b/scripts/restore
@ -51,7 +51,7 @@ test ! -d $final_path \
 #=================================================
 # RESTORE THE NGINX CONFIGURATION
 #=================================================
-ynh_script_progression --message="Restoring the NGINX configuration..."
+ynh_script_progression --message="Restoring the NGINX web server configuration..."

 ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf"

@ -61,7 +61,7 @@ ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf"
 ynh_script_progression --message="Recreating the dedicated system user..."

 # Create the dedicated user (if not existing)
-ynh_system_user_create --username=$app --home_dir="$final_path"
+ynh_system_user_create --username=$app --home_dir=$final_path

 #=================================================
 # RESTORE THE APP MAIN DIR
@ -82,9 +82,9 @@ chown -R $app:$app "$final_path"
 ynh_script_progression --message="Reinstalling dependencies..."

 # Define and install dependencies
+ynh_install_app_dependencies $pkg_dependencies
 ynh_install_nodejs --nodejs_version=$NODEJS_VERSION
 ynh_use_nodejs
-ynh_install_app_dependencies $pkg_dependencies

 #=================================================
 # RESTORE THE POSTGRESQL DATABASE
@ -123,7 +123,7 @@ ynh_systemd_action --service_name=$app --action="start" --log_path=systemd --lin
 #=================================================
 ynh_script_progression --message="Creating LDAP user..."

-yunohost user create $ldap_user --firstname "SvcWikijsLdap" --lastname "SvcWikijsLdap" --mail ${ldap_user}@$domain --password $ldap_password -q 0
+yunohost user create $ldap_user --firstname "SvcWikijsLdap" --lastname "SvcWikijsLdap" --domain $domain --password $ldap_password -q 0

 #=================================================
 # GENERIC FINALIZATION
--- a/scripts/upgrade
+++ b/scripts/upgrade
@ -67,7 +67,7 @@ if [[ -z "$ldap_user" ]]; then
 	ldap_password=$(ynh_string_random --length=8)
 	ynh_app_setting_set "$app" ldap_user "$ldap_user"
 	ynh_app_setting_set "$app" ldap_password "$ldap_password"
-	yunohost user create $ldap_user --firstname "SvcWikijsLdap" --lastname "SvcWikijsLdap" --mail ${ldap_user}@$domain --password $ldap_password -q 0
+	yunohost user create $ldap_user --firstname "SvcWikijsLdap" --lastname "SvcWikijsLdap" --domain $domain --password $ldap_password -q 0
 fi

 # Cleaning legacy permissions
@ -103,7 +103,7 @@ fi
 ynh_script_progression --message="Making sure dedicated system user exists..."

 # Create a dedicated user (if not existing)
-ynh_system_user_create --username=$app --home_dir="$final_path"
+ynh_system_user_create --username=$app --home_dir=$final_path

 #=================================================
 # DOWNLOAD, CHECK AND UNPACK SOURCE
@ -154,9 +154,9 @@ ynh_add_nginx_config
 #=================================================
 ynh_script_progression --message="Upgrading dependencies..."

+ynh_install_app_dependencies $pkg_dependencies
 ynh_install_nodejs --nodejs_version=$NODEJS_VERSION
 ynh_use_nodejs
-ynh_install_app_dependencies $pkg_dependencies

 #=================================================
 # SPECIFIC UPGRADE