2021-07-29 20:05:42 +02:00
<!--
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
2019-08-05 01:29:15 +02:00
2022-05-27 00:09:51 +02:00
[](https://dash.yunohost.org/appci/app/vaultwarden)  
2021-07-29 20:05:42 +02:00
[](https://install-app.yunohost.org/?app=vaultwarden)
2019-08-05 01:29:15 +02:00
2020-04-09 18:35:51 +02:00
*[Lire ce readme en français.](./README_fr.md)*
2021-07-29 20:05:42 +02:00
> *This package allows you to install Vaultwarden quickly and simply on a YunoHost server.
2020-12-01 22:04:05 +01:00
If you don't have YunoHost, please consult [the guide ](https://yunohost.org/#/install ) to learn how to install it.*
2019-08-05 01:29:15 +02:00
## Overview
2022-01-14 21:31:39 +01:00
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.
2021-07-30 20:00:22 +02:00
2022-07-29 22:58:43 +02:00
**Shipped version:** 1.25.2~ynh2
2019-08-05 01:29:15 +02:00
2022-08-15 23:42:43 +02:00
2021-07-29 20:05:42 +02:00
**Demo:** https://vault.bitwarden.com/#/register
2019-08-05 01:29:15 +02:00
## Screenshots
2022-05-27 00:09:51 +02:00
2019-08-05 01:29:15 +02:00
2021-07-29 20:05:42 +02:00
## Disclaimers / important information
2019-08-05 01:29:15 +02:00
2022-02-22 20:44:15 +01:00
### Install
2019-08-05 01:29:15 +02:00
2022-02-22 20:44:15 +01:00
This package compile Vaultwarden from sources, that can take a long time on a small computer :
2019-08-05 01:29:15 +02:00
2022-02-22 20:44:15 +01:00
* 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
2021-05-09 11:06:05 +02:00
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.
2021-07-29 20:05:42 +02:00
## Documentation and resources
2022-05-27 00:09:51 +02:00
* 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 >
2019-08-05 01:29:15 +02:00
2020-12-01 22:04:05 +01:00
## Developer info
2019-08-05 01:29:15 +02:00
2021-04-30 13:49:31 +02:00
Please send your pull request to the [testing branch ](https://github.com/YunoHost-Apps/vaultwarden_ynh/tree/testing ).
2019-08-05 01:29:15 +02:00
To try the testing branch, please proceed like that.
2022-05-27 00:09:51 +02:00
``` bash
2021-04-30 13:49:31 +02:00
sudo yunohost app install https://github.com/YunoHost-Apps/vaultwarden_ynh/tree/testing --debug
2019-08-05 01:29:15 +02:00
or
2021-04-30 13:49:31 +02:00
sudo yunohost app upgrade vaultwarden -u https://github.com/YunoHost-Apps/vaultwarden_ynh/tree/testing --debug
2019-08-05 01:29:15 +02:00
```
2021-07-29 20:05:42 +02:00
2022-05-27 00:09:51 +02:00
**More info regarding app packaging:** < https: / / yunohost . org / packaging_apps >
