#########################################################
# This is the Docker-compose file for Keeper Automator.
#
# Keeper Automator automates some admin-level tasks
# for Keeper installations.
#
# Last updated: Automator 3.0.0, 2023-08-24
#
# How to run:
# $ docker compose pull
# $ docker compose up -d
# $ docker cp your-ssl-certificate.pfx Automator:/usr/mybin/config/ssl-certificate.pfx
# $ docker restart Automator
# $ docker logs -f Automator
# -- Then use Commander to setup-init-enable the Automator.
#
# How to update:
# $ docker compose pull
# $ docker compose up -d
# -- No further setup should be needed if the Automator was previously configured.
#########################################################
# Docker Compose schema version
version: "3.7"
# Customers can change this
name: keeper-automator
# Customers can change the container_name, both port numbers, and the environment variables.
# If you change the internal Docker port number (the rightmost one), you must also change it
# in the settings/keeper.properties file or in the AUTOMATOR_PORT environment variable in this file.
# Using an environment variable will override the corresponding setting in the keeper.properties file.
services:
automator:
container_name: "automator"
environment:
- AUTOMATOR_PORT=443
- AUTOMATOR_HOST=localhost
# - DISABLE_SNI_CHECK=false
# - EMAIL_DOMAINS=
# - ENABLE_RATE_LIMITS=false
# - FILTER_BY_EMAIL_DOMAINS=false
# - IP_ALLOW=
# - IP_DENY=
# - SSL_CERTIFICATE=<base64-encoded-pfx-file>
# - SSL_CERTIFICATE_FILE=/config/ssl-certificate.pfx
# - SSL_CERTIFICATE_FILE_PASSWORD=/config/ssl-certificate-password.txt
# - SSL_CERTIFICATE_KEY_PASSWORD=
# - SSL_MODE=certificate
# - AUTOMATOR_DEBUG=false
restart: on-failure
image: "keeper/automator:latest"
ports:
- 8089:443
volumes:
- automatordata:/usr/mybin/config
volumes:
automatordata:
# -------------------------------------------------
# Default settings for all environment variables
# -------------------------------------------------
# AUTOMATOR_DEBUG=false -- turn on/off debug logging in Automator
# AUTOMATOR_HOST=localhost -- domain name or IP address
# AUTOMATOR_PORT=443 -- port number that the Automator listens on
# DISABLE_SNI_CHECK=false -- disable SNI check for SSL certificates
# EMAIL_DOMAINS= -- comma-separated list of email domains to consider
# ENABLE_RATE_LIMITS=false -- Rate limits on API calls to the Automator
# FILTER_BY_EMAIL_DOMAINS=false -- see EMAIL_DOMAINS
# IP_ADDRESS_ALLOW= -- comma-separated list of IP addresses, checked first
# IP_ADDRESS_DENY= -- comma-separated list of IP addresses
# SSL_CERTIFICATE=<base64-encoded-pfx-file> -- this overrides the SSL_CERTIFICATE_FILE setting
# SSL_CERTIFICATE_FILE=/config/ssl-certificate.pfx
# SSL_CERTIFICATE_FILE_PASSWORD=/config/ssl-certificate-password.txt
# -- contains the password for the SSL_CERTIFICATE_FILE
# SSL_CERTIFICATE_KEY_PASSWORD=/config/ssl-certificate-password.txt
# -- if used, must be the same as the file password due to a library limitation
# SSL_MODE=certificate -- other values are "self_signed" and "none"
# -------------------------------------------------------------
# How to turn on/off debug logging when running Automator in Docker
# -------------------------------------------------------------
# Replace 'automator' with the actual name of your automator docker container
#
# ON: set the AUTOMATOR_DEBUG environment variable to true and restart the container
# or
# $ docker exec automator sed -ie 's/info/debug/g' /usr/mybin/settings/log4j2.xml
# $ docker restart automator
#
# OFF: set the AUTOMATOR_DEBUG environment variable to false and restart the container
# or
# $ docker exec automator sed -ie 's/debug/info/g' /usr/mybin/settings/log4j2.xml
# $ docker restart automator
