Skip to main content

Enviroment Variables

Environment VariableDescriptionExample Value
SLEEP_TIMETime interval between update checks (default: 5 minutes)5m
IGNORELIST_SERVICESSpace-separated list of services to ignore during updatesshepherd my-other-service
FILTER_SERVICESFilter for specifying services to update (matches docker service ls filter)label=com.mydomain.autodeploy
ROLLBACK_ON_FAILURERoll back a service to the previous version if an update failstrue
UPDATE_OPTIONSAdditional options for the docker service update command--update-delay=30s
TIMEOUTTimeout for the docker service update process (default: 5 minutes)300
APPRISE_SIDECAR_URLURL for the Apprise sidecar service to enable update notificationsapprise-microservice:5000
IMAGE_AUTOCLEAN_LIMITEnable old image autocleaning on service update5
RUN_ONCE_AND_EXITRun Shepherd once and then exittrue
WITH_REGISTRY_AUTHEnable private registry authenticationtrue
REGISTRY_USER / REGISTRY_PASSWORDCredentials for private registry authenticationuser123 / secret_password
REGISTRIES_FILEPath to the secret file containing multiple registry authentication entries/var/run/secrets/shepherd-registries-auth
WITH_INSECURE_REGISTRYEnable connection to an insecure private registrytrue
WITH_NO_RESOLVE_IMAGEPrevent pulling images from the registrytrue
TZSet the timezone for log entriesEurope/Zurich