mirror of
https://github.com/bitwarden/help
synced 2026-01-06 02:23:22 +00:00
removed /article from URL
This commit is contained in:
DanHillesheim
@@ -14,7 +14,7 @@ When self-hosting Bitwarden, you are responsible for implementing your own backu
|
||||
|
||||
Bitwarden's Docker containers use volume mapping to persist all important data on the host machine, meaning stopping your containers will not delete any data. Docker containers, on the other hand, are to be considered ephemeral and do not persist data or state.
|
||||
|
||||
All Bitwarden data is stored on the host machine in the `./bwdata` directory, relative to the location in which you installed Bitwarden. For more information, see [Install and Deploy](https://bitwarden.com/help/article/install-on-premise/#install-bitwarden).
|
||||
All Bitwarden data is stored on the host machine in the `./bwdata` directory, relative to the location in which you installed Bitwarden. For more information, see [Install and Deploy](https://bitwarden.com/help/install-on-premise/#install-bitwarden).
|
||||
|
||||
## Backup Hosted Data
|
||||
|
||||
|
||||
@@ -46,7 +46,7 @@ Most Mobile Device Management (MDM) or Enterprise Mobility Management (EMM) solu
|
||||
To centrally configure the Desktop app for deployment, first complete the following steps on a single workstation:
|
||||
|
||||
1. Install the Desktop app. If you're using Windows, silent install Bitwarden using `installer.exe /S` (see [NSIS documentation](https://nsis.sourceforge.io/Docs/Chapter4.html#silent){:target="\_blank"}).
|
||||
2. Navigate to the Desktop app's locally stored settings. This directory is different depending on your OS (e.g. `%AppData%\Bitwarden` on Windows, `~/Library/Application Support/Bitwarden` on macOS). [Find your directory.]({{site.baseurl}}/article/data-storage/)
|
||||
2. Navigate to the Desktop app's locally stored settings. This directory is different depending on your OS (e.g. `%AppData%\Bitwarden` on Windows, `~/Library/Application Support/Bitwarden` on macOS). [Find your directory.]({{site.baseurl}}/data-storage/)
|
||||
3. In the directory, open the `data.json` file.
|
||||
4. Edit `data.json` to configure the Desktop app as desired. In particular, create the following object to configure the app with your self-hosted Server URL:
|
||||
|
||||
@@ -76,7 +76,7 @@ To centrally configure the Desktop app for deployment, first complete the follo
|
||||
|
||||
While it is possible to deploy Bitwarden Browser Extensions using an endpoint management solution like [Jamf](https://www.jamf.com/){:target="\_blank"} or Microsoft Endpoint Manager (formerly SCCM), it is currently **not possible** to alter the configuration in this way.
|
||||
|
||||
Instruct your end-users to follow [these steps]({{site.baseurl}}/article/change-client-environment/#browser-extensions-desktop-apps-and-mobile-apps) to connect a Browser Extension to your self-hosted server.
|
||||
Instruct your end-users to follow [these steps]({{site.baseurl}}/change-client-environment/#browser-extensions-desktop-apps-and-mobile-apps) to connect a Browser Extension to your self-hosted server.
|
||||
|
||||
{% endcapture %}
|
||||
{{ browser_extension | markdownify}}
|
||||
|
||||
@@ -22,7 +22,7 @@ The following variables are among those that already exist in `global.override.e
|
||||
|
||||
|Variable|Description|
|
||||
|--------|-----------|
|
||||
|globalSettings__sqlServer__connectionString=|Use this field to [connect to an exernal MSSQL database]({{site.baseurl}}/article/external-db/).|
|
||||
|globalSettings__sqlServer__connectionString=|Use this field to [connect to an exernal MSSQL database]({{site.baseurl}}/external-db/).|
|
||||
|globalSettings__oidcIdentityClientKey=|A randomly generated OpenID Connect client key. For more information, see [OpenID Documentation](https://openid.net/specs/openid-connect-registration-1_0.html#RegistrationResponse){:target="\_blank"}.|
|
||||
|globalSettings__duo__aKey=|A randomly generated Duo akey. For more information, see [Duo's Documentation](https://duo.com/docs/duoweb#1.-generate-an-akey){:target="\_blank"}.|
|
||||
|globalSettings__yubico__clientId=|Client ID for YubiCloud Validation Service or Self-hosted Yubico Validation Server.<br><br>If YubiCloud, get your Client ID and Secret Key [here](https://upgrade.yubico.com/getapikey/){:target="\_blank"}.<br><br>If self-hosted, see Optional Variable `globalSettings__yubico__validationUrls`.|
|
||||
|
||||
@@ -8,7 +8,7 @@ tags: [hosting, database, mssql]
|
||||
order: "12"
|
||||
---
|
||||
|
||||
By default, self-hosted instances of Bitwarden will use a Microsoft SQL Server (MSSQL) database created as a normal part of [installation setup]({{site.baseurl}}/article/install-on-premise), however you configure Bitwarden to use an external MSSQL database.
|
||||
By default, self-hosted instances of Bitwarden will use a Microsoft SQL Server (MSSQL) database created as a normal part of [installation setup]({{site.baseurl}}/install-on-premise), however you configure Bitwarden to use an external MSSQL database.
|
||||
|
||||
{% callout info %}
|
||||
Currently, self-hosted installations of Bitwarden support **only** MSSQL databases. Stay tuned for future updates on this topic.
|
||||
@@ -36,7 +36,7 @@ To setup your self-hosted instance with an external database:
|
||||
{% comment %}
|
||||
6. Run `./bitwarden.sh updatedb` to migrate the **database schema**.
|
||||
|
||||
{% callout success %}`updatedb` does not migrate data, it only migrates the database schema. To move existing data to the new database, [restore a backup]({{site.baseurl}}/article/backup-on-premise/#restore-a-nightly-backup) from `./bwdata/mssql/backups`.{% endcallout %}
|
||||
{% callout success %}`updatedb` does not migrate data, it only migrates the database schema. To move existing data to the new database, [restore a backup]({{site.baseurl}}/backup-on-premise/#restore-a-nightly-backup) from `./bwdata/mssql/backups`.{% endcallout %}
|
||||
{% endcomment %}
|
||||
|
||||
Once the above steps are complete, you can test the connection by creating a new user through the Web Vault and querying the external `vault` database for creation of the new user.
|
||||
|
||||
@@ -33,7 +33,7 @@ The following is a summary of the Installation Procedure in this article. Links
|
||||
2. [**Install Docker and Docker Compose**](#install-docker-and-docker-compose) on your machine, and complete the optional [**Docker Post-Installation**](#docker-post-installation-linux-only).
|
||||
3. Retrieve an installation id and key from [**https://bitwarden.com/host**](https://bitwarden.com/host){:target="_blank"} for use in installation.
|
||||
|
||||
For more information, see [What are my installation id and installation key used for?](https://bitwarden.com/help/article/hosting-faqs/#general).
|
||||
For more information, see [What are my installation id and installation key used for?](https://bitwarden.com/help/hosting-faqs/#general).
|
||||
4. [**Install Bitwarden**](#install-bitwarden) on your machine.
|
||||
5. [**Configure your Environment**](#configure-your-environment) by adjusting settings in `./bwdata/env/global.override.env`.
|
||||
{% callout success %}At a minimum, configure the `globalSettings__mail__smtp...` variables to setup an email server for inviting and verifying users.{% endcallout %}
|
||||
@@ -146,10 +146,10 @@ Bitwarden provides a shell script for easy installation on Linux and macOS (Bash
|
||||
|
||||
- **Enter your installation id:**
|
||||
|
||||
Retrieve an installation id using a valid email at [https://bitwarden.com/host](https://bitwarden.com/host). For more information, see [What are my installation id and installation key used for?](https://bitwarden.com/help/article/hosting-faqs/#general).
|
||||
Retrieve an installation id using a valid email at [https://bitwarden.com/host](https://bitwarden.com/host). For more information, see [What are my installation id and installation key used for?](https://bitwarden.com/help/hosting-faqs/#general).
|
||||
- **Enter your installation key:**
|
||||
|
||||
Retrieve an installation key using a valid email at [https://bitwarden.com/host](https://bitwarden.com/host). For more information, see [What are my installation id and installation key used for?](https://bitwarden.com/help/article/hosting-faqs/#general).
|
||||
Retrieve an installation key using a valid email at [https://bitwarden.com/host](https://bitwarden.com/host). For more information, see [What are my installation id and installation key used for?](https://bitwarden.com/help/hosting-faqs/#general).
|
||||
- **Do you have a SSL certificate to use? (y/n):**
|
||||
|
||||
If you already have your own SSL certificate, specify `y` and place the necessary files in the `.bwdata/ssl/your.domain` directory. You will be asked whether it is a trusted SSL certificate (y/n). For more information, see [Certificate Options]({% link _articles/hosting/certificates.md %}).
|
||||
|
||||
@@ -28,7 +28,7 @@ To retrieve your license from your Cloud account and apply it to your self-hoste
|
||||
|
||||
1. Log in to your self-hosted Web Vault with an email address that matches the Cloud-hosted account from which you downloaded the license.
|
||||
|
||||
{% callout success %}If you haven't already, verify your email address before proceeding. You will need to have [configured SMTP-related environment variables]({{site.baseurl}}/article/environment-variables) to do so.{% endcallout %}
|
||||
{% callout success %}If you haven't already, verify your email address before proceeding. You will need to have [configured SMTP-related environment variables]({{site.baseurl}}/environment-variables) to do so.{% endcallout %}
|
||||
2. Select the **Settings** tab from the top navigation.
|
||||
3. Select **Go Premium** from the left menu.
|
||||
4. In the License File section, select the **Browse...** button and add the downloaded license file.
|
||||
@@ -39,7 +39,7 @@ To retrieve your license from your Cloud account and apply it to your self-hoste
|
||||
To retrieve your Organization license from your Cloud Organization and apply it to you self-hosted server:
|
||||
|
||||
{% callout info %}
|
||||
You must be an [Organization Owner]({{site.baseurl}}/article/user-types-access-control) to both retrieve and apply a license.
|
||||
You must be an [Organization Owner]({{site.baseurl}}/user-types-access-control) to both retrieve and apply a license.
|
||||
{% endcallout %}
|
||||
|
||||
#### Retrieve your License
|
||||
@@ -65,4 +65,4 @@ Once downloaded, open your self-hosted Web Vault and update the license from the
|
||||
|
||||
{% image hosting/update-license.png Update a self-hosting license %}
|
||||
|
||||
If you receive a `version not supported` error message, you'll need to update your server before proceeding. Make a backup or copy of the `bwdata` directory, then follow [these instructions]({{site.baseurl}}/article/updating-on-premise/).
|
||||
If you receive a `version not supported` error message, you'll need to update your server before proceeding. Make a backup or copy of the `bwdata` directory, then follow [these instructions]({{site.baseurl}}/updating-on-premise/).
|
||||
|
||||
@@ -29,32 +29,32 @@ This article will walk you through procedures for transitioning from Cloud to Se
|
||||
|
||||
To migrate from the Cloud to a self-hosted server:
|
||||
|
||||
1. [Install and deploy]({{site.baseurl}}/article/install-on-premise) Bitwarden to your server. At a high-level, this procedure involves:
|
||||
1. [Install and deploy]({{site.baseurl}}/install-on-premise) Bitwarden to your server. At a high-level, this procedure involves:
|
||||
|
||||
1. [Configuring a domain]({{site.baseurl}}/article/install-on-premise/#configure-your-domain) for Bitwarden.
|
||||
2. Installing [Docker and Docker Compose]({{site.baseurl}}/article/install-on-premise/#install-docker-and-docker-compose).
|
||||
3. Running the [installation shell script]({{site.baseurl}}/article/install-on-premise/#install-bitwarden).
|
||||
4. [Configuring your environment]({{site.baseurl}}/article/install-on-premise/#configure-your-environment) to setup the Admin Portal, an SMTP Server connection, and more.
|
||||
1. [Configuring a domain]({{site.baseurl}}/install-on-premise/#configure-your-domain) for Bitwarden.
|
||||
2. Installing [Docker and Docker Compose]({{site.baseurl}}/install-on-premise/#install-docker-and-docker-compose).
|
||||
3. Running the [installation shell script]({{site.baseurl}}/install-on-premise/#install-bitwarden).
|
||||
4. [Configuring your environment]({{site.baseurl}}/install-on-premise/#configure-your-environment) to setup the Admin Portal, an SMTP Server connection, and more.
|
||||
2. Start your server by running `./bitwarden.sh start`.
|
||||
3. Open the Cloud Web Vault and [download your license]({{site.baseurl}}/article/licensing-on-premise).
|
||||
3. Open the Cloud Web Vault and [download your license]({{site.baseurl}}/licensing-on-premise).
|
||||
|
||||
{% callout success %}There are separate files for an [Organization license]({{site.baseurl}}/article/licensing-on-premise/#organization-license) and an [Individual license]({{site.baseurl}}/article/licensing-on-premise/#individual-license). **You don't need both license files.** If you're migrating an Organization, you only need to retrieve the Organization license and must be an [Organization Owner]({{site.baseurl}}/article/user-types-access-control/) to do so.{% endcallout %}
|
||||
4. Still in the Cloud Web Vault, [export your personal Vault data]({{site.baseurl}}/article/export-your-data/#export-a-personal-vault) or [export your Organization Vault data]({{site.baseurl}}/article/export-your-data/#export-an-organization-vault). If you're migrating an Organization, encourage your end-users to export their Personal Vaults as well.
|
||||
{% callout success %}There are separate files for an [Organization license]({{site.baseurl}}/licensing-on-premise/#organization-license) and an [Individual license]({{site.baseurl}}/licensing-on-premise/#individual-license). **You don't need both license files.** If you're migrating an Organization, you only need to retrieve the Organization license and must be an [Organization Owner]({{site.baseurl}}/user-types-access-control/) to do so.{% endcallout %}
|
||||
4. Still in the Cloud Web Vault, [export your personal Vault data]({{site.baseurl}}/export-your-data/#export-a-personal-vault) or [export your Organization Vault data]({{site.baseurl}}/export-your-data/#export-an-organization-vault). If you're migrating an Organization, encourage your end-users to export their Personal Vaults as well.
|
||||
5. Open your self-hosted Web Vault and create an account. This account **must use the same email address** as the Cloud account you downloaded the license with.
|
||||
5. Still in your self-hosted Web Vault, upload your [license]({{site.baseurl}}/article/licensing-on-premise).
|
||||
5. Still in your self-hosted Web Vault, upload your [license]({{site.baseurl}}/licensing-on-premise).
|
||||
|
||||
{% callout success %}There are separate locations in which to upload an [Organization license]({{site.baseurl}}/article/licensing-on-premise/#organization-license) versus an [Individual license]({{site.baseurl}}/article/licensing-on-premise/#individual-license). As before, only upload the one that's relevant for you.{% endcallout %}
|
||||
6. Still in the self-hosted Web Vault, import data to your [Personal Vault]({{site.baseurl}}/article/import-your-data/) or [Organization Vault]({{site.baseurl}}/article/import-to-org/).
|
||||
{% callout success %}There are separate locations in which to upload an [Organization license]({{site.baseurl}}/licensing-on-premise/#organization-license) versus an [Individual license]({{site.baseurl}}/licensing-on-premise/#individual-license). As before, only upload the one that's relevant for you.{% endcallout %}
|
||||
6. Still in the self-hosted Web Vault, import data to your [Personal Vault]({{site.baseurl}}/import-your-data/) or [Organization Vault]({{site.baseurl}}/import-to-org/).
|
||||
|
||||
{% callout info %}Importing data to an Organization will automatically re-create your [Collections]({{site.baseurl}}/article/about-collections/) and add the relevant Vault items to them.{% endcallout %}
|
||||
{% callout info %}Importing data to an Organization will automatically re-create your [Collections]({{site.baseurl}}/about-collections/) and add the relevant Vault items to them.{% endcallout %}
|
||||
|
||||
#### Organizations-only Next Steps
|
||||
|
||||
If you're migrating an Organization to a self-hosted server, continue with the following steps:
|
||||
|
||||
1. (**Enterprise Organizations Only**) Re-implement your [Enterprise Policy]({{site.baseurl}}/article/policies) specifications and/or configure [Login with SSO]({{site.baseurl}}/article/about-sso/).
|
||||
2. Manually [re-create user Groups]({{site.baseurl}}/article/about-groups/#create-a-group) in your self-hosted Web Vault and assign them to the proper Collections.
|
||||
3. Start [inviting users to your Organization]({{site.baseurl}}/article/managing-users/#invite) manually or using [Directory Connector]({{site.baseurl}}/article/directory-sync).
|
||||
1. (**Enterprise Organizations Only**) Re-implement your [Enterprise Policy]({{site.baseurl}}/policies) specifications and/or configure [Login with SSO]({{site.baseurl}}/about-sso/).
|
||||
2. Manually [re-create user Groups]({{site.baseurl}}/about-groups/#create-a-group) in your self-hosted Web Vault and assign them to the proper Collections.
|
||||
3. Start [inviting users to your Organization]({{site.baseurl}}/managing-users/#invite) manually or using [Directory Connector]({{site.baseurl}}/directory-sync).
|
||||
|
||||
{% endcapture %}
|
||||
{{ mobile_info | markdownify}}
|
||||
@@ -66,25 +66,25 @@ If you're migrating an Organization to a self-hosted server, continue with the f
|
||||
|
||||
To migrate from a self-hosted server to the Cloud:
|
||||
|
||||
1. Create a full backup of the `./bwdata` directory of your self-hosted Bitwarden server. In particular, you will need access to `./bwdata/core/attachments` to manually upload [file attachments]({{site.baseurl}}/article/attachments/) to the Cloud (**Step 5**).
|
||||
1. Create a full backup of the `./bwdata` directory of your self-hosted Bitwarden server. In particular, you will need access to `./bwdata/core/attachments` to manually upload [file attachments]({{site.baseurl}}/attachments/) to the Cloud (**Step 5**).
|
||||
|
||||
{% callout success %} If users are exporting their Personal Vaults over a period of time, you may need to re-sync the items from your `./bwdata/core/attachments` directory to your backup location and upload any new items in the event that they change during the cut-over period.{% endcallout %}
|
||||
2. In your self-hosted Web Vault, [export your personal Vault data]({{site.baseurl}}/article/export-your-data/#export-a-personal-vault) or [export your Organization Vault data]({{site.baseurl}}/article/export-your-data/#export-an-organization-vault). If you're migrating an Organization, encourage your end-users to export their Personal Vaults as well.
|
||||
2. In your self-hosted Web Vault, [export your personal Vault data]({{site.baseurl}}/export-your-data/#export-a-personal-vault) or [export your Organization Vault data]({{site.baseurl}}/export-your-data/#export-an-organization-vault). If you're migrating an Organization, encourage your end-users to export their Personal Vaults as well.
|
||||
3. Open the Cloud Web Vault. Most users will have previously created Cloud accounts for billing purposes, so log in to that account. If you were previously a free user without a Cloud account for billing, create an account now.
|
||||
|
||||
{% callout success %}If you're migrating an Organization, you'll already have a Cloud Organization established for billing and licensing purposes. For smoothest transition, we recommend using this already-established Organization rather than [creating a new one]({{site.baseurl}}/article/about-organizations/#create-an-organization).{% endcallout %}
|
||||
4. Still in the self-hosted Web Vault, import data to your [Personal Vault]({{site.baseurl}}/article/import-your-data/) or [Organization Vault]({{site.baseurl}}/article/import-to-org/).
|
||||
{% callout success %}If you're migrating an Organization, you'll already have a Cloud Organization established for billing and licensing purposes. For smoothest transition, we recommend using this already-established Organization rather than [creating a new one]({{site.baseurl}}/about-organizations/#create-an-organization).{% endcallout %}
|
||||
4. Still in the self-hosted Web Vault, import data to your [Personal Vault]({{site.baseurl}}/import-your-data/) or [Organization Vault]({{site.baseurl}}/import-to-org/).
|
||||
|
||||
{% callout info %}Importing data to an Organization will automatically re-create your [Collections]({{site.baseurl}}/article/about-collections/) and add the relevant Vault items to them.{% endcallout %}
|
||||
5. Manually upload [file attachments]({{site.baseurl}}/article/attachments/) to your Personal or Organization Vault.
|
||||
{% callout info %}Importing data to an Organization will automatically re-create your [Collections]({{site.baseurl}}/about-collections/) and add the relevant Vault items to them.{% endcallout %}
|
||||
5. Manually upload [file attachments]({{site.baseurl}}/attachments/) to your Personal or Organization Vault.
|
||||
|
||||
#### Organizations-only Next Steps
|
||||
|
||||
If you're migrating an Organization to the Cloud, continue with the following steps:
|
||||
|
||||
1. (**Enterprise Organizations Only**) Re-implement your [Enterprise Policy]({{site.baseurl}}/article/policies) specifications and/or configure [Login with SSO]({{site.baseurl}}/article/about-sso/).
|
||||
2. Manually [re-create user Groups]({{site.baseurl}}/article/about-groups/#create-a-group) in the Cloud and assign them to the proper Collections.
|
||||
3. Start [inviting users to your Organization]({{site.baseurl}}/article/managing-users/#invite) manually or using [Directory Connector]({{site.baseurl}}/article/directory-sync).
|
||||
1. (**Enterprise Organizations Only**) Re-implement your [Enterprise Policy]({{site.baseurl}}/policies) specifications and/or configure [Login with SSO]({{site.baseurl}}/about-sso/).
|
||||
2. Manually [re-create user Groups]({{site.baseurl}}/about-groups/#create-a-group) in the Cloud and assign them to the proper Collections.
|
||||
3. Start [inviting users to your Organization]({{site.baseurl}}/managing-users/#invite) manually or using [Directory Connector]({{site.baseurl}}/directory-sync).
|
||||
|
||||
{% endcapture %}
|
||||
{{ desktop_info | markdownify}}
|
||||
@@ -98,7 +98,7 @@ To migrate from one self-hosted Bitwarden server to another:
|
||||
|
||||
1. Stop your existing Bitwarden server by running `./bitwarden.sh stop`. When you run this command, Bitwarden will go down for anyone currently using it.
|
||||
2. Make a full copy of the `./bwdata` directory of the *old* server. This copy will be used to recreate your configuration, database, attachments, etc. on the new server.
|
||||
3. [Install and deploy]({{site.baseurl}}/article/install-on-premise/) Bitwarden to your new server.
|
||||
3. [Install and deploy]({{site.baseurl}}/install-on-premise/) Bitwarden to your new server.
|
||||
4. Once the new Bitwarden server is set up, replace the newly-created `./bwdata` directory with the copy from the old server.
|
||||
5. Print the new Bitwarden server's UID by running `id -u bitwarden`.
|
||||
6. Open the file `./bwdata/env/uid.env` and check that the listed values match what was printed in the previous step. If they do not match, replace *both* values with the result of `id -u bitwarden`.
|
||||
|
||||
Reference in New Issue
Block a user