ansible-role-docker-container-vaultwarden

Role to run Vaultwarden in a docker container

Table of content

Default Variables
Discovered Tags
Dependencies
License
Author

Default Variables

docker_container_vaultwarden_env

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

Default value

docker_container_vaultwarden_env:
  WEBSOCKET_ENABLED: 'true'

docker_container_vaultwarden_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_vaultwarden_image: '{{ docker_image_vaultwarden_name }}'

docker_container_vaultwarden_labels

Dictionary of key value pairs for container labels.

Example:

docker_container_vaultwarden_labels:

traefik.enable: "true"

Default value

docker_container_vaultwarden_labels: {}

docker_container_vaultwarden_name

Name for the container

Default value

docker_container_vaultwarden_name: vaultwarden

docker_container_vaultwarden_networks

List of networks the container belongs to.

Default value

docker_container_vaultwarden_networks:
  - name: '{{ docker_network_vaultwarden_name }}'

docker_container_vaultwarden_ports

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

Default value

docker_container_vaultwarden_ports:
  - 3012:3012
  - 80:80

docker_container_vaultwarden_restic_enable

Enable restic backup for the container's mounted volumes.

Default value

docker_container_vaultwarden_restic_enable: false

docker_container_vaultwarden_restic_retention

Retention settions for restic forget after the restic backup.

Default value

docker_container_vaultwarden_restic_retention:
  keep_last: 1
  keep_daily: 7
  keep_weekly: 4

docker_container_vaultwarden_restic_s3_bucket_name

Minio S3 bucket name for restic backup storage.

Default value

docker_container_vaultwarden_restic_s3_bucket_name: restic-{{ docker_container_vaultwarden_name
  }}

docker_container_vaultwarden_restic_s3_endpoint

Minio S3 endpoint for restic backup storage.

Example:

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

docker_container_vaultwarden_restic_s3_endpoint: "{{ docker_container__base__restic_s3_endpoint }}"

Default value

docker_container_vaultwarden_restic_s3_endpoint: '{{ docker_container__base__restic_s3_endpoint
  }}'

docker_container_vaultwarden_restic_s3_repo

Minio S3 repo URL for restic backup storage.

Default value

docker_container_vaultwarden_restic_s3_repo: s3:{{ docker_container_vaultwarden_restic_s3_endpoint
  }}/{{ docker_container_vaultwarden_restic_s3_bucket_name }}

docker_container_vaultwarden_restic_s3_repo_access_key

Minio S3 repo access key for restic backup storage.

Default value

docker_container_vaultwarden_restic_s3_repo_access_key: '{{ docker_container__base__restic_s3_repo_access_key
  }}'

docker_container_vaultwarden_restic_s3_repo_password

Minio S3 repo password for restic backup storage.

Default value

docker_container_vaultwarden_restic_s3_repo_password: '{{ docker_container__base__restic_s3_repo_password
  }}'

docker_container_vaultwarden_restic_s3_repo_secret_key

Minio S3 repo secret key for restic backup storage.

Default value

docker_container_vaultwarden_restic_s3_repo_secret_key: '{{ docker_container__base__restic_s3_repo_secret_key
  }}'

docker_container_vaultwarden_restic_tag

Tag for the restic backup command

Default value

docker_container_vaultwarden_restic_tag: '{{ docker_container_vaultwarden_name }}'

docker_container_vaultwarden_volume_dir

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

Default value

docker_container_vaultwarden_volume_dir: '{{ docker_container__base__volume_dir }}/{{
  docker_container_vaultwarden_name }}'

docker_container_vaultwarden_volumes

List of volumes to mount within the container.

Default value

docker_container_vaultwarden_volumes:
  - '{{ docker_container_vaultwarden_volume_dir }}/data:/data'

docker_image_vaultwarden_name

Repository path and tag for the container image.

Default value

docker_image_vaultwarden_name: vaultwarden/server:latest

docker_image_vaultwarden_pull

Indicate to always pull the docker image.

Default value

docker_image_vaultwarden_pull: no

docker_network_vaultwarden_name

Name of the docker network created for vaultwarden.

Default value

docker_network_vaultwarden_name: '{{ docker_container_vaultwarden_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-vaultwarden
Run init backup task for vaultwarden if restic is enabled.

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

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

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

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

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

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

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

docker-container-remove-all
Remove all containers.

docker-container-remove-vaultwarden
Remove vaultwarden.

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

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

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

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

never

Dependencies

None.

License

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

Author

andif888

andif888 / ansible-role-docker-container-vaultwarden Goto Github PK