6b98a46b94
* Pull in jslib * Bump engines required to node 16 and npm 8 * Bump @types/node to 16 The dep on node 14.18 will get cleaned up once we bump electron * Modify build.yml to build with node 16 and npm 8 * Update requirements in README.md * Use pkg-fetch 3.2.5 to retrieve node 16.13.0 * Change pkg-fetch version back to 3.2 * Bump keytar to 7.7.0 * Add missing package-lock.json for src-cli * Bump keytar to 7.7.0 in src/package.json * Add missing package-lock.json in src/ * Bump pkg to 5.5.1 * Modify download url for keytar * Replace Mac and Win keytar download urls
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.
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
- Node.js v16.13.1 (LTS)
- Windows users: To compile the native node modules used in the app you will need the Visual C++ toolset, available through the standard Visual Studio installer (recommended) or by installing
windows-build-toolsthroughnpm. See more at Compiling native Addon modules.
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.