Directory Connector File Storage

The desktop app and CLI share a database and configurations, so simultaneous use on a single machine is not recommended. The recommended path is to complete configuration and testing using the desktop app, and subsequently using the CLI to schedule automatic syncing to your production organization.

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 app or CLI.

 Download a sample configuration file

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

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

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

BashCopy
Cannot autolaunch D-Bus without X11 $DISPLAY

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, for example by running sudo -H gedit /etc/environment:

BashCopy
BITWARDENCLI_CONNECTOR_PLAINTEXT_SECRETS=true

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