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 branch 'testing' into 1.29.2

Browse source
This commit is contained in:
ericgaspar 2024-05-04 13:40:22 +02:00
commit 7bd72afa3a
13 changed files with 178 additions and 45 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
ALL_README.md Normal file
View file

@ -0,0 +1,6 @@
# All available README files by language
- [Read the README in English](README.md)
- [Lire le README en français](README_fr.md)
- [Le o README en galego](README_gl.md)
- [Leggi il “README” in italiano](README_it.md)

26
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.
--> -->
@ -9,18 +9,18 @@ It shall NOT be edited by hand.
[![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)* *[Read this README is other languages.](./ALL_README.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
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.30.1~ynh1 **Shipped version:** 1.30.1~ynh1
**Demo:** https://vault.bitwarden.com/#/register **Demo:** <https://vault.bitwarden.com/#/register>
## Screenshots ## Screenshots
@ -28,17 +28,17 @@ 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
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/vaultwarden_ynh/tree/testing). 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. 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

30
README_fr.md
View file

@ -1,6 +1,6 @@
<!-- <!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator Nota bene : ce README est automatiquement généré par <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
It shall NOT be edited by hand. Il NE doit PAS être modifié à la main.
--> -->
# Vaultwarden pour YunoHost # Vaultwarden pour YunoHost
@ -9,18 +9,18 @@ It shall NOT be edited by hand.
[![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)* *[Lire le README dans d'autres langues.](./ALL_README.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, regardez [ici](https://yunohost.org/#/install) pour savoir comment l’installer et en profiter.* > *Si vous n’avez pas YunoHost, consultez [ce guide](https://yunohost.org/install) pour savoir comment l’installer et en profiter.*
## 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.30.1~ynh1 **Version incluse :** 1.30.1~ynh1
**Démo :** https://vault.bitwarden.com/#/register **Démo :** <https://vault.bitwarden.com/#/register>
## Captures d’écran ## Captures d’écran
@ -28,17 +28,17 @@ 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
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/vaultwarden_ynh/tree/testing). 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. 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
@ -46,4 +46,4 @@ 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> **Plus d’infos sur le packaging d’applications :** <https://yunohost.org/packaging_apps>

52
README_gl.md Normal file
View file

@ -0,0 +1,52 @@
<!--
NOTA: Este README foi creado automáticamente por <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
NON debe editarse manualmente.
-->
# Vaultwarden para YunoHost
[![Nivel de integración](https://dash.yunohost.org/integration/vaultwarden.svg)](https://dash.yunohost.org/appci/app/vaultwarden) ![Estado de funcionamento](https://ci-apps.yunohost.org/ci/badges/vaultwarden.status.svg) ![Estado de mantemento](https://ci-apps.yunohost.org/ci/badges/vaultwarden.maintain.svg)
[![Instalar Vaultwarden con YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=vaultwarden)
*[Le este README en outros idiomas.](./ALL_README.md)*
> *Este paquete permíteche instalar Vaultwarden de xeito rápido e doado nun servidor YunoHost.*
> *Se non usas YunoHost, le a [documentación](https://yunohost.org/install) para saber como instalalo.*
## Vista xeral
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.
**Versión proporcionada:** 1.29.1~ynh4
**Demo:** <https://vault.bitwarden.com/#/register>
## Capturas de pantalla
![Captura de pantalla de Vaultwarden](./doc/screenshots/screenshot1.png)
## Documentación e recursos
- Documentación oficial para usuarias: <https://help.bitwarden.com/>
- Documentación oficial para admin: <https://github.com/dani-garcia/vaultwarden/wiki>
- Repositorio de orixe do código: <https://github.com/dani-garcia/vaultwarden>
- Tenda YunoHost: <https://apps.yunohost.org/app/vaultwarden>
- Informar dun problema: <https://github.com/YunoHost-Apps/vaultwarden_ynh/issues>
## Info de desenvolvemento
Envía a túa colaboración á [rama `testing`](https://github.com/YunoHost-Apps/vaultwarden_ynh/tree/testing).
Para probar a rama `testing`, procede deste xeito:
```bash
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
```
**Máis info sobre o empaquetado da app:** <https://yunohost.org/packaging_apps>

52
README_it.md Normal file
View file

@ -0,0 +1,52 @@
<!--
N.B.: Questo README è stato automaticamente generato da <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
NON DEVE essere modificato manualmente.
-->
# Vaultwarden per YunoHost
[![Livello di integrazione](https://dash.yunohost.org/integration/vaultwarden.svg)](https://dash.yunohost.org/appci/app/vaultwarden) ![Stato di funzionamento](https://ci-apps.yunohost.org/ci/badges/vaultwarden.status.svg) ![Stato di manutenzione](https://ci-apps.yunohost.org/ci/badges/vaultwarden.maintain.svg)
[![Installa Vaultwarden con YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=vaultwarden)
*[Leggi questo README in altre lingue.](./ALL_README.md)*
> *Questo pacchetto ti permette di installare Vaultwarden su un server YunoHost in modo semplice e veloce.*
> *Se non hai YunoHost, consulta [la guida](https://yunohost.org/install) per imparare a installarlo.*
## Panoramica
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.
**Versione pubblicata:** 1.29.1~ynh4
**Prova:** <https://vault.bitwarden.com/#/register>
## Screenshot
![Screenshot di Vaultwarden](./doc/screenshots/screenshot1.png)
## Documentazione e risorse
- Documentazione ufficiale per gli utenti: <https://help.bitwarden.com/>
- Documentazione ufficiale per gli amministratori: <https://github.com/dani-garcia/vaultwarden/wiki>
- Repository upstream del codice dell’app: <https://github.com/dani-garcia/vaultwarden>
- Store di YunoHost: <https://apps.yunohost.org/app/vaultwarden>
- Segnala un problema: <https://github.com/YunoHost-Apps/vaultwarden_ynh/issues>
## Informazioni per sviluppatori
Si prega di inviare la tua pull request alla [branch di `testing`](https://github.com/YunoHost-Apps/vaultwarden_ynh/tree/testing).
Per provare la branch di `testing`, si prega di procedere in questo modo:
```bash
sudo yunohost app install https://github.com/YunoHost-Apps/vaultwarden_ynh/tree/testing --debug
o
sudo yunohost app upgrade vaultwarden -u https://github.com/YunoHost-Apps/vaultwarden_ynh/tree/testing --debug
```
**Maggiori informazioni riguardo il pacchetto di quest’app:** <https://yunohost.org/packaging_apps>

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

@ -9,7 +9,7 @@ description.fr = "Gérez les mots de passe et autres informations sensibles"
version = "1.30.1~ynh1" version = "1.30.1~ynh1"
maintainers = [ "yalh76" ] maintainers = [ ]
[upstream] [upstream]
license = "GPL-3.0-or-later" license = "GPL-3.0-or-later"

13
scripts/_common.sh
View file

@ -4,21 +4,26 @@
# COMMON VARIABLES # COMMON VARIABLES
#================================================= #=================================================
pkg_image="vaultwarden/server"
#================================================= #=================================================
# PERSONAL HELPERS # PERSONAL HELPERS
#================================================= #=================================================
_download_vaultwarden_from_docker() { _download_vaultwarden_from_docker() {
docker_image="vaultwarden/server"
debian=$(lsb_release --codename --short)
if [[ $debian = "bullseye" ]]; then
docker_version="$(ynh_app_upstream_version)"
elif [[ $debian = "bookworm" ]]; then
docker_version="$(ynh_app_upstream_version)-alpine"
fi
# Download, check integrity, uncompress the source of vaultwarden from app.src to his build directory
docker_arg="" docker_arg=""
# Fixup for armhf # Fixup for armhf
if [ "$YNH_ARCH" == "armhf" ]; then if [ "$YNH_ARCH" == "armhf" ]; then
docker_arg="--os_arch_variant=linux/arm/v7" docker_arg="--os_arch_variant=linux/arm/v7"
fi fi
ynh_docker_image_extract --dest_dir="$install_dir/build/" --image_spec="$pkg_image:$(ynh_app_upstream_version)" $docker_arg
ynh_docker_image_extract --dest_dir="$install_dir/build/" --image_spec="$docker_image:$docker_version" $docker_arg
# Move files from the extract to the live directory # Move files from the extract to the live directory
ynh_secure_remove --file="$install_dir/live/" ynh_secure_remove --file="$install_dir/live/"

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
#================================================= #=================================================