1
0
mirror of https://github.com/bitwarden/help synced 2026-01-07 19:13:59 +00:00

Promote to Master (#748)

* initial commit

* adding quotes for the array error

* Create Gemfile

* Create Gemfile.lock

* add .nvmrc and .node-version

* removed /article from URL

* update links to work with netlify

* more fixed links

* link fixes

* update bad links

* Update netlify.toml

toml test for redirects

* article redirect

* link fixes

* Update index.html

* Update netlify.toml

* Update _config.yml

* Update netlify.toml

* Update netlify.toml

* Update netlify.toml

* Update netlify.toml

* Update netlify.toml

* add article back into URL for launch

* Update netlify.toml

* Update netlify.toml

* add order to categories front matter

* Update netlify.toml

* update

* sidemenu update

* Revert "sidemenu update"

This reverts commit 5441c3d35c.

* update order prop

* Navbar updates per Gary and compiler warnings

* font/style tweaks

* Update sidebar.html

* Stage Release Documentation (#739)

* initial drafts

* rewrite Custom Fields article to prioritize new context-menu option & better organize ancillary information

* edit

* edit

* Custom Field Context Menu & CAPTCHA item in release notes

* SSO relink event

* update rn

* small edits

* improve release notes titles

* fix side menu

* Edits courtest of mportune!

* update order

* link fixes

* link cleanup

* image updates and a link

* fix trailing slash

Co-authored-by: DanHillesheim <79476558+DanHillesheim@users.noreply.github.com>
This commit is contained in:
fred_the_tech_writer
2021-09-21 13:21:11 -04:00
committed by GitHub
parent 63f78e8979
commit 906e2ca0dd
3304 changed files with 386714 additions and 8864 deletions

View File

@@ -5,13 +5,13 @@ categories: [hosting]
featured: false
popular: false
tags: [hosting, docker, admin]
order: 09
order: "09"
---
The Bitwarden System Administrator Portal can be used to:
- Check currently installed and latest available versions.
- View Environment Configuration settings (for more information, see [Configure Environment Variables]({% link _articles/hosting/environment-variables.md %})).
- View Environment Configuration settings (for more information, see [Configure Environment Variables]({{site.baseurl}}/article/environment-variables/)).
- View and delete registered users.
- View and delete registered Organizations.
@@ -33,7 +33,7 @@ These email addresses **do not** need to be registered with an account on your B
### Configure SMTP Mail Server
The System Adminstrator Portal uses email to provide secure links for authentication. Therefore, you will need to configure your installation's SMTP Mail Server settings prior to attempting to log in to the portal. For more information, see [Configure Environment Variables]({% link _articles/hosting/environment-variables.md %}).
The System Adminstrator Portal uses email to provide secure links for authentication. Therefore, you will need to configure your installation's SMTP Mail Server settings prior to attempting to log in to the portal. For more information, see [Configure Environment Variables]({{site.baseurl}}/article/environment-variables/).
## Access the Admin Portal

View File

@@ -5,7 +5,7 @@ categories: [hosting]
featured: false
popular: false
tags: [hosting, docker, backup]
order: 07
order: "07"
---
When self-hosting Bitwarden, you are responsible for implementing your own backup procedures in order to keep data safe.
@@ -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]({{site.baseurl}}/article/install-on-premise/#install-bitwarden).
## Backup Hosted Data

View File

@@ -5,10 +5,10 @@ categories: [hosting]
featured: false
popular: false
tags: [hosting, docker, install, deploy]
order: 04
order: "04"
---
This article defines the certificate options available to Self-hosted instances of Bitwarden. You will select your certificate option during installation. For installation instructions, see [Install and Deploy On-premise]({% link _articles/hosting/install-on-premise.md %}).
This article defines the certificate options available to Self-hosted instances of Bitwarden. You will select your certificate option during installation. For installation instructions, see [Install and Deploy On-premise]({{site.baseurl}}/article/install-on-premise/).
## Generate a Certificate with Let's Encrypt

View File

@@ -5,7 +5,7 @@ categories: [hosting]
featured: false
popular: false
tags: [hosting, environment]
order: 11
order: "11"
---
By default, Bitwarden client applications (Browser Extensions, Mobile Apps, etc.) will connect to Bitwarden-hosted servers. Client applications can be configured to connect to your self-hosted Bitwarden instance.

View File

@@ -5,7 +5,7 @@ categories: [hosting]
featured: true
popular: false
tags: []
order: 10
order: "10"
---
When operating a self-hosted Bitwarden server in a business setting, administrators may want to centrally configure client application settings (particularly, Server URL) before deploying to users with an endpoint management platform.

View File

@@ -5,7 +5,7 @@ categories: [hosting]
featured: false
popular: false
tags: [hosting, docker, install, deploy]
order: 05
order: "05"
---
Some features of Bitwarden are not configured by the `bitwarden.sh` installer. Configure these settings by editing the environment file, located at `./bwdata/env/global.override.env`. `global.override.env` comes pre-baked with configurable variables (see [Included Variables](#included-variables)), however there are additional variables which can be manually added (see [Optional Variables](#optional-variables)).
@@ -35,7 +35,7 @@ The following variables are among those that already exist in `global.override.e
|globalSettings__mail__smtp__password=|A valid password for the `smtp__host`.|
|globalSettings__disableUserRegistration=|Specify `true` to disable new users signing up for an account on this instance via the Registration page.|
|globalSettings__hibpApiKey=|Your HaveIBeenPwned (HIBP) API Key, available [here](https://haveibeenpwned.com/API/Key).|
|adminSettings__admins=|Email addresses which may access the [System Administrator Portal]({% link _articles/hosting/admin-portal.md%}).|
|adminSettings__admins=|Email addresses which may access the [System Administrator Portal]({{site.baseurl}}/article/admin-portal/).|
## Optional Variables

View File

@@ -5,10 +5,10 @@ categories: [hosting]
featured: false
popular: false
tags: [hosting, database, mssql]
order: 12
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}}/article/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.

View File

@@ -5,9 +5,9 @@ categories: [hosting]
featured: false
popular: false
tags: [hosting, docker, install, deploy]
order: 02
order: "02"
---
This article will walk you through the procedure to manually install and deploy Bitwarden to your own server. **Installation using the Bitwarden installation script is recommended for most users, for instructions see [Install and Deploy]({% link _articles/hosting/install-on-premise.md %})**.
This article will walk you through the procedure to manually install and deploy Bitwarden to your own server. **Installation using the Bitwarden installation script is recommended for most users, for instructions see [Install and Deploy]({{site.baseurl}}/article/install-on-premise/)**.
A manual installation may be appropriate if you are intimately familiar with Docker technologies and desire more control over your Bitwarden installation.
@@ -88,7 +88,7 @@ Complete the following steps to install Bitwarden manually:
9. Replace the domain placeholder in `./web/app-id.json` with your domain name.
10. Configure your Environment Variables in `./env/global.override.env`.
At a minimum, we recommend configuring you SMTP Mail Server and Admin Portal Access. For more information, see [Configure Environment Variables]({% link _articles/hosting/environment-variables.md %}).
At a minimum, we recommend configuring you SMTP Mail Server and Admin Portal Access. For more information, see [Configure Environment Variables]({{site.baseurl}}/article/environment-variables/).
11. Map the desired user and group id for the Bitwarden containers to run under at `./env/uid.env`. For example:

View File

@@ -5,7 +5,7 @@ categories: [hosting]
featured: false
popular: false
tags: [hosting, docker, install, deploy]
order: 01
order: "01"
---
This article will walk you through the procedure to install and deploy Bitwarden to your own server. Bitwarden can be installed and deployed on Linux, macOS, and Windows machines.
@@ -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?]({{site.baseurl}}/article/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 %}
@@ -140,24 +140,24 @@ Bitwarden provides a shell script for easy installation on Linux and macOS (Bash
Typically, this value should be the configured DNS record.
- **Do you want to use Let's Encrypt to generate a free SSL certificate? (y/n):**
Specify `y` to generate a trusted SSL certificate using Let's Encrypt. You will be prompted to enter an email address for expiration reminders from Let's Encrypt. For more information, see [Certificate Options]({% link _articles/hosting/certificates.md %}).
Specify `y` to generate a trusted SSL certificate using Let's Encrypt. You will be prompted to enter an email address for expiration reminders from Let's Encrypt. For more information, see [Certificate Options]({{site.baseurl}}/article/certificates/).
Alternatively, specify `n` and use the **Do you have a SSL certificate to use?** option.
- **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?]({{site.baseurl}}/article/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?]({{site.baseurl}}/article/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 %}).
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]({{site.baseurl}}/article/certificates/).
Alternatively, specify `n` and use the **self-signed SSL certificate?** option, which is only recommended for testing purposes.
- **Do you want to generate a self-signed SSL certificate? (y/n):**
Specify `y` to have Bitwarden generate a self-signed certificate for you. This option is only recommended for testing. For more information, see [Certificate Options]({% link _articles/hosting/certificates.md %}).
Specify `y` to have Bitwarden generate a self-signed certificate for you. This option is only recommended for testing. For more information, see [Certificate Options]({{site.baseurl}}/article/certificates/).
If you specify `n`, your instance will not use an SSL certificate and you will be required to front your installation with a HTTPS proxy, or else Bitwarden applications will not function properly.
@@ -210,7 +210,7 @@ After editing `global.override.env`, run one of the following commands to apply
.\bitwarden.ps1 -restart
For more information about configuring Environment Variables, see [Configure Environment Variables]({% link _articles/hosting/environment-variables.md %}).
For more information about configuring Environment Variables, see [Configure Environment Variables]({{site.baseurl}}/article/environment-variables/).
### Start Bitwarden

View File

@@ -5,13 +5,13 @@ categories: [hosting]
featured: false
popular: false
tags: [hosting, licensing]
order: 08
order: "08"
---
Self-hosting Bitwarden is free, however some features must be unlocked in your self-hosted instance with a registered license file. A license file can be obtained from the Bitwarden-hosted [Web Vault](https://vault.bitwarden.com){:target="\_blank"} by either an account with a Premium Individual subscription or by the Owner of an Organization.
{% callout info %}
The procedures in this article assume that you have already started a paid subscription to Bitwarden. If you haven't, refer to [About Bitwarden Plans]({% link _articles/plans-and-pricing/about-bitwarden-plans.md %}) and [What Plan is Right for Me?]({% link _articles/plans-and-pricing/what-plan-is-right-for-me.md %}).
The procedures in this article assume that you have already started a paid subscription to Bitwarden. If you haven't, refer to [About Bitwarden Plans]({{site.baseurl}}/article/about-bitwarden-plans/) and [What Plan is Right for Me?]({{site.baseurl}}/article/what-plan-is-right-for-me/).
{% endcallout %}
## Individual License
@@ -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}}/article/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}}/article/user-types-access-control/) to both retrieve and apply a license.
{% endcallout %}
#### Retrieve your License

View File

@@ -5,7 +5,7 @@ categories: [hosting]
featured: false
popular: false
tags: [hosting, docker, install, deploy]
order: 03
order: "03"
---
This article will walk you through procedures for transitioning from Cloud to Self-hosted, from Self-hosted to Cloud, and from one self-hosted server to another:
@@ -29,22 +29,22 @@ 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}}/article/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.
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}}/article/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.
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).
6. Still in your self-hosted Web Vault, upload your [license]({{site.baseurl}}/article/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/).
7. Still in the self-hosted Web Vault, import data to your [Personal Vault]({{site.baseurl}}/article/import-data/) or [Organization Vault]({{site.baseurl}}/article/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 %}
@@ -52,9 +52,9 @@ To migrate from the Cloud to a self-hosted server:
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/).
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).
3. Start [inviting users to your Organization]({{site.baseurl}}/article/managing-users/#invite) manually or using [Directory Connector]({{site.baseurl}}/article/directory-sync/).
{% endcapture %}
{{ mobile_info | markdownify}}
@@ -73,7 +73,7 @@ To migrate from a self-hosted server to the Cloud:
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/).
4. Still in the self-hosted Web Vault, import data to your [Personal Vault]({{site.baseurl}}/article/import-data/) or [Organization Vault]({{site.baseurl}}/article/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.
@@ -82,9 +82,9 @@ To migrate from a self-hosted server to the Cloud:
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/).
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).
3. Start [inviting users to your Organization]({{site.baseurl}}/article/managing-users/#invite) manually or using [Directory Connector]({{site.baseurl}}/article/directory-sync/).
{% endcapture %}
{{ desktop_info | markdownify}}

View File

@@ -5,7 +5,7 @@ categories: [hosting]
featured: false
popular: false
tags: [hosting, update]
order: 06
order: "06"
---
{% callout success %}
@@ -17,7 +17,7 @@ Please be aware that self-hosted server releases lag several days behind Cloud s
Additionally, newer versions of client applications may not support older versions of your self-hosted instance.
{% callout warning %}
We highly recommend backing up your data before updating your self-hosted instance. For more information, see [Backup your Hosted Data]({% link _articles/hosting/backup-on-premise.md %}).
We highly recommend backing up your data before updating your self-hosted instance. For more information, see [Backup your Hosted Data]({{site.baseurl}}/article/backup-on-premise/).
{% endcallout %}
Update your Bitwarden instance using the same Bash (Linux or macOS) or Powershell (Windows) script (`bitwarden.sh`) used to install Bitwarden. Run the following sequence of commands: