bitwarden/help
1
0
Fork 0
mirror of https://github.com/bitwarden/help synced 2025-12-10 05:13:43 +00:00
Code Issues Releases Wiki Activity

article updates

Browse Source
This commit is contained in:
Kyle Spearrin
2017-11-09 09:07:40 -05:00
parent a948829884
commit 1f7a028b65
4 changed files with 25 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
_articles/hosting/install-on-premise.md
View File

@@ -56,9 +56,11 @@ This article will walk you through how to install and deploy bitwarden to your o
## Configure Your Domain
bitwarden will be served through ports 80 (http) and 443 (https) on the localhost machine. You should open these ports so that bitwarden can be accessed from within and/or outside of the network.
By default, bitwarden will be served through ports 80 (http) and 443 (https) on the localhost machine. You should open these ports so that bitwarden can be accessed from within and/or outside of the network. You can choose different ports during installation if you like.
It you are serving bitwarden to the outside world you will need to configure a domain name with DNS records that point to your host machine (ex. bitwarden.company.com). You should configure this domain before beginning your bitwarden installation.
It you are serving bitwarden to the outside world you will need to configure a domain name with DNS records that point to your host machine (ex. bitwarden.company.com). *You should configure this domain before beginning your bitwarden installation.*
Alternatively, if you are only testing you can install bitwarden to the "localhost" domain.
## Install Docker
@@ -81,6 +83,10 @@ SQL Server requires that Docker be allocated with a minimum of 4 GB of RAM. By d
The default docker settings on **Linux** should be ok, but still requires that the host machine have a minimum of 3.25 GB of RAM.
{% note %}
A future SQL Server update is planned to reduce this RAM requirement by at least 50%.
{% endnote %}
## Install bitwarden
We've made installing bitwarden very simple. Depending in your environment (non-Windows vs. Windows) we provide Bash (Linux and macOS) and PowerShell (Windows) scripts to aide in installing and managing your bitwarden installation. The following steps will include references for both Bash and PowerShell.
@@ -150,12 +156,13 @@ Example:
```
globalSettings__yubico__clientId=294620155
globalSettings__yubico__key=YOUR_KEY
globalSettings__yubico__key=owdez88RdxVZuGbZ4fv
globalSettings__mail__smtp__host=smtp.sendgrid.net
globalSettings__mail__smtp__username=apikey
globalSettings__mail__smtp__password=SG.YOUR.API_KEY
globalSettings__mail__smtp__ssl=true
globalSettings__mail__smtp__port=587
globalSettings__mail__smtp__useDefaultCredentials=false
```
If you plan to use YubiKeys for two-step login, you can get your YubiKey client id and key at [https://upgrade.yubico.com/getapikey/](https://upgrade.yubico.com/getapikey/){:target="_blank"}.
@@ -210,7 +217,7 @@ PowerShell users will run the commands with a prefixed `-` (switch). For example
| start | Start all containers. |
| restart | Restart all containers (same as start). |
| stop | Stop all containers. |
| updatedb | Update the database. |
| updatedb | Update/initialize the database. |
| update | Update all containers and the database. |
| updateself | Update this main script. |

8
_articles/hosting/licensing-on-premise.md
View File

@@ -21,9 +21,9 @@ Using premium features of bitwarden in a self-hosted installation requires that
## Organization Account (Sharing)
The sharing features of bitwarden require that you create an organization account. To create an organization in an on-premise hosted bitwarden installation you must first obtain an **enterprise organization** license. Only enterprise organizations are eligible for on-premise hosting.
The sharing features of bitwarden require that you create an organization account. To create an organization in an on-premise hosted bitwarden installation you must first obtain a **families organization** (for personal use) or **enterprise organization** (for business use) license. Only families and enterprise organization plans are eligible for on-premise hosting.
1. If you haven't already, purchase an enterprise organization plan by logging in to your bitwarden.com account at <https://vault.bitwarden.com> and navigating to **Settings** &rarr; **New Organization**. If you would like to upgrade an existing organization account to the enterprise plan, please [contact bitwarden support](https://bitwarden.com/contact).
2. Download your enterprise organization license file from <https://vault.bitwarden.com> by navigating to your organization's admin area, and then **Settings** &rarr; **Billing &amp; Licensing** &rarr; **Download License**. Enter the [installation id]({% link _articles/hosting/install-on-premise.md %}#install-bitwarden) that matches your bitwarden installation.
1. If you haven't already, purchase a families or enterprise organization plan by logging in to your bitwarden.com account at <https://vault.bitwarden.com> and navigating to **Settings** &rarr; **New Organization**. If you would like to upgrade an existing organization account to a families or enterprise plan, please [contact bitwarden support](https://bitwarden.com/contact).
2. Download your families or enterprise organization license file from <https://vault.bitwarden.com> by navigating to your organization's admin area, and then **Settings** &rarr; **Billing &amp; Licensing** &rarr; **Download License**. Enter the [installation id]({% link _articles/hosting/install-on-premise.md %}#install-bitwarden) that matches your bitwarden installation. You can always locate your installation id in the `./bwdata/env/global.override.env` configuration file.
3. Log in to the web vault of your self-hosted bitwarden installation and navigate to **Settings** &rarr; **New Organization**.
5. Upload the license file that you downloaded in step 2 and your enterprise organization account will be created.
5. Upload the license file that you downloaded in step 2 and your organization account will be created.

8
_articles/hosting/updating-on-premise.md
View File

@@ -14,15 +14,15 @@ We have made updating your bitwarden installation very simple. Use the same bitw
{% icon fa-linux %} {% icon fa-apple %} Bash
./bitwarden.sh updateself
./bitwarden.sh stop
./bitwarden.sh update
./bitwarden.sh start
{% icon fa-windows %} PowerShell
.\bitwarden.ps1 -updateself
.\bitwarden.ps1 -stop
.\bitwarden.ps1 -update
.\bitwarden.ps1 -start
Your bitwarden installation should now be fully up to date and running.
{% tip %}
Create a cronjob or scheduled task to run these update commands weekly, or even nightly. This will automaticallty keep your installation up to date.
{% endtip %}