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 228fc8323b Merge pull request #165 from Tagadda/master Fix datadir		2022-01-26 20:26:44 +01:00
.github	[autopatch] Update issue and PR templates	2021-05-13 17:53:33 +02:00
conf	Fix sandboxing	2022-01-23 23:17:50 +00:00
doc	Apply last example_ynh	2022-01-14 21:31:33 +01:00
scripts	Merge pull request #165 from Tagadda/master	2022-01-26 20:26:44 +01:00
.gitignore	First commit	2019-08-05 01:29:15 +02:00
check_process	Apply last example_ynh	2022-01-14 21:31:33 +01:00
LICENSE	First commit	2019-08-05 01:29:15 +02:00
manifest.json	Apply last example_ynh	2022-01-14 21:31:33 +01:00
README.md	Auto-update README	2022-01-14 20:31:39 +00:00
README_fr.md	Auto-update README	2022-01-14 20:31:39 +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.23.0~ynh2

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

Screenshots

Disclaimers / important information

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:

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