mirror of
https://github.com/bitwarden/help
synced 2026-01-08 11:33:45 +00:00
Staging (#294)
* jekyll redirect from * Organizations rev (#262) * Organizations revisions initial commit. * API doc updates * Fix absolute link causing build failure. * Add import to org article, and downstream order changes. * Bitwarden 101 videos: 1st steps toward proliferating these throughout /help. * Added 'Create Your Account' article, which references B101 Videos. * About SSO redirect & promote importing for orgs up the list * Create Org FAQs & trim Feature FAQs accordingly. * Image for Org FAQs * Move 'About the Business Portal' to Orgs category, and re-order accordingly. * Final edits. * Dchoi/bootstrap upgrade (#264) * bootstrap 4 upgrade and cleanup update gulp tasks * bootstrap package updates * renaming file convention * general outline of help outline * bitwarden help cleanup * article cleanup * article general styling complete * bootstrap help page upgrades * sidebar updates * Dchoi/bootstrap upgrade (#267) * bootstrap 4 upgrade and cleanup update gulp tasks * bootstrap package updates * renaming file convention * general outline of help outline * bitwarden help cleanup * article cleanup * article general styling complete * bootstrap help page upgrades * sidebar updates * toc dynamic and more updates * fix callout conditions * sidebar collapse functionality added * sidebar header toggle functionality * sidebar article fixes * Update sidebar.html Fix sidebar Release Notes link. * Update releasenotes.md Remove unnecessary category tag. * Delete release-notes.md Remove unnecessary category. * Update why-choose-bitwarden-for-your-team.md Test table image differentiation * Update why-choose-bitwarden-for-your-team.md Second image differentiation test * removed links from category breadcrumb and replaced with badges Co-authored-by: fred_the_tech_writer <69817454+fschillingeriv@users.noreply.github.com>
This commit is contained in:
David Choi
GitHub
@@ -16,9 +16,9 @@ As the system administrator of your Bitwarden installation you can use the **Adm
|
||||
- Browse all organizations and information about them
|
||||
- Delete organizations
|
||||
|
||||
{% note %}
|
||||
{% callout info %}
|
||||
Admins cannot globally view sensitive data that is protected (encrypted) in a user's or organization's vault.
|
||||
{% endnote %}
|
||||
{% endcallout %}
|
||||
|
||||
The admin portal for your installation is available at https://bitwarden.example.com/admin.
|
||||
|
||||
@@ -40,6 +40,6 @@ adminSettings__admins=
|
||||
|
||||
The admin portal uses a secure means of *passwordless authentication*. When a user attempts to log into the admin portal a secure link is sent to their email address. The user can click this temporary link to continue logging into the admin portal. The authentication link is active for up to **15 minutes** following the log in attempt.
|
||||
|
||||
{% note %}
|
||||
{% callout info %}
|
||||
Since the admin portal uses email to provide secure links for authentication, you need to [configure your installation's SMTP mail settings]({% link _articles/hosting/install-on-premise.md %}) prior to attempting to log into the admin portal.
|
||||
{% endnote %}
|
||||
{% endcallout %}
|
||||
|
||||
@@ -9,18 +9,6 @@ tags: [hosting, docker, install, deploy]
|
||||
|
||||
This article will walk you through how to install and deploy Bitwarden to your own server. Because Bitwarden is a cross platform application, you can install and deploy it on Linux, macOS, and Windows machines.
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [TL;DR](#tldr)
|
||||
- [System Requirements](#recommended-minimum-system-requirements)
|
||||
- [Configure Your Domain](#configure-your-domain)
|
||||
- [Install Docker](#install-docker)
|
||||
- [Install Bitwarden](#install-bitwarden)
|
||||
- [Post-install Environment Configuration](#post-install-environment-configuration)
|
||||
- [Start Bitwarden](#start-bitwarden)
|
||||
- [Script Commands](#script-commands)
|
||||
- [Manual Docker Installations](#manual-docker-installations)
|
||||
|
||||
## TL;DR
|
||||
|
||||
1. Set DNS records for a domain name pointing to your machine. Open ports 80 and 443 on the machine.
|
||||
@@ -78,9 +66,9 @@ See the following official Docker documentation for more information:
|
||||
- [Install Docker](https://docs.docker.com/engine/installation/){:target="_blank"}
|
||||
- [Install Docker Compose](https://docs.docker.com/compose/install/){:target="_blank"}
|
||||
|
||||
{% note %}
|
||||
{% callout info %}
|
||||
Some Docker installations such as Windows and macOS already come with Docker Compose installed.
|
||||
{% endnote %}
|
||||
{% endcallout %}
|
||||
|
||||
For reference, you can find the official Bitwarden images hosted on Docker Hub at [https://hub.docker.com/u/bitwarden/](https://hub.docker.com/u/bitwarden/){:target="_blank"}.
|
||||
|
||||
@@ -90,7 +78,7 @@ We've made installing Bitwarden very simple. Depending on your environment (non-
|
||||
|
||||
1. Download the main Bitwarden script to your machine in the desired location:
|
||||
|
||||
{% note %}All Bitwarden assets will be installed in the `./bwdata` directory relative to where the main Bitwarden script resides.{% endnote %}
|
||||
{% callout info %}All Bitwarden assets will be installed in the `./bwdata` directory relative to where the main Bitwarden script resides.{% endcallout %}
|
||||
|
||||
{% icon fa-linux %} {% icon fa-apple %} Bash
|
||||
|
||||
@@ -178,9 +166,9 @@ If you plan to use YubiKeys for two-step login, you can get your YubiKey client
|
||||
|
||||
Once you've completed installing and configuring your Bitwarden installation you can start it up:
|
||||
|
||||
{% note %}
|
||||
{% callout info %}
|
||||
The first time you start Bitwarden it may take some time as it downloads all of the images from Docker Hub.
|
||||
{% endnote %}
|
||||
{% endcallout %}
|
||||
|
||||
{% icon fa-linux %} {% icon fa-apple %} Bash
|
||||
|
||||
@@ -202,9 +190,9 @@ Congratulations! Bitwarden is now up and running at `https://your.domain.com`. V
|
||||
|
||||
The Bitwarden main script (`bitwarden.sh` or `bitwarden.ps1`) has the following commands available:
|
||||
|
||||
{% note %}
|
||||
{% callout info %}
|
||||
PowerShell users will run the commands with a prefixed `-` (switch). For example `.\bitwarden.ps1 -start`.
|
||||
{% endnote %}
|
||||
{% endcallout %}
|
||||
|
||||
{% table %}
|
||||
|
||||
@@ -228,11 +216,11 @@ PowerShell users will run the commands with a prefixed `-` (switch). For example
|
||||
|
||||
Using the provided installation script is the recommended approach for most users, however, you can also install and configure Bitwarden manually using Docker and Docker Compose. A manual installation may be appropriate if you are intimately familiar with Docker technologies and desire more control over your Bitwarden installation. A manual installation follows most of the same steps that the installation script performs for you automatically.
|
||||
|
||||
{% warning %}
|
||||
{% callout warning %}
|
||||
Manual installations are for advanced users only.
|
||||
|
||||
Manual installations lose the ability to automatically update certain dependencies of the Bitwarden installation. As you upgrade from one version of Bitwarden to the next you will be responsible for changes to required environment variables, changes to nginx `default.conf`, changes to `docker-compose.yml`, etc. We will try to highlight these in the [release notes on GitHub](https://github.com/bitwarden/server/releases){:target="_blank"}. You can also monitor changes to the [dependency templates](https://github.com/bitwarden/server/tree/master/util/Setup/Templates){:target="_blank"} used by the Bitwarden installation script on GitHub.
|
||||
{% endwarning %}
|
||||
{% endcallout %}
|
||||
|
||||
1. Download a stubbed version of Bitwarden's dependencies (`docker-stub.zip`) from the [releases pages on GitHub](https://github.com/bitwarden/server/releases){:target="_blank"}.
|
||||
2. Create a new directory named `bwdata` and extract the `docker-stub.zip` archive to it. The directory structure provided matches what the `./docker/docker-compose.yml` file's mapped volumes expect, however, you are free to change the location of these mappings on the host machine if desired.
|
||||
@@ -250,7 +238,7 @@ Manual installations lose the ability to automatically update certain dependenci
|
||||
Make sure that you provide your `IDENTITY_CERT_PASSWORD` to the application's environment variables at `./env/global.override.env`.
|
||||
6. Copy your SSL certificate and keys to the `./ssl` directory. By default, this directory is mapped to the nginx container at `/etc/ssl`. The `./nginx/default.conf` can be adjusted to utilize these certificates as desired.
|
||||
|
||||
{% note %}Accessing the Bitwarden web vault and APIs via HTTPS is required. You should provide a trusted SSL certificate to the nginx container or front the installation with a proxy that provides a HTTPS endpoint to Bitwarden client applications.{% endnote %}
|
||||
{% callout info %}Accessing the Bitwarden web vault and APIs via HTTPS is required. You should provide a trusted SSL certificate to the nginx container or front the installation with a proxy that provides a HTTPS endpoint to Bitwarden client applications.{% endcallout %}
|
||||
|
||||
Example self-signed certificate:
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ popular: false
|
||||
tags: [hosting, update]
|
||||
---
|
||||
|
||||
It is very important to keep your Bitwarden installation up to date. Updates may include fixes that are important for the security of your Bitwarden installation. Additionally, newer versions of client applications such as the browser extension and/or mobile apps may not support older versions of your self-hosted Bitwarden server.
|
||||
It is very important to keep your Bitwarden installation up to date. Updates may include fixes that are important for the security of your Bitwarden installation. Additionally, newer versions of client applications such as the browser extension and/or mobile apps may not support older versions of your self-hosted Bitwarden server.
|
||||
|
||||
We have made updating your Bitwarden installation very simple. Use the same Bitwarden Bash (macOS and Linux) or PowerShell (Windows) script that you obtained while installing Bitwarden to your server to update your Bitwarden installation. Run the following sequence of commands:
|
||||
|
||||
@@ -23,6 +23,6 @@ We have made updating your Bitwarden installation very simple. Use the same Bitw
|
||||
|
||||
Your Bitwarden installation should now be fully up to date and running.
|
||||
|
||||
{% tip %}
|
||||
{% callout success %}
|
||||
Create a cronjob or scheduled task to run these update commands weekly, or even nightly. This will automatically keep your installation up to date.
|
||||
{% endtip %}
|
||||
{% endcallout %}
|
||||
|
||||
Reference in New Issue
Block a user