bitwarden/help
1
0
Fork 0
mirror of https://github.com/bitwarden/help synced 2026-01-06 02:23:22 +00:00
Code Issues Releases Wiki Activity

Staging (#294)

Browse Source 
* 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
2020-11-13 14:23:00 -08:00
committed by GitHub
parent ad353e2cf6
commit 80a0b17ac6
115 changed files with 5096 additions and 2674 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -8,44 +8,25 @@ hidden: false
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 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)
{%note%}
{% callout info %}
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.
After those are verified, you will want to make sure the UID and GID in the /bwdata/env/uid.env file are set to your bitwarden service account id numbers in Linux. When using the bitwarden service account you will also need to follow these steps:
After those are verified, you will want to make sure the UID and GID in the /bwdata/env/uid.env file are set to your bitwarden service account id numbers in Linux. When using the bitwarden service account you will also need to follow these steps:
1. Make sure the docker group has been created. sudo groupadd docker
2. Add the bitwarden account to the docker group sudo usermod -aG docker $USER
3. Create the bitwarden service file (may want to store it with your bitwarden installation) sudo vi bitwarden.service [Unit] Description=Bitwarden Requires=docker.service After=docker.service [Service] Type=oneshot User=bitwarden Group=bitwarden ExecStart={INSTALL_DIR}/bitwarden.sh start RemainAfterExit=true ExecStop= {INSTALL_DIR}/bitwarden.sh stop [Install] WantedBy=multi-user.target
4. Copy the bitwarden service file to systemd. sudo cp bitwarden.service /etc/systemd/system/bitwarden.service
5. Set permissions on bitwarden service file under systemd. sudo chmod 644 /etc/systemd/system/bitwarden.service
6. Optional (reload for testing) systemctl daemon-reload
7. Add service to start with system boot. sudo systemctl enable bitwarden.service
{%endnote%}
1. Make sure the docker group has been created. sudo groupadd docker
2. Add the bitwarden account to the docker group sudo usermod -aG docker $USER
3. Create the bitwarden service file (may want to store it with your bitwarden installation) sudo vi bitwarden.service [Unit] Description=Bitwarden Requires=docker.service After=docker.service [Service] Type=oneshot User=bitwarden Group=bitwarden ExecStart={INSTALL_DIR}/bitwarden.sh start RemainAfterExit=true ExecStop= {INSTALL_DIR}/bitwarden.sh stop [Install] WantedBy=multi-user.target
4. Copy the bitwarden service file to systemd. sudo cp bitwarden.service /etc/systemd/system/bitwarden.service
5. Set permissions on bitwarden service file under systemd. sudo chmod 644 /etc/systemd/system/bitwarden.service
6. Optional (reload for testing) systemctl daemon-reload
7. Add service to start with system boot. sudo systemctl enable bitwarden.service
{% endcallout %}
### 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.
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.
@@ -111,7 +92,7 @@ globalSettings__mail__replyToEmail=no-reply@bitwarden.domain.com
globalSettings__mail__smtp__host=smtp.gmail.com
globalSettings__mail__smtp__port=587
globalSettings__mail__smtp__ssl=false
globalSettings__mail__smtp__username=Gmail-username
globalSettings__mail__smtp__username=Gmail-username
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.
@@ -146,7 +127,7 @@ After the server is running and the Organization has been created and licensed,
Once you have completed the import, which will include the Collections, Items and their associations, you will need to set up the groups and users (there are several options so please check the relative links): <https://help.bitwarden.com/organizations/>
Please take note of the backup procedure: https://help.bitwarden.com/article/backup-on-premise/
Please take note of the backup procedure: https://help.bitwarden.com/article/backup-on-premise/
## Restore Bitwarden Server Detailed and Restore From Backup

88
_articles/faqs/product-faqs.md
View File

@@ -7,46 +7,10 @@ popular: true
hidden: false
tags: []
---
## Table of contents
- [**Q: How do I change a collection via the CLI?**](#q-how-do-i-change-a-collection-via-the-cli)
- [**Q: Can I install Bitwarden without Google Play?**](#q-can-i-install-bitwarden-without-google-play)
- [**Q: How do I enable Autofill in Android?**](#q-how-do-i-enable-autofill-in-android)
- [**Q: How do I view attachments?**](#q-how-do-i-view-attachments)
- [**Q: Can Bitwarden restore my individual vault?**](#q-can-bitwarden-restore-my-individual-vault)
- [**Q: How do I backup my self-hosted server?**](#q-how-do-i-backup-my-self-hosted-server)
- [**Q: How do I configure custom fields?**](#q-how-do-i-configure-custom-fields)
- [**Q: How do I import my data if I don’t see my service on the import options?**](#q-how-do-i-import-my-data-if-i-dont-see-my-service-on-the-import-options)
- [**Q: How do I delete an item?**](#q-how-do-i-delete-an-item)
- [**Q: Can I use Directory connector to sign into Bitwarden?**](#q-can-i-use-directory-connector-to-sign-into-bitwarden)
- [**Q: How can I disable Firefox Autofill?**](#q-how-can-i-disable-firefox-autofill)
- [**Q: Does Bitwarden have a way for me to let someone into my account if I am unable to log in?**](#q-does-bitwarden-have-a-way-for-me-to-let-someone-into-my-account-if-i-am-unable-to-log-in)
- [**Q: How can I enable Auto-fill On Page Load?**](#q-how-can-i-enable-auto-fill-on-page-load)
- [**Q: Does Bitwarden have an Encrypted Export File?**](#q-does-bitwarden-have-an-encrypted-export-file)
- [**Q: Can I download Bitwarden on F-Droid? I cannot find it.**](#q-can-i-download-bitwarden-on-f-droid-i-cannot-find-it)
- [**Q: How do I rename a folder?**](#q-how-do-i-rename-a-folder)
- [**Q: I have forgotten my master password, what can I do?**](#q-i-have-forgotten-my-master-password-what-can-i-do)
- [**Q: How do I hide passwords from users?**](#q-how-do-i-hide-passwords-from-users)
- [**Q: How can I see the history of a password that has been changed?**](#q-how-can-i-see-the-history-of-a-password-that-has-been-changed)
- [**Q: Can I see the history of the passwords I have generated?**](#q-can-i-see-the-history-of-the-passwords-i-have-generated)
- [**Q: Can I export/import from iCloud/Mac Keychain?**](#q-can-i-exportimport-from-icloudmac-keychain)
- [**Q: How do I enable iOS AutoFill?**](#q-how-do-i-enable-ios-autofill)
- [**Q: Why am I getting a ‘New Device’ Email Message?**](#q-why-am-i-getting-a-new-device-email-message)
- [**Q: Can I use SMS 2FA?**](#q-can-i-use-sms-2fa)
- [**Q: How do I install the Safari Extension?**](#q-how-do-i-install-the-safari-extension)
- [**Q: How can I start Bitwarden when Windows starts?**](#q-how-can-i-start-bitwarden-when-windows-starts)
- [**Q: How do I perform a sync on my application?**](#q-how-do-i-perform-a-sync-on-my-application)
- [**Q: What is TOTP and how can I use it?**](#q-what-is-totp-and-how-can-i-use-it)
- [**Q: Why are my TOTP codes incorrect/not working?**](#q-why-are-my-totp-codes-incorrectnot-working)
- [**Q: Why is U2F Not Supported on my iOS or Android App?**](#q-why-is-u2f-not-supported-on-my-ios-or-android-app)
- [**Q: How do I use the web browser extension?**](#q-how-do-i-use-the-web-browser-extension)
- [**Q: How do I add attachments?**](#q-how-do-i-add-attachments)
- [**Q: I am asked for my master password even though I have PIN unlock enabled on iOS / Android**](#q-i-am-asked-for-my-master-password-even-though-i-have-pin-unlock-enabled-on-ios--android)
- [**Q: How can I import items directly into collections?**](#q-how-can-i-import-items-directly-to-collections)
### **Q: How do I change a collection via the CLI?**
**A:** In order to change a Collection, you will use a dedicated command (bw edit item-collections).
**A:** In order to change a Collection, you will use a dedicated command (bw edit item-collections).
For example:
```
@@ -54,7 +18,7 @@ $ echo '["a17a5b7f-66b8-4980-91a1-aaac005df696"]' | bw encode | bw edit item-col
```
You can add multiple Collection IDs at the same time by using a comma to separate them.
### **Q: Can I install Bitwarden without Google Play?**
### **Q: Can I install Bitwarden without Google Play?**
**A:** Yes! You can download directly from GitHub <https://github.com/bitwarden/mobile/releases> or via F-Droid by adding our repo <https://mobileapp.bitwarden.com/fdroid/>
@@ -62,7 +26,7 @@ You can add multiple Collection IDs at the same time by using a comma to separat
**A:** There are two services that need to be enabled on Android to cover all Auto-fill scenarios, AUTO-FILL SERVICE and AUTO-FILL ACCESSIBILITY SERVICE. These services can be enabled from within the Bitwarden App under Settings.
When configured, you should see "Enabled" in green text. Double-check under the AUTO-FILL ACCESSIBILITY SERVICE that the Permission shows "Granted" in green text as well. https://help.bitwarden.com/article/auto-fill-android/
When configured, you should see "Enabled" in green text. Double-check under the AUTO-FILL ACCESSIBILITY SERVICE that the Permission shows "Granted" in green text as well. https://help.bitwarden.com/article/auto-fill-android/
One last thing you will want to check is the battery optimization settings on your phone and make sure it is turned off for Bitwarden. Often, Android Battery Optimization will turn off services to save battery and in turn kill the auto-fill services.
@@ -132,13 +96,13 @@ If you do not want to enable autofill when a page loads and still want the abili
Alternatively, we recommend using something like PeaZip to create an encrypted archive of the file after you have exported your data from Bitwarden.
You can learn more about PeaZip here:
- <http://www.peazip.org/>
- <https://github.com/giorgiotani/PeaZip >
You can learn more about PeaZip here:
- <http://www.peazip.org/>
- <https://github.com/giorgiotani/PeaZip >
{%warning%}
{% callout warning %}
Disclaimer: Please note that PeaZip is a third party program and is not supported by Bitwarden. These links were shared with you as an option for you to use at your own risk.
{%endwarning%}
{% endcallout %}
### **Q: Can I download Bitwarden on F-Droid? I cannot find it.**
@@ -165,9 +129,9 @@ You can learn more about access control here: <https://bitwarden.com/help/articl
The ability to view the password history of a Login Item is available. You can open the item in question and select the "1" next to Password History near the bottom of the window.
{%warning%}
{% callout warning %}
Clicking on the number will expose the historical password values in plain text immediately.
{%endwarning%}
{% endcallout %}
### **Q: Can I see the history of the passwords I have generated?**
@@ -178,12 +142,12 @@ Clicking on the number will expose the historical password values in plain text
**A:** There isn't an official way to export the data from iCloud, Mac Keychain or Safari as Apple doesn't provide this ability.
Here are some third-party programs available to export this data:
- <https://gist.github.com/rmondello/b933231b1fcc83a7db0b>
- <https://gist.github.com/rmondello/b933231b1fcc83a7db0b>
- <https://github.com/lifepillar/CSVKeychain>
{%warning%}
{% callout warning %}
Please note that these 3rd party scripts/programs are unsupported by Bitwarden and Apple and are used at your own risk.
{%endwarning%}
{% endcallout %}
Once you have exported your data, here is a helpful article for importing your data from the two mentioned programs: <https://help.bitwarden.com/article/import-data/>
@@ -191,7 +155,7 @@ Once you have exported your data, here is a helpful article for importing your d
**A:** Make sure Bitwarden is set to your AutoFill app by going to your iOS Settings > Passwords & Accounts > AutoFill Passwords > Bitwarden​.
While testing Bitwarden, it is best to only have Bitwarden enabled to avoid any conflicts. You can always set the Keychain or any other app back as an active option at any time if you choose to do so. Once you have that set, you can go to an app or site to log in and when you select the username or password field, the keyboard will display and the Passwords option will be selectable at the top of the keyboard. ​
While testing Bitwarden, it is best to only have Bitwarden enabled to avoid any conflicts. You can always set the Keychain or any other app back as an active option at any time if you choose to do so. Once you have that set, you can go to an app or site to log in and when you select the username or password field, the keyboard will display and the Passwords option will be selectable at the top of the keyboard. ​
You can see more about Bitwarden for iOS here: <https://bitwarden.com/help/article/getting-started-ios/>
@@ -220,9 +184,9 @@ Be sure to run the application once. If the extension still does not appear, it
### **Q: How can I start Bitwarden when Windows starts?**
In order to set Bitwarden Desktop to startup, please follow these steps:
1. Select the Start (Windows Logo) button, select All apps, and scroll to find the Bitwarden Desktop app/shortcut.
2. Right-click the Bitwarden Desktop app, select More, and then select Open file location.
3. With the file location open, press the Windows logo key + R, type shell:startup, then select OK. This opens the Startup folder.
1. Select the Start (Windows Logo) button, select All apps, and scroll to find the Bitwarden Desktop app/shortcut.
2. Right-click the Bitwarden Desktop app, select More, and then select Open file location.
3. With the file location open, press the Windows logo key + R, type shell:startup, then select OK. This opens the Startup folder.
4. Copy and paste the shortcut to the Bitwarden Desktop app from the file location to the Startup folder.
### **Q: How do I perform a sync on my application?**
@@ -233,10 +197,10 @@ In order to set Bitwarden Desktop to startup, please follow these steps:
**A:** Time-based One-time Password (TOTP) - <https://en.wikipedia.org/wiki/Time-based_One-time_Password_algorithm>
Each website that supports TOTP or 2FA with an "Authenticator" calls it differently and each handles the procedure of setting up a little differently. You will need to start the set up from each individual web site that you are accessing. (e.g. google.com, amazon.com).
Each website that supports TOTP or 2FA with an "Authenticator" calls it differently and each handles the procedure of setting up a little differently. You will need to start the set up from each individual web site that you are accessing. (e.g. google.com, amazon.com).
​1. You will want to edit any item that you wish to use TOTP with.
2. Populate the "Authenticator Key (TOTP)" field with the seed key you are provided with. *You can also use the Bitwarden mobile application to directly scan QR codes and it will populate automatically.
​1. You will want to edit any item that you wish to use TOTP with.
2. Populate the "Authenticator Key (TOTP)" field with the seed key you are provided with. *You can also use the Bitwarden mobile application to directly scan QR codes and it will populate automatically.
3. Save the changes.
Now, Bitwarden will store and generate the timed code that you will be asked for when logging into services with TOTP 2FA enabled. Here is a handy website that you can use to test this feature: <https://totp.danhersam.com/>
@@ -251,22 +215,22 @@ Whenever you auto-fill a website that has TOTP attached, the code will automatic
**A:** At this time, due to platform/OS limitations, FIDO U2F cannot be used with all Bitwarden applications. You should enable another two-step login provider so that you can access your account when FIDO U2F cannot be used. We are expanding our U2F capabilities
### **Q: How do I use the web browser extension?**
### **Q: How do I use the web browser extension?**
**A:** Using the Bitwarden Web Browser Extension is a good way to add your passwords to your vault. Anytime it detects a password field on a website that it doesn't have in its database, it will ask to save.
For updating, anytime there is a password field detected, when you enter a password if it doesn't detect the same password as what it has in its database then it will ask you to update it. You will see a banner at the top of the web page that will prompt you to save or update.
Please see this helpful article regarding interacting with a web page to fill your Login Item information:
Please see this helpful article regarding interacting with a web page to fill your Login Item information:
- <https://help.bitwarden.com/article/auto-fill-browser/>
Bitwarden Web Browser Extension video on YouTube:
- <https://youtu.be/dBPfr7Jiddw>
- <https://youtu.be/dBPfr7Jiddw>
More helpful videos from the Bitwarden Community on YouTube:
- <https://youtu.be/L1BNrVrvWw4>
- <https://youtu.be/TREdS8iq6Qg>
- <https://youtu.be/TREdS8iq6Qg>
- <https://youtu.be/uF6tzGYaIxg>
### **Q: How do I add attachments?**
@@ -297,6 +261,6 @@ To reset this:
**A:** To import items directly to collections, you'll want to format your import into a Bitwarden CSV and provide the collection names you'd like to import to. You can read more about the Bitwarden CSV import here: https://bitwarden.com/help/article/import-data/#generic-csv-format-organization-account
{%note%}
{% callout info %}
Each import will create new records. To prevent duplicates while organizing your data, you will want to use the `Purge Vault` option to clear any existing data before importing it again. The option can be found by logging into the Web Vault (https://vault.bitwarden.com/) and going to Settings > Organizations > {YOUR ORG NAME} > Settings sub-tab (Gears Icon) > My Organization > Danger Zone > Purge Vault.
{%endnote%}
{% endcallout %}

20
_articles/faqs/security-faqs.md
View File

@@ -8,22 +8,6 @@ hidden: false
tags: []
---
## Table of Contents
- [Compliance General](#compliance-general)
* [Current Certifications](#current-certifications)
* [GDPR](#gdpr)
* [SOC Certifications](#soc-certifications)
- [Desktop Electron Backdoor Concern](#desktop-electron-backdoor-concern)
- [Duo MFA / 2FA / Two-step Login Requirement](#duo-mfa-2fa-two-step-login-requirement)
- [New Device Not Recognized](#new-device-not-recognized)
- [Master Password Stored Locally?](#master-password-stored-locally)
- [Third party scripts, libraries, and services](#third-party-scripts-libraries-and-services)
- [Security General (Whitepaper, Audit report, etc.)](#security-general-whitepaper-audit-report-etc)
- [Self-signed Certificate Setup, On-premises/self-hosted](#self-signed-certificate-setup-on-premisesself-hosted)
- [Web Browser Extension Security/Safety Concern](#web-browser-extension-securitysafety-concern)
- [Web Browser Permission Request](#web-browser-permission-request)
## Compliance General
### Current Certifications
@@ -65,8 +49,8 @@ Currently, we load third-party payment scripts from Stripe and PayPal on payment
## Security General (Whitepaper, Audit report, etc.)
- Assessment Report: [Available here](https://cdn.bitwarden.net/misc/Bitwarden%20Security%20Assessment%20Report.pdf)
- Additional Reading (Security): <https://help.bitwarden.com/security/>
- Assessment Report: [Available here](https://cdn.bitwarden.net/misc/Bitwarden%20Security%20Assessment%20Report.pdf)
- Additional Reading (Security): <https://help.bitwarden.com/security/>
- HackerOne: <https://hackerone.com/bitwarden>
- GitHub Project: <https://github.com/bitwarden>