vaultwarden_ynh/README.md

<!--
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

[![Integration level](https://dash.yunohost.org/integration/vaultwarden.svg)](https://dash.yunohost.org/appci/app/vaultwarden) ![Working status](https://ci-apps.yunohost.org/ci/badges/vaultwarden.status.svg) ![Maintenance status](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)

*[Lire ce readme en français.](./README_fr.md)*

> *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.*

## 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.29.1~ynh1

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

## Screenshots

![Screenshot of Vaultwarden](./doc/screenshots/screenshot1.png)

## 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>
* Report a bug: <https://github.com/YunoHost-Apps/vaultwarden_ynh/issues>

## Developer info

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.

``` bash
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>
Auto-update README 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`
First commit 2019-08-05 01:29:15 +02:00
Auto-update README 2023-01-25 20:14:28 +01:00			`[![Integration level](https://dash.yunohost.org/integration/vaultwarden.svg)](https://dash.yunohost.org/appci/app/vaultwarden) ![Working status](https://ci-apps.yunohost.org/ci/badges/vaultwarden.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/vaultwarden.maintain.svg)`
Auto-update README 2023-02-24 00:18:15 +01:00
Auto-update README 2021-07-29 20:05:42 +02:00			`[![Install Vaultwarden with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=vaultwarden)`
First commit 2019-08-05 01:29:15 +02:00
Update README.md 2020-04-09 18:35:51 +02:00			`[Lire ce readme en français.](./README_fr.md)`

Auto-update README 2021-07-29 20:05:42 +02:00			`> *This package allows you to install Vaultwarden quickly and simply on a YunoHost server.`
Apply last example_ynh 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.*`
First commit 2019-08-05 01:29:15 +02:00
			`## Overview`

Auto-update README 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.`
Auto-update README 2021-07-30 20:00:22 +02:00
Auto-update README 2023-10-17 19:53:44 +02:00			`Shipped version: 1.29.1~ynh1`
Auto-update README 2022-08-15 23:42:43 +02:00
Auto-update README 2021-07-29 20:05:42 +02:00			`Demo: https://vault.bitwarden.com/#/register`
First commit 2019-08-05 01:29:15 +02:00
			`## Screenshots`

Auto-update README 2022-05-27 00:09:51 +02:00			`![Screenshot of Vaultwarden](./doc/screenshots/screenshot1.png)`
First commit 2019-08-05 01:29:15 +02:00
Auto-update README 2021-07-29 20:05:42 +02:00			`## Documentation and resources`

Auto-update README 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>`
			`* Report a bug: <https://github.com/YunoHost-Apps/vaultwarden_ynh/issues>`
First commit 2019-08-05 01:29:15 +02:00
Apply last example_ynh 2020-12-01 22:04:05 +01:00			`## Developer info`
First commit 2019-08-05 01:29:15 +02:00
Name change 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).`
First commit 2019-08-05 01:29:15 +02:00
			`To try the testing branch, please proceed like that.`
Auto-update README 2022-05-27 00:09:51 +02:00
			``` bash
Name change 2021-04-30 13:49:31 +02:00			`sudo yunohost app install https://github.com/YunoHost-Apps/vaultwarden_ynh/tree/testing --debug`
First commit 2019-08-05 01:29:15 +02:00			`or`
Name change 2021-04-30 13:49:31 +02:00			`sudo yunohost app upgrade vaultwarden -u https://github.com/YunoHost-Apps/vaultwarden_ynh/tree/testing --debug`
First commit 2019-08-05 01:29:15 +02:00			```
Auto-update README 2021-07-29 20:05:42 +02:00
Auto-update README 2022-05-27 00:09:51 +02:00			`More info regarding app packaging: <https://yunohost.org/packaging_apps>`