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

80 lines
2.9 KiB
Markdown
Raw Normal View History

2021-04-30 13:49:31 +02:00
# vaultwarden for YunoHost
2019-08-05 01:29:15 +02:00
2021-04-30 13:49:31 +02:00
[![Integration level](https://dash.yunohost.org/integration/vaultwarden.svg)](https://dash.yunohost.org/appci/app/vaultwarden) ![](https://ci-apps.yunohost.org/ci/badges/vaultwarden.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/vaultwarden.maintain.svg)
[![Install vaultwarden with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](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-04-30 13:49:31 +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
2021-04-30 13:49:31 +02:00
vaultwarden is a open source password manager.
2019-08-05 01:29:15 +02:00
2021-04-30 13:36:43 +02:00
**Shipped version:** 1.21.0
2019-08-05 01:29:15 +02:00
## Important points to read before installing
2021-04-30 13:49:31 +02:00
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.
2019-08-05 01:29:15 +02:00
## Screenshots
2021-04-30 13:54:46 +02:00
![](https://bitwarden.com/images/hero.png)
2019-08-05 01:29:15 +02:00
## Demo
2021-04-30 13:54:46 +02:00
* [Official demo](https://vault.bitwarden.com/#/register)
2019-08-05 01:29:15 +02:00
## Configuration
2021-04-30 13:49:31 +02:00
How to configure this app: by an admin panel at https://vaultwarden.domain.tld/admin.
2019-08-05 01:29:15 +02:00
## Documentation
2021-04-30 13:54:46 +02:00
* Official documentation: https://help.bitwarden.com/ and https://github.com/dani-garcia/vaultwarden/wiki
2019-08-05 01:29:15 +02:00
## YunoHost specific features
2020-12-01 22:04:05 +01:00
#### Multi-user support
2019-08-05 01:29:15 +02:00
2020-04-09 18:35:51 +02:00
* Are LDAP and HTTP auth supported? **No**
* Can the app be used by multiple users? **Yes**
2019-08-05 01:29:15 +02:00
#### Supported architectures
2021-04-30 13:49:31 +02:00
* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/vaultwarden.svg)](https://ci-apps.yunohost.org/ci/apps/vaultwarden/)
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/vaultwarden.svg)](https://ci-apps-arm.yunohost.org/ci/apps/vaultwarden/)
2019-08-05 01:29:15 +02:00
## Links
2021-04-30 13:49:31 +02:00
* Report a bug: https://github.com/YunoHost-Apps/vaultwarden_ynh/issues
2021-04-30 13:54:46 +02:00
* App website: https://bitwarden.com/
2021-04-30 13:49:31 +02:00
* Upstream app repository: https://github.com/dani-garcia/vaultwarden
2019-08-05 01:29:15 +02:00
* YunoHost website: https://yunohost.org/
2021-05-09 11:06:05 +02:00
## 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:
```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.
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.
```
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
```