diff --git a/poetry.lock b/poetry.lock index 0ec150a..e5498cb 100644 --- a/poetry.lock +++ b/poetry.lock @@ -2,14 +2,14 @@ [[package]] name = "alabaster" -version = "0.7.12" +version = "0.7.13" description = "A configurable sidebar-enabled Sphinx theme" category = "main" optional = false -python-versions = "*" +python-versions = ">=3.6" files = [ - {file = "alabaster-0.7.12-py2.py3-none-any.whl", hash = "sha256:446438bdcca0e05bd45ea2de1668c1d9b032e1a9154c2c259092d77031ddd359"}, - {file = "alabaster-0.7.12.tar.gz", hash = "sha256:a661d72d58e6ea8a57f7a86e37d86716863ee5e92788398526d58b26a4e4dc02"}, + {file = "alabaster-0.7.13-py3-none-any.whl", hash = "sha256:1ee19aca801bbabb5ba3f5f258e4422dfa86f82f3e9cefb0859b283cdd7f62a3"}, + {file = "alabaster-0.7.13.tar.gz", hash = "sha256:a27a4a084d5e690e16e01e03ad2b2e552c61a65469419b907243193de1a84ae2"}, ] [[package]] diff --git a/site/source/_static/images/services/vaultwarden/confirm-user.png b/site/source/_static/images/services/vaultwarden/confirm-user.png new file mode 100644 index 0000000..4ea7d5e Binary files /dev/null and b/site/source/_static/images/services/vaultwarden/confirm-user.png differ diff --git a/site/source/_static/images/services/vaultwarden/create-org.png b/site/source/_static/images/services/vaultwarden/create-org.png new file mode 100644 index 0000000..961253b Binary files /dev/null and b/site/source/_static/images/services/vaultwarden/create-org.png differ diff --git a/site/source/_static/images/services/vaultwarden/invite-user.png b/site/source/_static/images/services/vaultwarden/invite-user.png new file mode 100644 index 0000000..a73ae22 Binary files /dev/null and b/site/source/_static/images/services/vaultwarden/invite-user.png differ diff --git a/site/source/_static/images/services/vaultwarden/org-details.png b/site/source/_static/images/services/vaultwarden/org-details.png new file mode 100644 index 0000000..39420c8 Binary files /dev/null and b/site/source/_static/images/services/vaultwarden/org-details.png differ diff --git a/site/source/_static/images/services/vaultwarden/user-permissions.png b/site/source/_static/images/services/vaultwarden/user-permissions.png new file mode 100644 index 0000000..b6c292c Binary files /dev/null and b/site/source/_static/images/services/vaultwarden/user-permissions.png differ diff --git a/site/source/_static/images/services/vaultwarden/verify-user.png b/site/source/_static/images/services/vaultwarden/verify-user.png new file mode 100644 index 0000000..6d39bff Binary files /dev/null and b/site/source/_static/images/services/vaultwarden/verify-user.png differ diff --git a/site/source/user-manual/service-guides/index.rst b/site/source/user-manual/service-guides/index.rst index c03dbc0..5698f86 100644 --- a/site/source/user-manual/service-guides/index.rst +++ b/site/source/user-manual/service-guides/index.rst @@ -13,4 +13,4 @@ These guides will help you to setup external tools to connect or interact with s lightning matrix nextcloud/index - vaultwarden + vaultwarden/index diff --git a/site/source/user-manual/service-guides/vaultwarden.rst b/site/source/user-manual/service-guides/vaultwarden/bitwarden-clients.rst similarity index 85% rename from site/source/user-manual/service-guides/vaultwarden.rst rename to site/source/user-manual/service-guides/vaultwarden/bitwarden-clients.rst index 1490701..2bf3c57 100644 --- a/site/source/user-manual/service-guides/vaultwarden.rst +++ b/site/source/user-manual/service-guides/vaultwarden/bitwarden-clients.rst @@ -1,21 +1,16 @@ -.. _vaultwarden: +.. _bitwarden-clients: -=========== -Vaultwarden -=========== +================= +Bitwarden Clients +================= .. contents:: :depth: 2 :local: -Vaultwarden 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. If you currently have a *hosted* account with Bitwarden, you can export your data from that account and import it to your Vaultwarden service on Embassy using the built-in import/export features in any Bitwarden application. +.. _vaultwarden-webvault: -.. note:: The version of Bitwarden server used on the Embassy is a fork called "Vaultwarden." It functions with all of the apps/integrations that are built for, and still named after, "Bitwarden." We apologize for any confusion this may cause. - -Check out our `Vaultwarden video `_ for basic features and setup! - - .. youtube:: YcxxVHpm9j0 - :width: 100% +There are many ways to connect to and use your Vaultwarden server. Web Vault --------- @@ -31,9 +26,11 @@ Web Vault 5. Back at the main page for your vault, let's do a quick example login. We can setup a new folder here and save new login. For our example, we're going to use our FileBrowser instance. So click 'Add item,' then we'll fill in some test information. A name for the entry, a username, password, and the website we want to log in to. Then click 'Save.' +.. _vaultwarden-admin: + Accessing the Admin Console =========================== -You will find the Admin console by adding `/admin` to the end of your Vaultwarden WebUI URL, found in the "Interfaces" section of the Vaultwarden Service page. You will be prompted for your "Admin Token," which is also found on your Vaultwarden Service page under "Properties." +You will find the Admin console by adding ``/admin`` to the end of your Vaultwarden WebUI URL, found in the "Interfaces" section of the Vaultwarden Service page. You will be prompted for your "Admin Token," which is also found on your Vaultwarden Service page under "Properties." Browser Extension ----------------- diff --git a/site/source/user-manual/service-guides/vaultwarden/index.rst b/site/source/user-manual/service-guides/vaultwarden/index.rst new file mode 100644 index 0000000..b10fc1b --- /dev/null +++ b/site/source/user-manual/service-guides/vaultwarden/index.rst @@ -0,0 +1,22 @@ +.. _vaultwarden-service: + +=========== +Vaultwarden +=========== + +Vaultwarden 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. If you currently have a *hosted* account with Bitwarden, you can export your data from that account and import it to your Vaultwarden service on Embassy using the built-in import/export features in any Bitwarden application. + +.. note:: The version of Bitwarden server used on the Embassy is a fork called "Vaultwarden." It functions with all of the apps/integrations that are built for, and still named after, "Bitwarden." We apologize for any confusion this may cause. + +Check out our `Vaultwarden video `_ for basic features and setup! + + .. youtube:: YcxxVHpm9j0 + :width: 100% + +Follow the guides below to get the most out of your Vaultwarden server. + +.. toctree:: + :maxdepth: 1 + + bitwarden-clients + vaultwarden-organizations diff --git a/site/source/user-manual/service-guides/vaultwarden/vaultwarden-organizations.rst b/site/source/user-manual/service-guides/vaultwarden/vaultwarden-organizations.rst new file mode 100644 index 0000000..4dbda8f --- /dev/null +++ b/site/source/user-manual/service-guides/vaultwarden/vaultwarden-organizations.rst @@ -0,0 +1,50 @@ +.. _vaultwarden-organizations: + +======================== +Setting Up Organizations +======================== + +Creating an Organization +------------------------ + +If you want to share passwords amongst friends or family, you can do so using the "Organizations" feature of Vaultwarden. + +#. Inside your :ref:`Web Vault`, click `New Organization` + + .. figure:: /_static/images/services/vaultwarden/create-org.png + :width: 60% + +#. Give your organization a name and enter your email. ``Note``: You can enter whatever you want for email, even `fake@email.com`. Because you are self-hosting, the email is not used for anything at all. + + .. figure:: /_static/images/services/vaultwarden/org-details.png + :width: 60% + +Adding Others to Your Organization +---------------------------------- + +.. warning:: + After you have completed signed up new members to your Vaultwarden server, it is highly recommended that you disable new user signups inside your :ref:`Admin Dashboard` --> General Settings --> Allow new signups --> uncheck the box. + +#. Tell the user to create an account on your Vaultwarden server. This must be done *before* you invite them. + +#. Inside the Organization page, click Manage --> `Invite User` + + .. figure:: /_static/images/services/vaultwarden/invite-user.png + :width: 60% + +#. Decide what permissions you want the member to have and click "Save". In the below example, the member will be a manager and have access to all collections. + + .. figure:: /_static/images/services/vaultwarden/user-permissions.png + :width: 60% + +#. The new member should automatically show as "Accepted". Now, click the settings icon on the right and click "Confirm" + + .. figure:: /_static/images/services/vaultwarden/confirm-user.png + :width: 60% + +#. You will be presented with a fingerprint phrase. The new member can verify this phrase inside their own dashboard, but because you are self-hosting and adding users manually, you can just click "Confirm". + + .. figure:: /_static/images/services/vaultwarden/verify-user.png + :width: 60% + +The new member should now be able to see the organization in their own dashboard or client apps.