bitwarden/help
1
0
Fork 0
mirror of https://github.com/bitwarden/help synced 2026-01-07 19:13:59 +00:00
Code Issues Releases Wiki Activity

fixed TOC links (#185)

Browse Source
This commit is contained in:
Trey Greer
2020-09-15 13:16:50 -04:00
committed by GitHub
parent 998f617b9b
commit d42725b1fe
2 changed files with 46 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
_articles/faqs/billing-faqs.md
View File

@@ -10,17 +10,17 @@ tags: []
## Table of Contents
- [**Q: How can I add an extra user to my Families Plan?**](#--q--how-can-i-add-an-extra-user-to-my-families-plan---)
- [**Q: How do I add or remove a user seat from my organization?**](#--q--how-do-i-add-or-remove-a-user-seat-from-my-organization---)
- [**Q: Can I pay with Bitcoin?**](#--q--can-i-pay-with-bitcoin---)
- [**Q: How do I get started with my organization?**](#--q--how-do-i-get-started-with-my-organization---)
- [**Q: What payments do you accept for customers outside the US?**](#--q--what-payments-do-you-accept-for-customers-outside-the-us---)
- [**Q: What payments do you accept for customers based in the United States?**](#--q--what-payments-do-you-accept-for-customers-based-in-the-united-states---)
- [**Q: How do I update my Organization license for my upcoming renewal?**](#--q--how-do-i-update-my-organization-license-for-my-upcoming-renewal---)
- [**Q: Where in my account do I enter tax information (VAT)?**](#--q--where-in-my-account-do-i-enter-tax-information--vat----)
- [**Q: Where in my account can I view my subscription plan?**](#--q--where-in-my-account-can-i-view-my-subscription-plan---)
- [**Q: Where in my account can I view Billing information?**](#--q--where-in-my-account-can-i-view-billing-information---)
- [**Q: How do I delete my account?**](#--q--how-do-i-delete-my-account---)
- [**Q: How can I add an extra user to my Families Plan?**](#q-how-can-i-add-an-extra-user-to-my-families-plan)
- [**Q: How do I add or remove a user seat from my organization?**](#q-how-do-i-add-or-remove-a-user-seat-from-my-organization)
- [**Q: Can I pay with Bitcoin?**](#q-can-i-pay-with-bitcoin)
- [**Q: How do I get started with my organization?**](#q-how-do-i-get-started-with-my-organization)
- [**Q: What payments do you accept for customers outside the US?**](#q-what-payments-do-you-accept-for-customers-outside-the-us)
- [**Q: What payments do you accept for customers based in the United States?**](#q-what-payments-do-you-accept-for-customers-based-in-the-united-states)
- [**Q: How do I update my Organization license for my upcoming renewal?**](#q-how-do-i-update-my-organization-license-for-my-upcoming-renewal)
- [**Q: Where in my account do I enter tax information (VAT)?**](#q-where-in-my-account-do-i-enter-tax-information--vat)
- [**Q: Where in my account can I view my subscription plan?**](#q-where-in-my-account-can-i-view-my-subscription-plan)
- [**Q: Where in my account can I view Billing information?**](#q-where-in-my-account-can-i-view-billing-information)
- [**Q: How do I delete my account?**](#q-how-do-i-delete-my-account)
### **Q: How can I add an extra user to my Families Plan?**

70
_articles/faqs/hosting-faqs.md
View File

@@ -10,24 +10,24 @@ tags: []
## Table of Contents
- [**Bitwarden Server service/user account and (optional: systemd service configuration**)](#bitwarden-server-service-user-account-and--optional--systemd-service-configuration-)
* [**Certificate Setup for Private CA, On-premises/self-hosted**](#--certificate-setup-for-private-ca--on-premises-self-hosted--)
* [**Certificate Setup for Public CA, On-premises/self-hosted**](#--certificate-setup-for-public-ca--on-premises-self-hosted--)
* [**Change Server Name**](#--change-server-name--)
* [**Gmail self-hosted config**](#--gmail-self-hosted-config--)
* [**High Availability**](#--high-availability--)
* [**Let's Encrypt Manual Update (issue or domain/server name change)**](#--let-s-encrypt-manual-update--issue-or-domain-server-name-change---)
* [**Migrate cloud to on-premise**](#--migrate-cloud-to-on-premise--)
- [**Restore Bitwarden Server Detailed (Restore Backup)**](#--restore-bitwarden-server-detailed--restore-backup---)
* [**Custom Server Ports**](#--custom-server-ports--)
* [**SMTP Config w/ Mail Service Options**](#--smtp-config-w--mail-service-options--)
* [**Trust a private CA issued or Self-signed certificate for Bitwarden Client**](#--trust-a-private-ca-issued-or-self-signed-certificate-for-bitwarden-client--)
* [**Q: When does an Organization Invitation expire?**](#--q--when-does-an-organization-invitation-expire---)
* [**Q: When does an Offline Vault session expire:**](#--q--when-does-an-offline-vault-session-expire---)
* [**Q: When does a “Remember Me” 2FA selection:**](#--q--when-does-a--remember-me--2fa-selection---)
* [**Q: How long are Event Logs stored:**](#--q--how-long-are-event-logs-stored---)
- [Bitwarden Server service/user account and optional systemd service configuration)](#bitwarden-server-service-user-account-and-optional-systemd-service-configuration)
* [Certificate Setup for Private CA, on-premises or self-hosted](#certificate-setup-for-private-ca-on-premises-or-self-hosted)
* [Certificate Setup for Public CA, On-premises and self-hosted](#certificate-setup-for-public-ca-on-premises-and-self-hosted)
* [Change Server Name](#change-server-name)
* [Gmail self-hosted config](#gmail-self-hosted-config)
* [High Availability](#high-availability)
* [Let's Encrypt Manual Update - issue or domain and server name change](#let-s-encrypt-manual-update-issue-or-domain-and-server-name-change)
* [Migrate cloud to on-premise](#migrate-cloud-to-on-premise)
- [Restore Bitwarden Server Detailed and Restore From Backup](#restore-bitwarden-server-detailed-and-restore-from-backup)
* [Custom Server Ports](#custom-server-ports)
* [SMTP Config with Mail Service Options](#smtp-config-with-mail-service-options)
* [Trust a private CA issued or Self-signed certificate for Bitwarden Client](#trust-a-private-ca-issued-or-self-signed-certificate-for-bitwarden-client)
* [Q: When does an Organization Invitation expire?](#q-when-does-an-organization-invitation-expire)
* [Q: When does an Offline Vault session expire?](#q-when-does-an-offline-vault-session-expire)
* [Q: How long does an application Remember Me for 2FA?](#q--how-long-does-an-application-remember-me-for-2fa)
* [Q: How long are Event Logs stored?](#q-how-long-are-event-logs-stored)
## Bitwarden Server service/user account and (optional: systemd service configuration)
## Bitwarden Server service/user account and optional systemd service configuration)
{%note%}
You will want to configure the Bitwarden Server to use a `bitwarden` service account. $USER=bitwarden You will want to have your installation owned by the bitwarden service account, and you should be logged in as bitwarden.
@@ -43,7 +43,7 @@ After those are verified, you will want to make sure the UID and GID in the /bwd
7. Add service to start with system boot. sudo systemctl enable bitwarden.service
{%endnote%}
### **Certificate Setup for Private CA, On-premises/self-hosted**
### Certificate Setup for Private CA, on-premises or self-hosted
When configuring your server you will need to have three files, private key, server cert, and the CA cert then you will configure their path in the config.yml file in the Bitwarden installation directory.
@@ -66,7 +66,7 @@ private.key`
```
Please make sure all of your CA certificates are all included in the CA certificate chain file if you have a Root CA and Intermediate CA certificate.
### **Certificate Setup for Public CA, On-premises/self-hosted**
### Certificate Setup for Public CA, On-premises and self-hosted
You will need to create a private key for the Bitwarden server. Then you can generate a CSR. You can use OpenSSL to accomplish this. Once you have generated the CSR then you can provide it to the Certificate Authority you are using to provide your server/site certificate. After you generate your key and certs, place them in the ./bwdata/ssl directory. Then you will need to map them in ./bwdata/config.yml. When configuring your server, you will need to have three files, private key, server cert, and the ca-cert then you will configure their path in the config.yml file in the Bitwarden installation directory. The path that is defined in the config.yml is actually the location inside the NGINX container. The directory on the host is mapped to the container so you will actually want to make sure your correct certificate related files are under the ./bwdata/ssl/ directory. You should only ever need to work with the files under ./bwdata/ssl/, you do not want to work with files directly inside any container. It should line up like this (bitwarden.domain.local is only an example):
@@ -84,7 +84,7 @@ private.key
```
Please make sure all of your CA certificates are all included in the CA certificate chain file if you have a Root CA and Intermediate CA certificate.
### **Change Server Name**
### Change Server Name
In order to change the server name of your Bitwarden Server, you will need to configure the `url` in the `./bwdata/config.yml` with the new server name and the run the ./bitwarden.sh rebuild command. Next you will want to make sure the new name or FQDN has been set on all the `globalSettings__baseServiceUri__` variables in the `./bwdata/env/global.override.env` file. You will also need to make sure your certificate contains a Subject Alternative Name (SAN) with the new server FQDN.
@@ -103,7 +103,7 @@ openssl dhparam -out ./bwdata/letsencrypt/live/<your.domain.com>/dhparam.pem 204
./bitwarden.sh start
```
### **Gmail self-hosted config**
### Gmail self-hosted config
You can configure your Bitwarden Server to send email using your Gmail account by configuring these variable in the ./bwdata/env/global.override.env file. (Please note, with ssl=false it will default to use TLS)
```
@@ -116,11 +116,11 @@ globalSettings__mail__smtp__password=Gmail-password
```
If you are using Two-Step Authentication with your Gmail account then you will need to generate an app-specific password for use with Bitwarden. You can generate an app-specific password by signing in to your Google and following their instructions. Once you have the app-specific password, enter it into Bitwarden's SMTP configuration in the ./bwdata/env/global.override.env file.
### **High Availability**
### High Availability
High availability can be achieved by either configuring multiple instances of the containers into a Docker Swarm, Kubernetes, etc. environment and/or you can point the database connection string that the containers reference to any MSSQL database or cluster. Then you would probably want to load balance the NGINX containers or however you choose to handle the front-end.
### **Let's Encrypt Manual Update (issue or domain/server name change)**
### Let's Encrypt Manual Update - issue or domain and server name change
```
./bitwarden.sh stop
@@ -135,7 +135,7 @@ openssl dhparam -out ./bwdata/letsencrypt/live/<your.domain.com>/dhparam.pem 204
./bitwarden.sh rebuild
./bitwarden.sh start
```
### **Migrate cloud to on-premise**
### Migrate cloud to on-premise
In order to migrate your data from a Bitwarden Cloud account to a self-hosted Bitwarden Server, you will want to follow the on-premise installation instructions:
<https://help.bitwarden.com/article/install-on-premise/>
@@ -148,7 +148,7 @@ Once you have completed the import, which will include the Collections, Items an
Please take note of the backup procedure: https://help.bitwarden.com/article/backup-on-premise/
## **Restore Bitwarden Server Detailed (Restore Backup)**
## Restore Bitwarden Server Detailed and Restore From Backup
Do you have a full backup of the entire Bitwarden Server directory (bwdata)? If so you can simply copy that back to the server and run the normal start command.
@@ -183,11 +183,11 @@ Password: (Please note, you will want to get the database sa password from the /
You can now exit the container and then you will not need to restart the Bitwarden Server as normal.
### **Custom Server Ports**
### Custom Server Ports
To use custom ports instead of 80 and 443, you will need to set the new ports in the config.yml and then run the rebuild command (./bitwarden.sh rebuild). Next you will want to make sure the custom https port has been set on all the globalSettings__baseServiceUri__ variables in the ./bwdata/env/global.override.env file.
### **SMTP Config w/ Mail Service Options**
### SMTP Config with Mail Service Options
- Have you already configured an SMTP server in your Bitwarden's ./bwdata/env/global.override.env file? You will want to check the post-install steps which cover SMTP configuration:
<https://help.bitwarden.com/article/install-on-premise/#post-install-environment-configuration>
@@ -196,7 +196,7 @@ If you edit the ./bwdata/env/global.override.env file on your server, you will w
- Do you currently have a mail server or a mail service you currently use which can relay email from your Bitwarden server? If you don't then you may want to consider a service such as Mailgun (<https://www.mailgun.com/>) or SparkPost (<https://www.sparkpost.com/>) which allows for many relayed emails for free per month.
### **Trust a private CA issued or Self-signed certificate for Bitwarden Client**
### Trust a private CA issued or Self-signed certificate for Bitwarden Client
When using a self-signed certificate, you will need to add the certificate to your OS's Trusted Root Certification Authorities Store. Are you running the Directory Connector on Windows or Linux? If you are using Windows then you can simply run certmgr.msc and then import the certificate into the correct store/folder. If you are using Linux then you will want to add the certificate to these directories:
```
@@ -220,18 +220,18 @@ export `NODE_EXTRA_CA_CERTS=/path/to/cert/ca.crt`
Windows:
`NODE_EXTRA_CA_CERTS | C:\path\to\cert\ca.crt`
### **Q: When does an Organization Invitation expire?**
### Q: When does an Organization Invitation expire?
**A:** 5 days (If self-hosting it can be configured with globalSettings__organizationInviteExpirationHours=120)
**A:** 5 days (If self-hosting it can be configured with `globalSettings__organizationInviteExpirationHours=120`)
### **Q: When does an Offline Vault session expire:**
### Q: When does an Offline Vault session expire?
**A:** 30 days except for mobile is 90 days
**A:** 90 days for mobile apps, other clients are 30 days.
### **Q: When does a “Remember Me” 2FA selection:**
### Q: How long does an application Remember Me for 2FA?
**A:**30 days
**A:** 30 days
### **Q: How long are Event Logs stored:**
### Q: How long are Event Logs stored?
**A:** A retention policy is not configurable at this time.