ansible-role-docker-container-stirlingpdf

Role to run stirlingpdf in a docker container

Table of content

• Requirements
• Default Variables
  • docker_container_stirlingpdf_comparisons
  • docker_container_stirlingpdf_env
  • docker_container_stirlingpdf_image
  • docker_container_stirlingpdf_labels
  • docker_container_stirlingpdf_name
  • docker_container_stirlingpdf_networks
  • docker_container_stirlingpdf_ports
  • docker_container_stirlingpdf_restic_enable
  • docker_container_stirlingpdf_restic_retention
  • docker_container_stirlingpdf_restic_s3_bucket_name
  • docker_container_stirlingpdf_restic_s3_endpoint
  • docker_container_stirlingpdf_restic_s3_repo
  • docker_container_stirlingpdf_restic_s3_repo_access_key
  • docker_container_stirlingpdf_restic_s3_repo_password
  • docker_container_stirlingpdf_restic_s3_repo_secret_key
  • docker_container_stirlingpdf_restic_stop_during_backup
  • docker_container_stirlingpdf_restic_tag
  • docker_container_stirlingpdf_volume_dir
  • docker_container_stirlingpdf_volumes
  • docker_image_stirlingpdf_name
  • docker_image_stirlingpdf_pull
  • docker_network_stirlingpdf_name
• Discovered Tags
• Dependencies
• License
• Author

---

Requirements

• Minimum Ansible version: 2.1

Default Variables

docker_container_stirlingpdf_comparisons

Allows to specify how properties of existing containers are compared with module options to decide whether the container should be recreated / updated or not.

Default value

docker_container_stirlingpdf_comparisons:
  image: strict
  env: strict
  volumes: strict

docker_container_stirlingpdf_env

Dictionery of key,value pairs for docker environment variables to configure stirlingpdf.

Example:

docker_container_stirlingpdf_env:

stirlingpdf__mailer__ENABLED: "false"

Default value

docker_container_stirlingpdf_env:
  DOCKER_ENABLE_SECURITY: 'false'
  SECURITY_ENABLELOGIN: 'false'
  INSTALL_BOOK_AND_ADVANCED_HTML_OPS: 'false'
  LANGS: en_GB

docker_container_stirlingpdf_image

Repository path and tag used to create the container. If an image is not found or pull is true, the image will be pulled from the registry. If no tag is included, latest will be used.

Default value

docker_container_stirlingpdf_image: '{{ docker_image_stirlingpdf_name }}'

docker_container_stirlingpdf_labels

Dictionary of key value pairs for container labels.

Example:

docker_container_stirlingpdf_labels:

traefik.enable: "true"

Default value

docker_container_stirlingpdf_labels: {}

docker_container_stirlingpdf_name

Name for the container

Default value

docker_container_stirlingpdf_name: stirlingpdf

docker_container_stirlingpdf_networks

List of networks the container belongs to.

Default value

docker_container_stirlingpdf_networks:
  - name: '{{ docker_network_stirlingpdf_name }}'

docker_container_stirlingpdf_ports

List of ports to publish from the container to the host.

Default value

docker_container_stirlingpdf_ports:
  - 8080:8080

docker_container_stirlingpdf_restic_enable

Enable restic backup for the container's mounted volumes.

Default value

docker_container_stirlingpdf_restic_enable: false

docker_container_stirlingpdf_restic_retention

Retention settions for restic forget after the restic backup.

Default value

docker_container_stirlingpdf_restic_retention:
  keep_last: 1
  keep_daily: 7
  keep_weekly: 4

docker_container_stirlingpdf_restic_s3_bucket_name

Minio S3 bucket name for restic backup storage.

Default value

docker_container_stirlingpdf_restic_s3_bucket_name: restic-{{ docker_container_stirlingpdf_name
  }}

docker_container_stirlingpdf_restic_s3_endpoint

Minio S3 endpoint for restic backup storage.

Example:

docker_container__base__restic_s3_endpoint: "https://minio.{{ dns_domain }}"

docker_container_stirlingpdf_restic_s3_endpoint: "{{ docker_container__base__restic_s3_endpoint }}"

Default value

docker_container_stirlingpdf_restic_s3_endpoint: '{{ docker_container__base__restic_s3_endpoint
  }}'

docker_container_stirlingpdf_restic_s3_repo

Minio S3 repo URL for restic backup storage.

Default value

docker_container_stirlingpdf_restic_s3_repo: s3:{{ docker_container_stirlingpdf_restic_s3_endpoint
  }}/{{ docker_container_stirlingpdf_restic_s3_bucket_name }}

docker_container_stirlingpdf_restic_s3_repo_access_key

Minio S3 repo access key for restic backup storage.

Default value

docker_container_stirlingpdf_restic_s3_repo_access_key: '{{ docker_container__base__restic_s3_repo_access_key
  }}'

docker_container_stirlingpdf_restic_s3_repo_password

Minio S3 repo password for restic backup storage.

Default value

docker_container_stirlingpdf_restic_s3_repo_password: '{{ docker_container__base__restic_s3_repo_password
  }}'

docker_container_stirlingpdf_restic_s3_repo_secret_key

Minio S3 repo secret key for restic backup storage.

Default value

docker_container_stirlingpdf_restic_s3_repo_secret_key: '{{ docker_container__base__restic_s3_repo_secret_key
  }}'

docker_container_stirlingpdf_restic_stop_during_backup

Stop and restart container during backup operation.

Default value

docker_container_stirlingpdf_restic_stop_during_backup: false

docker_container_stirlingpdf_restic_tag

Tag for the restic backup command

Default value

docker_container_stirlingpdf_restic_tag: '{{ docker_container_stirlingpdf_name }}'

docker_container_stirlingpdf_volume_dir

Volume mount host directory, where Treafik config files are stored.

Default value

docker_container_stirlingpdf_volume_dir: '{{ docker_container__base__volume_dir }}/{{
  docker_container_stirlingpdf_name }}'

docker_container_stirlingpdf_volumes

List of volumes to mount within the container.

Default value

docker_container_stirlingpdf_volumes:
  - '{{ docker_container_stirlingpdf_volume_dir }}/tessdata:/usr/share/tessdata'
  - '{{ docker_container_stirlingpdf_volume_dir }}/configs:/configs'

docker_image_stirlingpdf_name

Repository path and tag for the container image.

Default value

docker_image_stirlingpdf_name: stirlingtools/stirling-pdf:latest

docker_image_stirlingpdf_pull

Indicate to always pull the docker image.

Default value

docker_image_stirlingpdf_pull: false

docker_network_stirlingpdf_name

Name of the docker network created for stirlingpdf.

Default value

docker_network_stirlingpdf_name: '{{ docker_container_stirlingpdf_name }}_backend'

Discovered Tags

docker-container-backup-all
 Backup all containers' volume mounts.

docker-container-backup-init-all
 Run init backup task for all container.

docker-container-backup-init-stirlingpdf
 Run init backup task for stirlingpdf if restic is enabled.

docker-container-backup-list-all
 List all containers' backups.

docker-container-backup-list-stirlingpdf
 List stirlingpdf backups.

docker-container-backup-stirlingpdf
 Backup stirlingpdf volume mounts.

docker-container-prereq-all
 Ensure all pre-requisites are installed

docker-container-prereq-stirlingpdf
 Ensure all pre-requisites for stirlingpdf are installed

docker-container-purge-all
 Remove all containers and delete volume mounts.

docker-container-purge-stirlingpdf
 Remove stirlingpdf and delete volume mounts.

docker-container-remove-all
 Remove all containers.

docker-container-remove-stirlingpdf
 Remove stirlingpdf.

docker-container-restore-all
 Run restic restore for all restic enabled containers.

docker-container-restore-stirlingpdf
 Run restic restore for stirlingpdf if restic is enabled.

docker-container-setup-all
 Run setup task for all containers.

docker-container-setup-stirlingpdf
 Run setup task for stirlingpdf.

never

Dependencies

None.

License

license (GPL-2.0-or-later, MIT, etc)

Author

andif888