From 5fdf21995e8aaab020bb0e27099cfbbe7f0fe53d Mon Sep 17 00:00:00 2001 From: Keagan McClelland Date: Fri, 25 Feb 2022 17:34:13 -0700 Subject: [PATCH] cleans up manifest and instructions (#15) --- docs/instructions.md | 32 +++++++++++++++++++++----------- manifest.yaml | 5 ++--- 2 files changed, 23 insertions(+), 14 deletions(-) diff --git a/docs/instructions.md b/docs/instructions.md index 24b13f7..974ddc1 100644 --- a/docs/instructions.md +++ b/docs/instructions.md @@ -3,6 +3,7 @@ ## Choose your platform A. **Use the Bitwarden browser extension (detailed screen shots below) on:** + - [Firefox](https://docs.start9labs.com/misc-guides/tor-firefox/index.html) (with Socks5 Proxy enabled) - (Mac, Windows, Linux, Android) - Tor Browser - (Mac, Windows, Linux, Android) @@ -11,7 +12,6 @@ B. **Use the Android Bitwarden native app with [Orbot](https://docs.start9labs.c C. **Access your Bitwarden web vault by visiting its Tor Address from any Tor-enabled browser.** - ## Connecting to your App or Browser Extention The instructions below are for Tor Browser on Mac, but you should follow similar steps on other platforms (such as browser extentions). @@ -19,42 +19,52 @@ The instructions below are for Tor Browser on Mac, but you should follow similar 1. Open the browser and visit the add-ons section. + ![](./assets/img-1.png) + 2. Search for “Bitwarden” and click “Add to Firefox”. + ![](./assets/img-2.png) + 3. Access the Bitwarden settings. + ![](./assets/img-3.png) + -4. Copy your Vaultwarden Tor Address from the Services menu on your Embassy and paste it into the “Self Hosted Environment” → “Server URL” field. -⚠ **Add “http://” (*not* https://) to the frontend of the onion URL.** -Then click “Save”. +4. Copy your Vaultwarden Tor Address from the Services menu on your Embassy and paste it into the “Self Hosted Environment” → “Server URL” field. + ⚠ **Add “http://” (_not_ https://) to the frontend of the onion URL.** + Then click “Save”. + ![](./assets/img-4.png) + 5. Click “Create Account” and fill in the required fields. -⚠ **This *does not* mean you are creating an account with Bitwarden or any other third party.** -You are creating an account with *yourself* on your own Embassy. +⚠ **This _does not_ mean you are creating an account with Bitwarden or any other third party.** +You are creating an account with _yourself_ on your own Embassy. In fact, your friends and family can also create accounts on your personal Vaultwarden. It’s awesome! + ![](./assets/img-5.png) + -6. Fill in an email address. This is *only* used for functions such as 2 Factor Authentication, and it will *only* be stored on your personal Embassy. -⚠ **This is unrelated to any accounts you might have on Bitwarden's premium service.** +6. Fill in an email address. This is _only_ used for functions such as 2 Factor Authentication, and it will _only_ be stored on your personal Embassy. + ⚠ **This is unrelated to any accounts you might have on Bitwarden's premium service.** 7. Fill in a new password for this Bitwarden account. It should be different from your Admin Token. @@ -62,12 +72,12 @@ It’s awesome! ## Important!! -Vaultwarden on the Embassy is a *self-hosted* password manager, which means your passwords physically live on your Embassy. Be sure to create backups and keep them safe. If you lose your Embassy or uninstall Vaultwarden, and you have not made a backup, all your passwords will be lost forever. +Vaultwarden on the Embassy is a _self-hosted_ password manager, which means your passwords physically live on your Embassy. Be sure to create backups and keep them safe. If you lose your Embassy or uninstall Vaultwarden, and you have not made a backup, all your passwords will be lost forever. ## System Administrator Portal -This portal enables you to configure environment settings, edit users, edit organizations and check version information. To use the admin portal: +This portal enables you to configure environment settings, edit users, edit organizations and check version information. To use the admin portal: 1. Copy the admin token from `Properties` 2. Navigate to your Vaultwarden Tor address + `/admin` ie. `http://.onion/admin` -3. Paste the admin token into the input field to login to the admin dashboard. +3. Paste the admin token into the input field to login to the admin dashboard. diff --git a/manifest.yaml b/manifest.yaml index 59bb590..e98f340 100644 --- a/manifest.yaml +++ b/manifest.yaml @@ -9,7 +9,6 @@ support-site: "https://vaultwarden.discourse.group/" marketing-site: "https://github.com/dani-garcia/vaultwarden/" donation-url: "https://www.paypal.com/paypalme/DaniGG" build: ["make"] -min-os-version: "0.3.0" description: short: Secure password management long: | @@ -30,8 +29,8 @@ main: io-format: yaml health-checks: alive: - name: Web Interface - description: Indicates that Vaultwarden is ready to use + name: Web UI + success-message: Vaultwarden is ready to use type: docker image: main entrypoint: check-web.sh