YunoHost-Apps/vaultwarden_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/vaultwarden_ynh.git synced 2024-09-03 18:26:31 +02:00
Code Issues Activity Actions

Merge pull request #149 from YunoHost-Apps/example

Browse source 
Apply last example_ynh
This commit is contained in:
yalh76 2021-07-30 19:56:43 +02:00 committed by GitHub
commit cc9cfa83eb
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
12 changed files with 99 additions and 81 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

65
README.md
View file

@ -1,56 +1,39 @@
# vaultwarden for YunoHost <!--
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.
-->
# 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) [![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) [![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)* *[Lire ce readme en français.](./README_fr.md)*
> *This package allows you to install vaultwarden quickly and simply on a YunoHost server. > *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.* If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
## Overview ## Overview
vaultwarden is a open source password manager.
**Shipped version:** 1.21.0 Manage passwords and other sensitive informations
## Important points to read before installing **Shipped version:** 1.21.0~ynh2
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. **Demo:** https://vault.bitwarden.com/#/register
## Screenshots ## Screenshots
![](https://bitwarden.com/images/hero.png) ![](./doc/screenshots/screenshot1.png)
## Demo ## Disclaimers / important information
* [Official demo](https://vault.bitwarden.com/#/register) * 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
## Configuration * 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.
How to configure this app: by an admin panel at https://vaultwarden.domain.tld/admin. * You can configure this app using the 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 ## Migrate from Bitwarden
@ -65,7 +48,13 @@ sudo yunohost app upgrade bitwarden -u https://github.com/YunoHost-Apps/vaultwar
The `--debug` option will let you see the full output. If you encounter any issue, please paste it. The `--debug` option will let you see the full output. If you encounter any issue, please paste it.
--- ## Documentation and resources
* Official user documentation: https://help.bitwarden.com/
* Official admin documentation: https://github.com/dani-garcia/vaultwarden/wiki
* Upstream app code repository: https://github.com/dani-garcia/vaultwarden
* YunoHost documentation for this app: https://yunohost.org/app_vaultwarden
* Report a bug: https://github.com/YunoHost-Apps/vaultwarden_ynh/issues
## Developer info ## Developer info
@ -77,3 +66,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/vaultwarden_ynh/tree/
or or
sudo yunohost app upgrade vaultwarden -u https://github.com/YunoHost-Apps/vaultwarden_ynh/tree/testing --debug sudo yunohost app upgrade vaultwarden -u https://github.com/YunoHost-Apps/vaultwarden_ynh/tree/testing --debug
``` ```
**More info regarding app packaging:** https://yunohost.org/packaging_apps

68
README_fr.md
View file

@ -1,58 +1,56 @@
# vaultwarden pour YunoHost # 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) [![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) [![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)* *[Read this readme in english.](./README.md)*
*[Lire ce readme en français.](./README_fr.md)*
> *Ce package vous permet d'installer vaultwarden rapidement et simplement sur un serveur YunoHost. > *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.* Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
## Vue d'ensemble ## Vue d'ensemble
vaultwarden est un gestionnaire de mots de passe open source.
**Version incluse :** 1.21.0 Gérez les mots de passe et autres informations sensibles
## Points importants à lire avant l'installation **Version incluse :** 1.21.0~ynh2
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. **Démo :** https://vault.bitwarden.com/#/register
## Captures d'écran ## Captures d'écran
![](https://bitwarden.com/images/hero.png) ![](./doc/screenshots/screenshot1.png)
## Démo ## Avertissements / informations importantes
* [Démo officielle](https://vault.bitwarden.com/#/register) * 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
## Configuration * 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.
Comment configurer cette application : via le panneau d'administration https://vaultwarden.domain.tld/admin. ## Migrate from Bitwarden
## Documentation 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:
* Documentation officielle : https://help.bitwarden.com/ et https://github.com/dani-garcia/vaultwarden/wiki ```bash
sudo yunohost app upgrade bitwarden -u https://github.com/YunoHost-Apps/vaultwarden_ynh --debug
```
## Caractéristiques spécifiques YunoHost The `--debug` option will let you see the full output. If you encounter any issue, please paste it.
#### Support multi-utilisateur ## Documentations et ressources
* L'authentification LDAP et HTTP est-elle prise en charge? **Non** * Documentation officielle utilisateur : https://help.bitwarden.com/
* L'application peut-elle être utilisée par plusieurs utilisateurs ? **Oui** * Documentation officielle de l'admin : https://github.com/dani-garcia/vaultwarden/wiki
* Dépôt de code officiel de l'app : https://github.com/dani-garcia/vaultwarden
#### Architectures supportées * Documentation YunoHost pour cette app : https://yunohost.org/app_vaultwarden
* Signaler un bug : https://github.com/YunoHost-Apps/vaultwarden_ynh/issues
* 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 ## Informations pour les développeurs
@ -64,3 +62,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/vaultwarden_ynh/tree/
ou ou
sudo yunohost app upgrade vaultwarden -u https://github.com/YunoHost-Apps/vaultwarden_ynh/tree/testing --debug sudo yunohost app upgrade vaultwarden -u https://github.com/YunoHost-Apps/vaultwarden_ynh/tree/testing --debug
``` ```
**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps

0
doc/.gitkeep Normal file
View file

20
doc/DISCLAIMER.md Normal file
View file

@ -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.

0
doc/screenshots/.gitkeep Normal file
View file

BIN
doc/screenshots/screenshot1.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 128 KiB

7
manifest.json
View file

@ -8,6 +8,13 @@
}, },
"version": "1.21.0~ynh2", "version": "1.21.0~ynh2",
"url": "https://github.com/dani-garcia/vaultwarden", "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", "license": "GPL-3.0-or-later",
"maintainer": { "maintainer": {
"name": "yalh76" "name": "yalh76"

2
scripts/change_url
View file

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

4
scripts/install
View file

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

2
scripts/remove
View file

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

6
scripts/restore
View file

@ -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..." ynh_script_progression --message="Recreating the dedicated system user..."
# Create the dedicated user (if not existing) # 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 # RESTORE THE APP MAIN DIR
@ -78,8 +78,8 @@ ynh_script_progression --message="Restoring the Fail2Ban configuration..."
mkdir -p "/var/log/$app" mkdir -p "/var/log/$app"
touch /var/log/"$app"/"$app".log 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 ynh_systemd_action --action=restart --service_name=fail2ban
#================================================= #=================================================

6
scripts/upgrade
View file

@ -118,7 +118,7 @@ fi
ynh_script_progression --message="Making sure dedicated system user exists..." ynh_script_progression --message="Making sure dedicated system user exists..."
# Create a dedicated user (if not existing) # 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 # DOWNLOAD, CHECK AND UNPACK SOURCE
@ -145,7 +145,7 @@ chown -R $app:$app "$final_path"
ynh_script_progression --message="Upgrading NGINX web server configuration..." ynh_script_progression --message="Upgrading NGINX web server configuration..."
# Create a dedicated NGINX config # Create a dedicated NGINX config
ynh_add_nginx_config "websocket_port rocket_port" ynh_add_nginx_config
#================================================= #=================================================
# UPGRADE DEPENDENCIES # UPGRADE DEPENDENCIES
@ -199,7 +199,7 @@ fi
#================================================= #=================================================
# UPDATE A CONFIG FILE # 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" ynh_add_config --template="../conf/vaultwarden.env" --destination="$final_path/live/vaultwarden.env"