mirror of https://github.com/YunoHost-Apps/vaultwarden_ynh.git synced 2024-09-03 18:26:31 +02:00

Open source password management solutions for YunoHost

Find a file

yalh76 2d45dc20e6 typo		2022-09-07 07:40:53 +02:00
.github	Switch sources from docker	2022-07-18 21:17:17 +02:00
conf	Implement ynh_setup_source_docker	2022-09-07 07:15:40 +02:00
doc	Update DISCLAIMER.md	2022-02-22 14:48:28 +01:00
scripts	typo	2022-09-07 07:40:53 +02:00
.gitignore	First commit	2019-08-05 01:29:15 +02:00
check_process	Apply last example_ynh	2022-07-17 05:57:09 +02:00
LICENSE	First commit	2019-08-05 01:29:15 +02:00
manifest.json	Update manifest.json	2022-08-31 19:51:04 +02:00
README.md	Auto-update README	2022-08-31 17:51:09 +00:00
README_fr.md	Auto-update README	2022-08-31 17:51:09 +00:00

README.md

Vaultwarden for YunoHost

Lire ce readme en français.

This package allows you to install Vaultwarden quickly and simply on a YunoHost server. If you don't have YunoHost, please consult the guide to learn how to install it.

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.

Shipped version: 1.25.2~ynh4

Demo: https://vault.bitwarden.com/#/register

Screenshots

Disclaimers / important information

Install

This package compile Vaultwarden from sources, that can take a long time on a small computer :

When installing on a Raspberry Pi 3, this can take more than 1 hour.
When installing from the webadmin, you can encounter the "504 Gateway Timeout": this is fine, just let it finish in the background.

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:

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.

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

Please send your pull request to the testing branch.

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

More info regarding app packaging: https://yunohost.org/packaging_apps