https://github.com/andif888/ansible-role-docker-container-forgejo
Role to run forgejo in a docker container
https://github.com/andif888/ansible-role-docker-container-forgejo
ansible-role docker-container forgejo
Last synced: 3 months ago
JSON representation
Role to run forgejo in a docker container
- Host: GitHub
- URL: https://github.com/andif888/ansible-role-docker-container-forgejo
- Owner: andif888
- Created: 2024-09-16T18:31:42.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-10-26T23:46:58.000Z (12 months ago)
- Last Synced: 2025-02-11T16:41:22.080Z (8 months ago)
- Topics: ansible-role, docker-container, forgejo
- Homepage:
- Size: 9.77 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ansible-role-docker-container-forgejo
Role to run forgejo in a docker container
## Table of content
- [Default Variables](#default-variables)
- [docker_container_forgejo_env](#docker_container_forgejo_env)
- [docker_container_forgejo_image](#docker_container_forgejo_image)
- [docker_container_forgejo_labels](#docker_container_forgejo_labels)
- [docker_container_forgejo_name](#docker_container_forgejo_name)
- [docker_container_forgejo_networks](#docker_container_forgejo_networks)
- [docker_container_forgejo_ports](#docker_container_forgejo_ports)
- [docker_container_forgejo_restic_enable](#docker_container_forgejo_restic_enable)
- [docker_container_forgejo_restic_retention](#docker_container_forgejo_restic_retention)
- [docker_container_forgejo_restic_s3_bucket_name](#docker_container_forgejo_restic_s3_bucket_name)
- [docker_container_forgejo_restic_s3_endpoint](#docker_container_forgejo_restic_s3_endpoint)
- [docker_container_forgejo_restic_s3_repo](#docker_container_forgejo_restic_s3_repo)
- [docker_container_forgejo_restic_s3_repo_access_key](#docker_container_forgejo_restic_s3_repo_access_key)
- [docker_container_forgejo_restic_s3_repo_password](#docker_container_forgejo_restic_s3_repo_password)
- [docker_container_forgejo_restic_s3_repo_secret_key](#docker_container_forgejo_restic_s3_repo_secret_key)
- [docker_container_forgejo_restic_tag](#docker_container_forgejo_restic_tag)
- [docker_container_forgejo_volume_dir](#docker_container_forgejo_volume_dir)
- [docker_container_forgejo_volumes](#docker_container_forgejo_volumes)
- [docker_image_forgejo_name](#docker_image_forgejo_name)
- [docker_image_forgejo_pull](#docker_image_forgejo_pull)
- [docker_network_forgejo_name](#docker_network_forgejo_name)
- [Discovered Tags](#discovered-tags)
- [Dependencies](#dependencies)
- [License](#license)
- [Author](#author)
---
## Default Variables
### docker_container_forgejo_env
Dictionery of key,value pairs for docker environment variables to configure forgejo.
Example:
```yaml
docker_container_forgejo_env:
forgejo__mailer__ENABLED: "false"
```
#### Default value
```YAML
docker_container_forgejo_env: {}
```
### docker_container_forgejo_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
```YAML
docker_container_forgejo_image: '{{ docker_image_forgejo_name }}'
```
### docker_container_forgejo_labels
Dictionary of key value pairs for container labels.
Example:
```yaml
docker_container_forgejo_labels:
traefik.enable: "true"
```
#### Default value
```YAML
docker_container_forgejo_labels: {}
```
### docker_container_forgejo_name
Name for the container
#### Default value
```YAML
docker_container_forgejo_name: forgejo
```
### docker_container_forgejo_networks
List of networks the container belongs to.
#### Default value
```YAML
docker_container_forgejo_networks:
- name: '{{ docker_network_forgejo_name }}'
```
### docker_container_forgejo_ports
List of ports to publish from the container to the host.
#### Default value
```YAML
docker_container_forgejo_ports:
- 3000:3000
```
### docker_container_forgejo_restic_enable
Enable restic backup for the container's mounted volumes.
#### Default value
```YAML
docker_container_forgejo_restic_enable: false
```
### docker_container_forgejo_restic_retention
Retention settions for `restic forget` after the `restic backup`.
#### Default value
```YAML
docker_container_forgejo_restic_retention:
keep_last: 1
keep_daily: 7
keep_weekly: 4
```
### docker_container_forgejo_restic_s3_bucket_name
Minio S3 bucket name for restic backup storage.
#### Default value
```YAML
docker_container_forgejo_restic_s3_bucket_name: restic-{{ docker_container_forgejo_name
}}
```
### docker_container_forgejo_restic_s3_endpoint
Minio S3 endpoint for restic backup storage.
Example:
```yaml
docker_container__base__restic_s3_endpoint: "https://minio.{{ dns_domain }}"
docker_container_forgejo_restic_s3_endpoint: "{{ docker_container__base__restic_s3_endpoint }}"
```
#### Default value
```YAML
docker_container_forgejo_restic_s3_endpoint: '{{ docker_container__base__restic_s3_endpoint
}}'
```
### docker_container_forgejo_restic_s3_repo
Minio S3 repo URL for restic backup storage.
#### Default value
```YAML
docker_container_forgejo_restic_s3_repo: s3:{{ docker_container_forgejo_restic_s3_endpoint
}}/{{ docker_container_forgejo_restic_s3_bucket_name }}
```
### docker_container_forgejo_restic_s3_repo_access_key
Minio S3 repo access key for restic backup storage.
#### Default value
```YAML
docker_container_forgejo_restic_s3_repo_access_key: '{{ docker_container__base__restic_s3_repo_access_key
}}'
```
### docker_container_forgejo_restic_s3_repo_password
Minio S3 repo password for restic backup storage.
#### Default value
```YAML
docker_container_forgejo_restic_s3_repo_password: '{{ docker_container__base__restic_s3_repo_password
}}'
```
### docker_container_forgejo_restic_s3_repo_secret_key
Minio S3 repo secret key for restic backup storage.
#### Default value
```YAML
docker_container_forgejo_restic_s3_repo_secret_key: '{{ docker_container__base__restic_s3_repo_secret_key
}}'
```
### docker_container_forgejo_restic_tag
Tag for the `restic backup` command
#### Default value
```YAML
docker_container_forgejo_restic_tag: '{{ docker_container_forgejo_name }}'
```
### docker_container_forgejo_volume_dir
Volume mount host directory, where Treafik config files are stored.
#### Default value
```YAML
docker_container_forgejo_volume_dir: '{{ docker_container__base__volume_dir }}/{{ docker_container_forgejo_name
}}'
```
### docker_container_forgejo_volumes
List of volumes to mount within the container.
#### Default value
```YAML
docker_container_forgejo_volumes:
- '{{ docker_container_forgejo_volume_dir }}/data:/data'
- /etc/timezone:/etc/timezone:ro
- /etc/localtime:/etc/localtime:ro
```
### docker_image_forgejo_name
Repository path and tag for the container image.
#### Default value
```YAML
docker_image_forgejo_name: forgejo/forgejo:latest
```
### docker_image_forgejo_pull
Indicate to always pull the docker image.
#### Default value
```YAML
docker_image_forgejo_pull: no
```
### docker_network_forgejo_name
Name of the docker network created for forgejo.
#### Default value
```YAML
docker_network_forgejo_name: '{{ docker_container_forgejo_name }}_backend'
```
## Discovered Tags
**_docker-container-backup-all_**\
Backup all containers' volume mounts.
**_docker-container-backup-forgejo_**\
Backup forgejo volume mounts.
**_docker-container-backup-init-all_**\
Run init backup task for all container.
**_docker-container-backup-init-forgejo_**\
Run init backup task for forgejo if restic is enabled.
**_docker-container-backup-list-all_**\
List all containers' backups.
**_docker-container-backup-list-forgejo_**\
List forgejo backups.
**_docker-container-prereq-all_**\
Ensure all pre-requisites are installed
**_docker-container-prereq-forgejo_**\
Ensure all pre-requisites for forgejo are installed
**_docker-container-purge-all_**\
Remove all containers and delete volume mounts.
**_docker-container-purge-forgejo_**\
Remove forgejo and delete volume mounts.
**_docker-container-remove-all_**\
Remove all containers.
**_docker-container-remove-forgejo_**\
Remove forgejo.
**_docker-container-restore-all_**\
Run restic restore for all restic enabled containers.
**_docker-container-restore-forgejo_**\
Run restic restore for forgejo if restic is enabled.
**_docker-container-setup-all_**\
Run setup task for all containers.
**_docker-container-setup-forgejo_**\
Run setup task for forgejo.
**_never_**
## Dependencies
None.
## License
license (GPL-2.0-or-later, MIT, etc)
## Author
andif888