Apply last example_ynh

README.md

@@ -1,79 +0,0 @@
-# vaultwarden for YunoHost
-
-[![Integration level](https://dash.yunohost.org/integration/vaultwarden.svg)](https://dash.yunohost.org/appci/app/vaultwarden) ![](https://ci-apps.yunohost.org/ci/badges/vaultwarden.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/vaultwarden.maintain.svg)  
-[![Install vaultwarden with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=vaultwarden)
-
-*[Lire ce readme en français.](./README_fr.md)*
-
-> *This package allows you to install vaultwarden 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
-vaultwarden is a open source password manager.
-
-**Shipped version:** 1.21.0
-
-## Important points to read before installing
-
-At the end of the installation, the admin user will receive a mail with the admin_token used to access https://your.domain.tld/vaultwarden/admin.
-
-## Screenshots
-
-![](https://bitwarden.com/images/hero.png)
-
-## Demo
-
-* [Official demo](https://vault.bitwarden.com/#/register)
-
-## Configuration
-
-How to configure this app: by an admin panel at https://vaultwarden.domain.tld/admin.
-
-## Documentation
-
- * Official documentation: https://help.bitwarden.com/ and https://github.com/dani-garcia/vaultwarden/wiki
-
-## YunoHost specific features
-
-#### Multi-user support
-
-* Are LDAP and HTTP auth supported? **No**
-* Can the app be used by multiple users? **Yes**
-
-#### Supported architectures
-
-* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/vaultwarden.svg)](https://ci-apps.yunohost.org/ci/apps/vaultwarden/)
-* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/vaultwarden.svg)](https://ci-apps-arm.yunohost.org/ci/apps/vaultwarden/)
-
-## Links
-
- * Report a bug: https://github.com/YunoHost-Apps/vaultwarden_ynh/issues
- * App website: https://bitwarden.com/
- * Upstream app repository: https://github.com/dani-garcia/vaultwarden
- * YunoHost website: https://yunohost.org/
-
-## Migrate from Bitwarden
-
-This package handle the migration from Bitwarden to Vaultwarden.
-For that, you will have to upgrade your Bitwarden application with this repository.
-This can only be done from the command-line interface - e.g. through SSH.
-Once you're connected, you simply have to execute the following:
-
-```bash
-sudo yunohost app upgrade bitwarden -u https://github.com/YunoHost-Apps/vaultwarden_ynh --debug
-```
-
-The `--debug` option will let you see the full output. If you encounter any issue, please paste it.
-
----
-
-## Developer info
-
-Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/vaultwarden_ynh/tree/testing).
-
-To try the testing branch, please proceed like that.
-```
-sudo yunohost app install https://github.com/YunoHost-Apps/vaultwarden_ynh/tree/testing --debug
-or
-sudo yunohost app upgrade vaultwarden -u https://github.com/YunoHost-Apps/vaultwarden_ynh/tree/testing --debug
-```

README_fr.md

@@ -1,66 +0,0 @@
-# vaultwarden pour YunoHost
-
-[![Niveau d'intégration](https://dash.yunohost.org/integration/vaultwarden.svg)](https://dash.yunohost.org/appci/app/vaultwarden) ![](https://ci-apps.yunohost.org/ci/badges/vaultwarden.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/vaultwarden.maintain.svg)  
-[![Installer vaultwarden avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=vaultwarden)
-
-*[Read this readme in english.](./README.md)* 
-
-> *Ce package vous permet d'installer vaultwarden rapidement et simplement sur un serveur YunoHost.  
-Si vous n'avez pas YunoHost, consultez [le guide](https://yunohost.org/#/install) pour apprendre comment l'installer.*
-
-## Vue d'ensemble
-vaultwarden est un gestionnaire de mots de passe open source.
-
-**Version incluse :** 1.21.0
-
-## Points importants à lire avant l'installation
-
-Après l'installation, l'utilisateur admin recevra un e-mail avec le admin_token à utiliser pour accéder à l'administration de vaultwarden https://your.domain.tld/vaultwarden/admin.
-
-## Captures d'écran
-
-![](https://bitwarden.com/images/hero.png)
-
-## Démo
-
-* [Démo officielle](https://vault.bitwarden.com/#/register)
-
-## Configuration
-
-Comment configurer cette application : via le panneau d'administration https://vaultwarden.domain.tld/admin.
-
-## Documentation
-
- * Documentation officielle : https://help.bitwarden.com/ et https://github.com/dani-garcia/vaultwarden/wiki
-
-## Caractéristiques spécifiques YunoHost
-
-#### Support multi-utilisateur
-
-* L'authentification LDAP et HTTP est-elle prise en charge? **Non**
-* L'application peut-elle être utilisée par plusieurs utilisateurs ? **Oui**
-
-#### Architectures supportées
-
-* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/vaultwarden.svg)](https://ci-apps.yunohost.org/ci/apps/vaultwarden/)
-* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/vaultwarden.svg)](https://ci-apps-arm.yunohost.org/ci/apps/vaultwarden/)
-
-## Liens
-
- * Signaler un bug : https://github.com/YunoHost-Apps/vaultwarden_ynh/issues
- * Site de l'application : https://bitwarden.com/
- * Dépôt de l'application principale : https://github.com/dani-garcia/vaultwarden
- * Site web YunoHost : https://yunohost.org/
-
----
-
-## Informations pour les développeurs
-
-Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/vaultwarden_ynh/tree/testing).
-
-Pour essayer la branche testing, procédez comme suit.
-```
-sudo yunohost app install https://github.com/YunoHost-Apps/vaultwarden_ynh/tree/testing --debug
-ou
-sudo yunohost app upgrade vaultwarden -u https://github.com/YunoHost-Apps/vaultwarden_ynh/tree/testing --debug
-```

doc/DISCLAIMER.md

@@ -0,0 +1,20 @@
+* Any known limitations, constrains or stuff not working, such as (but not limited to):
+    * single-sign on and LDAP integration are not-working
+    * installation took a lot of time
+
+* Other infos that people should be aware of, such as:
+    * At the end of the installation, the admin user will receive a mail with the admin_token used to access https://your.domain.tld/vaultwarden/admin.
+    * You can configure this app using the admin panel at https://vaultwarden.domain.tld/admin.
+
+## Migrate from Bitwarden
+
+This package handle the migration from Bitwarden to Vaultwarden.
+For that, you will have to upgrade your Bitwarden application with this repository.
+This can only be done from the command-line interface - e.g. through SSH.
+Once you're connected, you simply have to execute the following:
+
+```bash
+sudo yunohost app upgrade bitwarden -u https://github.com/YunoHost-Apps/vaultwarden_ynh --debug
+```
+
+The `--debug` option will let you see the full output. If you encounter any issue, please paste it.

manifest.json

@@ -8,6 +8,13 @@
     },
     "version": "1.21.0~ynh2",
     "url": "https://github.com/dani-garcia/vaultwarden",
+    "upstream": {
+        "license": "GPL-3.0-or-later",
+        "demo": "https://vault.bitwarden.com/#/register",
+        "admindoc": "https://github.com/dani-garcia/vaultwarden/wiki",
+        "userdoc": "https://help.bitwarden.com/",
+        "code": "https://github.com/dani-garcia/vaultwarden"
+    },
     "license": "GPL-3.0-or-later",
     "maintainer": {
         "name": "yalh76"

scripts/change_url

@@ -94,7 +94,7 @@ then
 	domain="$old_domain"
 	path_url="$new_path"
 	# Create a dedicated NGINX config
-	ynh_add_nginx_config "websocket_port rocket_port"
+	ynh_add_nginx_config
 fi
 
 # Change the domain for NGINX

scripts/install

@@ -83,7 +83,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
 
 #=================================================
 # DOWNLOAD, CHECK AND UNPACK SOURCE
@@ -108,7 +108,7 @@ chown -R $app:$app "$final_path"
 ynh_script_progression --message="Configuring NGINX web server..."
 
 # Create a dedicated NGINX config
-ynh_add_nginx_config "websocket_port rocket_port"
+ynh_add_nginx_config
 
 #=================================================
 # SPECIFIC SETUP

scripts/remove

@@ -75,7 +75,7 @@ ynh_remove_logrotate
 #=================================================
 # REMOVE FAIL2BAN CONFIGURATION
 #=================================================
-ynh_script_progression --message="Removing Fail2ban configuration..."
+ynh_script_progression --message="Removing Fail2Ban configuration..."
 
 # Remove the dedicated Fail2Ban config
 ynh_remove_fail2ban_config

scripts/restore

@@ -56,7 +56,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
@@ -78,8 +78,8 @@ ynh_script_progression --message="Restoring the Fail2Ban configuration..."
 mkdir -p "/var/log/$app"
 touch /var/log/"$app"/"$app".log
 
-ynh_restore_file "/etc/fail2ban/jail.d/$app.conf"
+ynh_restore_file --origin_path="/etc/fail2ban/jail.d/$app.conf"
-ynh_restore_file "/etc/fail2ban/filter.d/$app.conf"
+ynh_restore_file --origin_path="/etc/fail2ban/filter.d/$app.conf"
 ynh_systemd_action --action=restart --service_name=fail2ban
 
 #=================================================

scripts/upgrade

@@ -118,7 +118,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
@@ -145,7 +145,7 @@ chown -R $app:$app "$final_path"
 ynh_script_progression --message="Upgrading NGINX web server configuration..."
 
 # Create a dedicated NGINX config
-ynh_add_nginx_config "websocket_port rocket_port"
+ynh_add_nginx_config
 
 #=================================================
 # UPGRADE DEPENDENCIES
@@ -199,7 +199,7 @@ fi
 #=================================================
 # UPDATE A CONFIG FILE
 #=================================================
-ynh_script_progression --message="Updating a config file..."
+ynh_script_progression --message="Updating a configuration file..."
 
 ynh_add_config --template="../conf/vaultwarden.env" --destination="$final_path/live/vaultwarden.env"