diff --git a/bitwarden/.README.j2 b/bitwarden/.README.j2 deleted file mode 100644 index 429021b86..000000000 --- a/bitwarden/.README.j2 +++ /dev/null @@ -1,88 +0,0 @@ -# Home Assistant Community Add-on: Bitwarden RS - -[![Release][release-shield]][release] ![Project Stage][project-stage-shield] ![Project Maintenance][maintenance-shield] - -[![Discord][discord-shield]][discord] [![Community Forum][forum-shield]][forum] - -[![Sponsor Frenck via GitHub Sponsors][github-sponsors-shield]][github-sponsors] - -[![Support Frenck on Patreon][patreon-shield]][patreon] - -Open source password management solution. - -_Thanks to everyone having starred my repo!_ - -[![Stargazers repo roster for @alexbelgium/hassio-addons](https://reporoster.com/stars/alexbelgium/hassio-addons)](https://github.com/alexbelgium/hassio-addons/stargazers) - -## About - -Bitwarden is an open-source password manager that can store sensitive -information such as website credentials in an encrypted vault. - -The Bitwarden platform offers a variety of client applications including -a web interface, desktop applications, browser extensions and mobile apps. - -This add-on is based upon the lightweight and opensource -[Bitwarden RS][bitwarden-rs] implementation, allowing you to self-host -this amazing password manager. - -Password theft is a serious problem. The websites and apps that you use are -under attack every day. Security breaches occur and your passwords are stolen. -When you reuse the same passwords everywhere hackers can easily access your -email, bank, and other important accounts. USE A PASSWORD MANAGER! - -![Bitwarden Preview][screenshot] - -{% if channel == "edge" %} -## WARNING! THIS IS AN EDGE VERSION! - -This Home Assistant Add-ons repository contains edge builds of add-ons. -Edge builds add-ons are based upon the latest development version. - -- They may not work at all. -- They might stop working at any time. -- They could have a negative impact on your system. - -This repository was created for: - -- Anybody willing to test. -- Anybody interested in trying out upcoming add-ons or add-on features. -- Developers. - -If you are more interested in stable releases of our add-ons: - - - -{% endif %} -{% if channel == "beta" %} -## WARNING! THIS IS A BETA VERSION! - -This Home Assistant Add-ons repository contains beta releases of add-ons. - -- They might stop working at any time. -- They could have a negative impact on your system. - -This repository was created for: - -- Anybody willing to test. -- Anybody interested in trying out upcoming add-ons or add-on features. - -If you are more interested in stable releases of our add-ons: - - - -{% endif %} -[bitwarden-rs]: https://github.com/dani-garcia/bitwarden_rs -[discord-shield]: https://img.shields.io/discord/478094546522079232.svg -[discord]: https://discord.me/hassioaddons -[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg -[forum]: https://community.home-assistant.io/t/home-assistant-community-add-on-bitwarden-rs/115573?u=frenck -[github-sponsors-shield]: https://frenck.dev/wp-content/uploads/2019/12/github_sponsor.png -[github-sponsors]: https://github.com/sponsors/frenck -[maintenance-shield]: https://img.shields.io/maintenance/yes/2020.svg -[patreon-shield]: https://frenck.dev/wp-content/uploads/2019/12/patreon.png -[patreon]: https://www.patreon.com/frenck -[project-stage-shield]: https://img.shields.io/badge/project%20stage-experimental-yellow.svg -[release-shield]: https://img.shields.io/badge/version-{{ version }}-blue.svg -[release]: {{ repo }}/tree/{{ version }} -[screenshot]: {{ repo }}/raw/master/images/screenshot.png diff --git a/bitwarden/README.md b/bitwarden/README.md new file mode 100644 index 000000000..481cd84f3 --- /dev/null +++ b/bitwarden/README.md @@ -0,0 +1,50 @@ +# Home assistant add-on: Vaultwarden (Bitwarden RS) + +[![Donate][donation-badge]](https://www.buymeacoffee.com/alexbelgium) + +[donation-badge]: https://img.shields.io/badge/Buy%20me%20a%20coffee-%23d32f2f?logo=buy-me-a-coffee&style=flat&logoColor=white + +![Supports + Architecture][aarch64-shield] ![Supports amd64 Architecture][amd64-shield] ![Supports armhf Architecture][armhf-shield] ![Supports armv7 Architecture][armv7-shield] + +_Thanks to everyone having starred my repo!_ + +[![Stargazers repo roster for @alexbelgium/hassio-addons](https://reporoster.com/stars/alexbelgium/hassio-addons)](https://github.com/alexbelgium/hassio-addons/stargazers) + +## About + +Password manager. +Created by Frenck here : https://github.com/hassio-addons/addon-bitwarden + +## Configuration + +Webui can be found at . +Default username: "admin" and password: "admin" + +```yaml +ssl: true # Enables ssl +certfile: fullchain.pem # Must be located in /ssl/ +keyfile: privkey.pem # Must be located in /ssl/ +``` + +## Installation + +The installation of this add-on is pretty straightforward and not different in +comparison to installing any other Hass.io add-on. + +1. [Add my Hass.io add-ons repository][repository] to your Hass.io instance. +1. Install this add-on. +1. Click the `Save` button to store your configuration. +1. Start the add-on. +1. Check the logs of the add-on to see if everything went well. +1. Carefully configure the add-on to your preferences, see the official documentation for for that. + +## Support + +Create an issue on github + +[repository]: https://github.com/alexbelgium/hassio-addons +[aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg +[amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg +[armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg +[armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg