bitwarden/help
1
0
Fork 0
mirror of https://github.com/bitwarden/help synced 2025-12-06 00:03:30 +00:00
Code Issues Releases Wiki Activity

tip tag and unhide directory sync article

Browse Source
This commit is contained in:
Kyle Spearrin
2017-05-24 09:54:51 -04:00
parent 5ccd6439ad
commit 82417cb172
2 changed files with 49 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
_articles/organizations/directory-sync.md
View File

@@ -4,7 +4,6 @@ title: Syncing users and groups with a directory
categories: [Organizations]
featured: true
popular: false
hidden: true
tags: []
---
@@ -61,16 +60,25 @@ Console.exe -e -p [[-t] [-o]]
1. Launch the Directory Connector console by double clicking the shortcut.
2. Select option 3 (Configure directory connection) from the main menu.
3. Select the type of directory server you are configuring.
4. Step through and set each configuration setting for the directory server type that you selected in step 3. The settings are different for each type of directory. You can read more about setting up each type of directory connection in the articles below:
- Active Directory & Other LDAP-based directories
- Azure Active Directory
- GSuite (Google)
### Configure sync options
1. Launch the Directory Connector console by double clicking the shortcut.
2. Select option 4 (Configure sync) from the main menu.
3. Step through and set each sync configuration setting. Some settings are dependent on the type of directory connection you are using.
### Manually simulate a sync
You can simulate a directory sync in order to check that all of your configuration settings are setup and working as expected. A sync simulation will query the directory server and print the results to the screen. The results that you see printed to the screen will be what is uploaded and synced to your bitwarden organization whenever a real sync is invoked.
1. Launch the Directory Connector console by double clicking the shortcut.
2. Select option 5 (Simulate directory sync) from the main menu.
3. Review the results that are printed in the console window for accuracy.
### Perform a sync
@@ -79,8 +87,30 @@ Console.exe -e -p [[-t] [-o]]
### Manage the background service
The background service allows sync operations to run in the background based on the interval set in your sync configuration.
1. Launch the Directory Connector console by double clicking the shortcut.
2. Select option 7 (Control background service) from the main menu.
3. Select the option you wish to perform: Start, Stop, or Check Status.
### Changing configurations
{% note %}
The application must be run in administrator mode to be able to manage the background service.
{% endnote %}
Alternatively, you can also manage the background service from the windows service manager window.
1. Open the windows start menu.
2. Search for "Services" and select the Services application.
- If you do not find the "Services" application by searching, you can also open it from the "Run" window by typing `services.msc`.
{% tip %}
You can configure the bitwarden Directory Connector to run automatically each time the machine starts. Use the windows service manager to set the bitwarden Directory Connector service to "Startup type: Automatic".
{% endtip %}
### Changing configurations manually
All configuration data is saved to a `.json` configuration file stored on the local computer. No configuration data in synced to bitwarden servers. You can find the configuration file in it's default location at `C:/ProgramData/bitwarden/Directory Connector/settings.json`. Any changes that you make directory to the configuration file will require you to restart the application (if it is currently running).
{% note %}
Some configuration data that is stored in the settings file, such as LDAP server credentials, is encrypted. Therefore, you cannot edit it directly in this file. Any encrypted data must be managed through the application normally.
{% endnote %}