Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
81 lines (52 sloc) 3.2 KB

appveyor build Join the chat at https://gitter.im/bitwarden/Lobby

Bitwarden Directory Connector

The Bitwarden Directory Connector is a a desktop application used to sync your Bitwarden enterprise organization to an existing directory of users and groups.

Supported directories:

  • Active Directory
  • Any other LDAP-based directory
  • Azure Active Directory
  • G Suite (Google)
  • Okta

The application is written using Electron with Angular and installs on Windows, macOS, and Linux distributions.

Platforms

Directory Connector

Command-line Interface

A command-line interface tool is also available for the Bitwarden Directory Connector. The Directory Connector CLI (bwdc) is written with TypeScript and Node.js and can also be run on Windows, macOS, and Linux distributions.

CLI Documentation

The Bitwarden Directory Connector CLI is self-documented with --help content and examples for every command. You should start exploring the CLI by using the global --help option:

bwdc --help

This option will list all available commands that you can use with the Directory Connector CLI.

Additionally, you can run the --help option on a specific command to learn more about it:

bwdc test --help
bwdc config --help

Detailed Documentation

We provide detailed documentation and examples for using the Directory Connector CLI in our help center at https://help.bitwarden.com/article/directory-sync/#command-line-interface.

Build/Run

Requirements

Run the app

npm install
npm run reset # Only necessary if you have previously run the CLI app
npm run rebuild
npm run electron

Run the CLI

npm install
npm run reset # Only necessary if you have previously run the desktop app
npm run build:cli:watch

You can then run commands from the ./build-cli folder:

node ./build-cli/bwdc.js --help

Contribute

Code contributions are welcome! Please commit any pull requests against the master branch. Learn more about how to contribute by reading the CONTRIBUTING.md file.

Security audits and feedback are welcome. Please open an issue or email us privately if the report is sensitive in nature. You can read our security policy in the SECURITY.md file.

You can’t perform that action at this time.