Skip to content

Commit

Permalink
📚 Add My buttons to documentation (#202)
Browse files Browse the repository at this point in the history
  • Loading branch information
frenck authored Mar 15, 2022
1 parent 36410a4 commit 055537d
Showing 1 changed file with 18 additions and 3 deletions.
21 changes: 18 additions & 3 deletions bitwarden/DOCS.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,12 @@ email, bank, and other important accounts. USE A PASSWORD MANAGER!
The installation of this add-on is pretty straightforward and not different in
comparison to installing any other Home Assistant add-on.

1. Search for the "Vaultwarden (Bitwarden)" add-on in the Supervisor add-on
store and install it.
1. Click the Home Assistant My button below to open the add-on on your Home
Assistant instance.

[![Open this add-on in your Home Assistant instance.][addon-badge]][addon]

1. Click the "Install" button to install the add-on.
1. Start the "Vaultwarden (Bitwarden)" add-on.
1. Check the logs of the "Vaultwarden (Bitwarden)" add-on to see if everything
went well and to get the admin token/password.
Expand All @@ -32,7 +36,14 @@ comparison to installing any other Home Assistant add-on.
1. The admin/token in the logs is only shown until it is saved or changed.
Hit save in the admin panel to use the randomly generated password or
change it to one of your choosing.
1. Be sure to store your admin token somewhere safe.
1. Be sure to store your admin token somewhere safe. **The add-on will never
show it again!**

Home Assistant, by default, ships with the Community Add-ons store installed.
However, if it is missing (for any reason), you can add it by clicking the
button My button below.

[![Add repository to your Home Assitant instance.][repository-badge]][repository]

## Configuration

Expand Down Expand Up @@ -165,6 +176,8 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

[addon-badge]: https://my.home-assistant.io/badges/supervisor_addon.svg
[addon]: https://my.home-assistant.io/redirect/supervisor_addon/?addon=a0d7b954_bitwarden
[contributors]: https://github.com/hassio-addons/addon-bitwarden/graphs/contributors
[discord-ha]: https://discord.gg/c5DvZ4e
[discord]: https://discord.me/hassioaddons
Expand All @@ -173,5 +186,7 @@ SOFTWARE.
[issue]: https://github.com/hassio-addons/addon-bitwarden/issues
[reddit]: https://reddit.com/r/homeassistant
[releases]: https://github.com/hassio-addons/addon-bitwarden/releases
[repository-badge]: https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg
[repository]: https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Fhassio-addons%2Frepository
[semver]: http://semver.org/spec/v2.0.0.htm
[vaultwarden]: https://github.com/dani-garcia/vaultwarden

0 comments on commit 055537d

Please sign in to comment.