This will build a container for Google Cloud Directory Sync. A tool to synchronize user and group data from your local LDAP directory to Google Workspace.
- Executes synchronization routines on a scheduled basis
- Error detection with customizable notification endpoints
- Sends statistics to Zabbix Server
This image needs manual configuration to get started. You will need to manually create the configuration file on another system with the config-manager GCDS GUI before the scheduler will occur. You will also need to import an OAUTH Token into that configuration file that was generated from another machine as of GCDS 5.x versions.
- About
- Maintainer
- Table of Contents
- Prerequisites and Assumptions
- Installation
- Configuration
- Maintenance
- Contributions
- Support
- License
- References
- You have an active Google Workspace Account with appropriate Administration privileges.
Clone this repository and build the image with docker build <arguments> (imagename) .
Builds of the image are available on Docker Hub
docker pull docker.io/tiredofit/gcds:(latest)-
The quickest way to get started is using docker-compose. See the examples folder for a working compose.yml that can be modified for development or production use.
-
On another machine, you must setup Oauth tokens, as this container cannot set them up for you. You must enter
upgrade-config -exportkeys encrypted.key [password]on the source system. -
Get the contents of this new file and paste it in
OAUTH_TOKENenvironment variable or useupgrade-config -importkeys encrypted.key [password]inside the container. -
Set
MODEenvironment variables -
Set any environment variables to support scheduling or notifications
The following directories are used for configuration and can be mapped for persistent storage.
| Directory | Description |
|---|---|
/config/ |
Map this directory and place your GCDS .xml file here. State information is also stored here for encryption. |
/logs/ |
GCDS Log Output Directory |
This image relies on a Debian Linux base image that relies on an init system for added capabilities. Outgoing SMTP capabilities are handlded via msmtp. Individual container performance monitoring is performed by zabbix-agent. Additional tools include: bash,curl,less,logrotate,nano.
Be sure to view the following repositories to understand all the customizable options:
| Image | Description |
|---|---|
| OS Base | Customized Image based on debian Linux |
| Parameter | Description | Default |
|---|---|---|
AUTO_UPGRADE_CONFIG |
Automatically upgrade older versions configuration AND import OAUTH_TOKEN | FALSE |
CONFIG_PATH |
Configuration Path | /config/ |
CONFIG_FILE |
The name of your GCDS configuration file (e.g. config_file.xml) |
|
DOMAIN |
The Domain in question that is being synced | |
DRY_RUN |
Execute a Dry Run Test TRUE / FALSE |
TRUE |
FLUSH_REMOTE_DATA |
Enable Flushing of Data after Sync TRUE/FALSE |
FALSE |
MODE |
STANDALONE (Do Nothing) SCHEDULER (run at scheduled time) |
STANDALONE |
LOG_LEVEL |
GCDS Error Logging level (e.g. ERROR) |
INFO |
LOG_PATH |
Path where logs are kept | /logs/ |
LOG_FILE |
Name of Logfile to output | ${DOMAIN}-sync.log |
OAUTH_TOKEN |
Oauth Token string as recieved from another machine capable of exporting authentication information eg 3FD988... |
|
OAUTH_TOKEN_PASS |
If token has been encrypted, enter it here | |
SYNC_BEGIN |
What time to do the first sync. Defaults to immediate. Must be in one of two formats | +0 |
Absolute HHMM, e.g. 2330 or 0415 |
||
Relative +MM, i.e. how many minutes after starting the container, e.g. +0 (immediate), +10 (in 10 minutes), or +90 in an hour and a half |
||
SYNC_INTERVAL |
How often to sync, in minutes. | 60 |
| Parameter | Description | Default |
|---|---|---|
NOTIFICATION_TYPE |
CUSTOM EMAIL MATRIX MATTERMOST ROCKETCHAT - Seperate Multiple by commas |
The following is sent to the custom script. Use how you wish:
$1 unix timestamp
$2 logfile
$3 errorcode
$4 subject
$5 body/error message
| Parameter | Description | Default |
|---|---|---|
NOTIFICATION_CUSTOM_SCRIPT |
Path and name of custom script to execute notification. |
| Parameter | Description | Default |
|---|---|---|
MAIL_FROM |
What email address to send mail from for errors | |
MAIL_TO |
What email address to send mail to for errors. Send to multiple by seperating with comma. | |
SMTP_HOST |
What SMTP server to use for sending mail | |
SMTP_PORT |
What SMTP port to use for sending mail |
Fetch a MATRIX_ACCESS_TOKEN:
curl -XPOST -d '{"type":"m.login.password", "user":"myuserid", "password":"mypass"}' "https://matrix.org/_matrix/client/r0/login"
Copy the JSON response access_token that will look something like this:
{"access_token":"MDAxO...blahblah","refresh_token":"MDAxO...blahblah","home_server":"matrix.org","user_id":"@myuserid:matrix.org"}
| Parameter | Description | Default |
|---|---|---|
MATRIX_HOST |
URL (https://matrix.example.com) of Matrix Homeserver | |
MATRIX_ROOM |
Room ID eg \!abcdef:example.com to send to. Send to multiple by seperating with comma. |
|
MATRIX_ACCESS_TOKEN |
Access token of user authorized to send to room |
| Parameter | Description | Default |
|---|---|---|
MATTERMOST_WEBHOOK_URL |
Full URL to send webhook notifications to | |
MATTERMOST_RECIPIENT |
Channel or User to send Webhook notifications to. Send to multiple by seperating with comma. | |
MATTERMOST_USERNAME |
Username to send as eg GCDS |
| Parameter | Description | Default |
|---|---|---|
ROCKETCHAT_WEBHOOK_URL |
Full URL to send webhook notifications to | |
ROCKETCHAT_RECIPIENT |
Channel or User to send Webhook notifications to. Send to multiple by seperating with comma. | |
ROCKETCHAT_USERNAME |
Username to send as eg GCDS |
For debugging and maintenance purposes you may want access the containers shell.
docker exec -it (whatever your container name) bashVisit the inside of the container and execute sync-now
Welcomed. Please fork the repository and submit a pull request for any bug fixes, features or additions you propose to be included in the image. If it does not impact my intended usage case, it will be merged into the tree, tagged as a release and credit to the contributor in the CHANGELOG.
These images were built to serve a specific need in a production environment and gradually have had more functionality added based on requests from the community.
- The Discussions board is a great place for working with the community on tips and tricks of using this image.
- Sponsor me for personalized support.
- Please, submit a Bug Report if something isn't working as expected. I'll do my best to issue a fix in short order.
- Feel free to submit a feature request, however there is no guarantee that it will be added, or at what timeline.
- Sponsor me regarding development of features.
- Best effort to track upstream changes, More priority if I am actively using the image in a production environment.
- Sponsor me for up to date releases.
MIT. See LICENSE for more details.