1
0
mirror of https://github.com/bitwarden/help synced 2025-12-06 00:03:30 +00:00
Files
help/_articles/directory-connector/directory-sync-shared.md
fred_the_tech_writer 906e2ca0dd Promote to Master (#748)
* initial commit

* adding quotes for the array error

* Create Gemfile

* Create Gemfile.lock

* add .nvmrc and .node-version

* removed /article from URL

* update links to work with netlify

* more fixed links

* link fixes

* update bad links

* Update netlify.toml

toml test for redirects

* article redirect

* link fixes

* Update index.html

* Update netlify.toml

* Update _config.yml

* Update netlify.toml

* Update netlify.toml

* Update netlify.toml

* Update netlify.toml

* Update netlify.toml

* add article back into URL for launch

* Update netlify.toml

* Update netlify.toml

* add order to categories front matter

* Update netlify.toml

* update

* sidemenu update

* Revert "sidemenu update"

This reverts commit 5441c3d35c.

* update order prop

* Navbar updates per Gary and compiler warnings

* font/style tweaks

* Update sidebar.html

* Stage Release Documentation (#739)

* initial drafts

* rewrite Custom Fields article to prioritize new context-menu option & better organize ancillary information

* edit

* edit

* Custom Field Context Menu & CAPTCHA item in release notes

* SSO relink event

* update rn

* small edits

* improve release notes titles

* fix side menu

* Edits courtest of mportune!

* update order

* link fixes

* link cleanup

* image updates and a link

* fix trailing slash

Co-authored-by: DanHillesheim <79476558+DanHillesheim@users.noreply.github.com>
2021-09-21 13:21:11 -04:00

3.2 KiB

layout, title, categories, featured, popular, tags, order
layout title categories featured popular tags order
article Directory Connector File Storage
directory-connector
true false
04

The Directory Connector Desktop Application and CLI share the same database and configuration settings. You may install and use both applications, however it is not recommended to use them simultaneously.

{% callout success %} Though not required, it may be helpful to use the Desktop Application first to setup and configure all of your settings before using the Directory Connector CLI. {% endcallout %}

Config File

The Directory Connector configuration file (data.json) contains objects you may directly edit in order to:

  • Set the connection to your Directory
  • Configure Sync Options

It is not possible to setup the entirety of Directory Connector from data.json. Authentication values, like keys or secrets, must be set from either the Desktop Application or CLI.

{% icon fa-download %} Download a sample configuration file

{% callout warning %} Avoid opening or modifying data.json while the Directory Connector Desktop Application or CLI executable is running. {% endcallout %}

Location

The location of data.json depends on which platform is in use:

  • Windows : %AppData%\Bitwarden Directory Connector
    • Portable: .\bitwarden-connector-appdata
  • macOS: ~/Library/Application Support/Bitwarden Directory Connector
  • Linux: ~/.config/Bitwarden Directory Connector

{% callout success %} Using the Directory Connector CLI, run the data-file command to discover the absolute path to the data.json. {% endcallout %}

Secret Storage

By default, the Directory Connector Desktop Application and CLI both use a secure method for persisting sensitive data (such as your directory account password, API keys, etc).

On Linux systems this requires GNOME Keyring{:target="_blank"} and X11{:target="_blank"}, which are usually reserved for desktop environments. If you are using a headless Linux environment you may encounter errors such as:

Cannot autolaunch D-Bus without X11 $DISPLAY

Secret Storage in Headless Environments

If a secure storage environment is not available, you can configure the Directory Connector CLI to use plaintext storage of secrets. To do so, set the following environment variable to override secure storage:

BITWARDENCLI_CONNECTOR_PLAINTEXT_SECRETS=true

With plaintext storage enabled, you can then configure all settings directly, in plaintext, from the data.json configuration file.

{% callout info %} Plaintext storage of secrets is not compatible with the Directory Connector desktop application. You should only use the Directory Connector CLI with plaintext storage of secrets. {% endcallout %}