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 #254 from YunoHost-Apps/testing

Browse source 
Testing
This commit is contained in:
Tagada 2024-03-20 08:09:43 +01:00 committed by GitHub
commit 87f0dca3c1
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
9 changed files with 54 additions and 32 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
README.md
View file

@ -1,5 +1,5 @@
<!-- <!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator 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. It shall NOT be edited by hand.
--> -->
@ -16,11 +16,13 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in
## Overview ## Overview
Alternative implementation of the Bitwarden server API written in Rust and compatible with upstream Bitwarden clients*, perfect for self-hosted deployment where running the official resource-heavy service might not be ideal. Vaultwarden is a password manager, allowing generation and storage of passwords in a secure way. These are protected by a single password called the "master password".
**Shipped version:** 1.29.1~ynh3 Clients exist for [Linux, macOS and Windows](https://bitwarden.com/#download), [Android](https://play.google.com/store/apps/details?id=com.x8bit.bitwarden), [iOS](https://itunes.apple.com/app/bitwarden-free-password-manager/id1137397744?mt=8), and as a web browser plug-ins. It is also possible to manage passwords from the web interface.
**Demo:** https://vault.bitwarden.com/#/register **Shipped version:** 1.29.1~ynh4
**Demo:** <https://vault.bitwarden.com/#/register>
## Screenshots ## Screenshots
@ -28,11 +30,11 @@ Alternative implementation of the Bitwarden server API written in Rust and compa
## Documentation and resources ## Documentation and resources
* Official user documentation: <https://help.bitwarden.com/> - Official user documentation: <https://help.bitwarden.com/>
* Official admin documentation: <https://github.com/dani-garcia/vaultwarden/wiki> - Official admin documentation: <https://github.com/dani-garcia/vaultwarden/wiki>
* Upstream app code repository: <https://github.com/dani-garcia/vaultwarden> - Upstream app code repository: <https://github.com/dani-garcia/vaultwarden>
* YunoHost Store: <https://apps.yunohost.org/app/vaultwarden> - YunoHost Store: <https://apps.yunohost.org/app/vaultwarden>
* Report a bug: <https://github.com/YunoHost-Apps/vaultwarden_ynh/issues> - Report a bug: <https://github.com/YunoHost-Apps/vaultwarden_ynh/issues>
## Developer info ## Developer info
@ -40,7 +42,7 @@ Please send your pull request to the [testing branch](https://github.com/YunoHos
To try the testing branch, please proceed like that. To try the testing branch, please proceed like that.
``` bash ```bash
sudo yunohost app install https://github.com/YunoHost-Apps/vaultwarden_ynh/tree/testing --debug sudo yunohost app install https://github.com/YunoHost-Apps/vaultwarden_ynh/tree/testing --debug
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

22
README_fr.md
View file

@ -1,5 +1,5 @@
<!-- <!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator 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. It shall NOT be edited by hand.
--> -->
@ -16,11 +16,13 @@ Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) po
## Vue d’ensemble ## Vue d’ensemble
Implémentation alternative de l'API du serveur Bitwarden écrite en Rust et compatible avec les clients Bitwarden en amont*, parfaite pour un déploiement auto-hébergé où l'exécution du service officiel gourmand en ressources n'est peut-être pas idéale. Vaultwarden est un gestionnaire de mots de passe, qui permet de générer et de conserver des mots de passe de manière sécurisée. Ces éléments sont protégés par un seul et unique mot de passe appelé « mot de passe maître ».
**Version incluse :** 1.29.1~ynh3 Il existe des clients pour [Linux, macOS et Windows](https://bitwarden.com/#download), [Android](https://play.google.com/store/apps/details?id=com.x8bit.bitwarden), [iOS](https://itunes.apple.com/app/bitwarden-free-password-manager/id1137397744?mt=8), et comme module d'extension pour navigateur web. Il est aussi possible de gérer ses mot de passe depuis l'interface web.
**Démo :** https://vault.bitwarden.com/#/register **Version incluse :** 1.29.1~ynh4
**Démo :** <https://vault.bitwarden.com/#/register>
## Captures d’écran ## Captures d’écran
@ -28,11 +30,11 @@ Implémentation alternative de l'API du serveur Bitwarden écrite en Rust et com
## Documentations et ressources ## Documentations et ressources
* Documentation officielle utilisateur : <https://help.bitwarden.com/> - Documentation officielle utilisateur : <https://help.bitwarden.com/>
* Documentation officielle de l’admin : <https://github.com/dani-garcia/vaultwarden/wiki> - 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> - Dépôt de code officiel de l’app : <https://github.com/dani-garcia/vaultwarden>
* YunoHost Store: <https://apps.yunohost.org/app/vaultwarden> - YunoHost Store : <https://apps.yunohost.org/app/vaultwarden>
* Signaler un bug : <https://github.com/YunoHost-Apps/vaultwarden_ynh/issues> - Signaler un bug : <https://github.com/YunoHost-Apps/vaultwarden_ynh/issues>
## Informations pour les développeurs ## Informations pour les développeurs
@ -40,7 +42,7 @@ Merci de faire vos pull request sur la [branche testing](https://github.com/Yuno
Pour essayer la branche testing, procédez comme suit. Pour essayer la branche testing, procédez comme suit.
``` bash ```bash
sudo yunohost app install https://github.com/YunoHost-Apps/vaultwarden_ynh/tree/testing --debug sudo yunohost app install https://github.com/YunoHost-Apps/vaultwarden_ynh/tree/testing --debug
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

4
conf/vaultwarden.env
View file

@ -344,10 +344,10 @@ ROCKET_WORKERS=1
## Mail specific settings, set SMTP_HOST and SMTP_FROM to enable the mail service. ## Mail specific settings, set SMTP_HOST and SMTP_FROM to enable the mail service.
## To make sure the email links are pointing to the correct host, set the DOMAIN variable. ## To make sure the email links are pointing to the correct host, set the DOMAIN variable.
## Note: if SMTP_USERNAME is specified, SMTP_PASSWORD is mandatory ## Note: if SMTP_USERNAME is specified, SMTP_PASSWORD is mandatory
SMTP_HOST=127.0.0.1 SMTP_HOST=__DOMAIN__
SMTP_FROM=__APP__@__DOMAIN__ SMTP_FROM=__APP__@__DOMAIN__
SMTP_FROM_NAME=Vaultwarden SMTP_FROM_NAME=Vaultwarden
SMTP_SECURITY=off SMTP_SECURITY=starttls
SMTP_PORT=25 SMTP_PORT=25
SMTP_USERNAME=__APP__ SMTP_USERNAME=__APP__
SMTP_PASSWORD=__MAIL_PWD__ SMTP_PASSWORD=__MAIL_PWD__

4
doc/DESCRIPTION.md
View file

@ -1 +1,3 @@
Alternative implementation of the Bitwarden server API written in Rust and compatible with upstream Bitwarden clients*, perfect for self-hosted deployment where running the official resource-heavy service might not be ideal. Vaultwarden is a password manager, allowing generation and storage of passwords in a secure way. These are protected by a single password called the "master password".
Clients exist for [Linux, macOS and Windows](https://bitwarden.com/#download), [Android](https://play.google.com/store/apps/details?id=com.x8bit.bitwarden), [iOS](https://itunes.apple.com/app/bitwarden-free-password-manager/id1137397744?mt=8), and as a web browser plug-ins. It is also possible to manage passwords from the web interface.

4
doc/DESCRIPTION_fr.md
View file

@ -1 +1,3 @@
Implémentation alternative de l'API du serveur Bitwarden écrite en Rust et compatible avec les clients Bitwarden en amont*, parfaite pour un déploiement auto-hébergé où l'exécution du service officiel gourmand en ressources n'est peut-être pas idéale. Vaultwarden est un gestionnaire de mots de passe, qui permet de générer et de conserver des mots de passe de manière sécurisée. Ces éléments sont protégés par un seul et unique mot de passe appelé « mot de passe maître ».
Il existe des clients pour [Linux, macOS et Windows](https://bitwarden.com/#download), [Android](https://play.google.com/store/apps/details?id=com.x8bit.bitwarden), [iOS](https://itunes.apple.com/app/bitwarden-free-password-manager/id1137397744?mt=8), et comme module d'extension pour navigateur web. Il est aussi possible de gérer ses mot de passe depuis l'interface web.

6
doc/POST_INSTALL.md
View file

@ -1,3 +1,5 @@
Please open https://__DOMAIN____PATH__/admin The admin interface is available at <https://__DOMAIN____PATH__/admin>
The admin token is: __ADMIN_TOKEN__
The admin token is: `__ADMIN_TOKEN__`
You will be able to invite users to your vaultwarden instance. You will be able to invite users to your vaultwarden instance.

6
doc/POST_INSTALL_fr.md
View file

@ -1,3 +1,5 @@
Veuillez ouvrir https://__DOMAIN____PATH__/admin L'interface d'administration est accessible à <https://__DOMAIN____PATH__/admin>
Le jeton d'administration est : __ADMIN_TOKEN__
Le jeton d'administration est : `__ADMIN_TOKEN__`
Vous pourrez inviter des utilisateurs dans votre instance de Vaultwarden. Vous pourrez inviter des utilisateurs dans votre instance de Vaultwarden.

2
manifest.toml
View file

@ -7,7 +7,7 @@ name = "Vaultwarden"
description.en = "Manage passwords and other sensitive informations" description.en = "Manage passwords and other sensitive informations"
description.fr = "Gérez les mots de passe et autres informations sensibles" description.fr = "Gérez les mots de passe et autres informations sensibles"
version = "1.29.1~ynh3" version = "1.29.1~ynh4"
maintainers = ["yalh76"] maintainers = ["yalh76"]

12
scripts/upgrade
View file

@ -23,7 +23,7 @@ upgrade_type=$(ynh_check_app_version_changed)
#================================================= #=================================================
ynh_script_progression --message="Stopping a systemd service..." ynh_script_progression --message="Stopping a systemd service..."
ynh_systemd_action --service_name=$app --action="stop" --log_path="systemd" --line_match="Stopped" ynh_systemd_action --service_name=$app --action="stop" --log_path="systemd" --line_match="Stopping Vaultwarden Server"
#================================================= #=================================================
# DOWNLOAD, CHECK AND UNPACK SOURCE # DOWNLOAD, CHECK AND UNPACK SOURCE
@ -46,6 +46,16 @@ ynh_add_config --template="vaultwarden.env" --destination="$install_dir/live/.en
chmod 400 "$install_dir/live/.env" chmod 400 "$install_dir/live/.env"
chown $app:$app "$install_dir/live/.env" chown $app:$app "$install_dir/live/.env"
# Fix SMTP configuration
config_file=$data_dir/config.json
if [ -e "$config_file" ]; then
cat <<< $(jq -r --arg domain "$domain" '.smtp_host = $domain' $config_file) > $config_file
cat <<< $(jq -r '.smtp_security = "starttls"' $config_file) > $config_file
if [ ! -s "$config_file" ]; then
ynh_die --message="Something went wrong while setting up $config_file: it ended up empty."
fi
fi
#================================================= #=================================================
# REAPPLY SYSTEM CONFIGURATIONS # REAPPLY SYSTEM CONFIGURATIONS
#================================================= #=================================================