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

added environment and clearcache docs

Browse Source
This commit is contained in:
Kyle Spearrin
2017-11-10 16:07:36 -05:00
parent 1f7a028b65
commit ff69da8a97
1 changed files with 38 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
_articles/directory-connector/directory-sync.md
View File

@@ -37,6 +37,8 @@ You can install and run Directory Connector on the server that hosts your direct
- [Manually simulate a sync](#manually-simulate-a-sync)
- [Perform a sync](#perform-a-sync)
- [Manage the background service](#manage-the-background-service)
- [Configure environment](#configure-environment)
- [Clear sync cache](#clear-sync-cache)
- [Changing configurations manually](#changing-configurations-manually)
- [Source code](#source-code)
@@ -277,6 +279,42 @@ Alternatively, you can also manage the background service from the windows servi
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 %}
### Configure environment
By default the Directory Connector communicates with the bitwarden public cloud servers. If you are using a self-hosted deployment of bitwarden you will want to change the configured environment endpoints of the Directory Connector to your own on-premise installation.
1. Launch the Directory Connector console by double clicking the shortcut.
2. Select option 8 (Configure environment) from the main menu.
3. Enter your installation's API and Identity endpoints. For example, if your installation's domain is `bitwarden.company.com` your API and Identity endpoints would be `https://bitwarden.company.com/api` and `https://bitwarden.company.com/identity` respectively.
Optionally, from the command line:
```
Console.exe env [-api] [-id]
```
| Description | Argument | Example Value | Required |
|-----------------|----------|----------------------------------------|----------|
| API Server | -api | https://bitwarden.company.com/api | n |
| Identity Server | -id | https://bitwarden.company.com/identity | n |
### Clear sync cache
As the Directory Connector works at syncing changes up to your bitwarden organization it keeps a local cache. This cache helps the Directory Connector only send the difference in directory changes from the previous time that it performed a sync operation. If you encounter sync errors or a particular directory change is not correctly being synced, you may need to clear this cache. Clearing the cache will allow a full sync to occur during the next sync operation.
1. Launch the Directory Connector console by double clicking the shortcut.
2. Select option 9 (Clear sync cache) from the main menu.
Optionally, from the command line:
```
Console.exe clearcache
```
{% tip %}
You can also perform a "forced" sync by using the `-f` command as described in the **Perform a sync** section above. i.e. `Console.exe sync -f`. This command will ignore the local cache.
{% 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).