Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/andif888/ansible-role-docker-container-gitea

Role to run Gitea in a docker container
https://github.com/andif888/ansible-role-docker-container-gitea

ansible-role docker-container gitea

Last synced: about 1 month ago
JSON representation

Role to run Gitea in a docker container

Awesome Lists containing this project

README

        

# ansible-role-docker-container-gitea

Role to run Gitea in a docker container

## Table of content

- [Default Variables](#default-variables)
- [docker_container_gitea_env](#docker_container_gitea_env)
- [docker_container_gitea_image](#docker_container_gitea_image)
- [docker_container_gitea_labels](#docker_container_gitea_labels)
- [docker_container_gitea_name](#docker_container_gitea_name)
- [docker_container_gitea_networks](#docker_container_gitea_networks)
- [docker_container_gitea_ports](#docker_container_gitea_ports)
- [docker_container_gitea_restic_enable](#docker_container_gitea_restic_enable)
- [docker_container_gitea_restic_retention](#docker_container_gitea_restic_retention)
- [docker_container_gitea_restic_s3_bucket_name](#docker_container_gitea_restic_s3_bucket_name)
- [docker_container_gitea_restic_s3_endpoint](#docker_container_gitea_restic_s3_endpoint)
- [docker_container_gitea_restic_s3_repo](#docker_container_gitea_restic_s3_repo)
- [docker_container_gitea_restic_s3_repo_access_key](#docker_container_gitea_restic_s3_repo_access_key)
- [docker_container_gitea_restic_s3_repo_password](#docker_container_gitea_restic_s3_repo_password)
- [docker_container_gitea_restic_s3_repo_secret_key](#docker_container_gitea_restic_s3_repo_secret_key)
- [docker_container_gitea_restic_tag](#docker_container_gitea_restic_tag)
- [docker_container_gitea_volume_dir](#docker_container_gitea_volume_dir)
- [docker_container_gitea_volumes](#docker_container_gitea_volumes)
- [docker_image_gitea_name](#docker_image_gitea_name)
- [docker_image_gitea_pull](#docker_image_gitea_pull)
- [docker_network_gitea_name](#docker_network_gitea_name)
- [Discovered Tags](#discovered-tags)
- [Dependencies](#dependencies)
- [License](#license)
- [Author](#author)

---

## Default Variables

### docker_container_gitea_env

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

Example:

```yaml

docker_container_gitea_env:

GITEA__mailer__ENABLED: "false"

```

#### Default value

```YAML
docker_container_gitea_env: {}
```

### docker_container_gitea_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_gitea_image: '{{ docker_image_gitea_name }}'
```

### docker_container_gitea_labels

Dictionary of key value pairs for container labels.

Example:

```yaml

docker_container_gitea_labels:

traefik.enable: "true"

```

#### Default value

```YAML
docker_container_gitea_labels: {}
```

### docker_container_gitea_name

Name for the container

#### Default value

```YAML
docker_container_gitea_name: gitea
```

### docker_container_gitea_networks

List of networks the container belongs to.

#### Default value

```YAML
docker_container_gitea_networks:
- name: '{{ docker_network_gitea_name }}'
```

### docker_container_gitea_ports

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

#### Default value

```YAML
docker_container_gitea_ports:
- 3000:3000
```

### docker_container_gitea_restic_enable

Enable restic backup for the container's mounted volumes.

#### Default value

```YAML
docker_container_gitea_restic_enable: false
```

### docker_container_gitea_restic_retention

Retention settions for `restic forget` after the `restic backup`.

#### Default value

```YAML
docker_container_gitea_restic_retention:
keep_last: 1
keep_daily: 7
keep_weekly: 4
```

### docker_container_gitea_restic_s3_bucket_name

Minio S3 bucket name for restic backup storage.

#### Default value

```YAML
docker_container_gitea_restic_s3_bucket_name: restic-{{ docker_container_gitea_name
}}
```

### docker_container_gitea_restic_s3_endpoint

Minio S3 endpoint for restic backup storage.

Example:

```yaml

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

docker_container_gitea_restic_s3_endpoint: "{{ docker_container__base__restic_s3_endpoint }}"

```

#### Default value

```YAML
docker_container_gitea_restic_s3_endpoint: '{{ docker_container__base__restic_s3_endpoint
}}'
```

### docker_container_gitea_restic_s3_repo

Minio S3 repo URL for restic backup storage.

#### Default value

```YAML
docker_container_gitea_restic_s3_repo: s3:{{ docker_container_gitea_restic_s3_endpoint
}}/{{ docker_container_gitea_restic_s3_bucket_name }}
```

### docker_container_gitea_restic_s3_repo_access_key

Minio S3 repo access key for restic backup storage.

#### Default value

```YAML
docker_container_gitea_restic_s3_repo_access_key: '{{ docker_container__base__restic_s3_repo_access_key
}}'
```

### docker_container_gitea_restic_s3_repo_password

Minio S3 repo password for restic backup storage.

#### Default value

```YAML
docker_container_gitea_restic_s3_repo_password: '{{ docker_container__base__restic_s3_repo_password
}}'
```

### docker_container_gitea_restic_s3_repo_secret_key

Minio S3 repo secret key for restic backup storage.

#### Default value

```YAML
docker_container_gitea_restic_s3_repo_secret_key: '{{ docker_container__base__restic_s3_repo_secret_key
}}'
```

### docker_container_gitea_restic_tag

Tag for the `restic backup` command

#### Default value

```YAML
docker_container_gitea_restic_tag: '{{ docker_container_gitea_name }}'
```

### docker_container_gitea_volume_dir

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

#### Default value

```YAML
docker_container_gitea_volume_dir: '{{ docker_container__base__volume_dir }}/{{ docker_container_gitea_name
}}'
```

### docker_container_gitea_volumes

List of volumes to mount within the container.

#### Default value

```YAML
docker_container_gitea_volumes:
- '{{ docker_container_gitea_volume_dir }}/data:/data'
- /etc/timezone:/etc/timezone:ro
- /etc/localtime:/etc/localtime:ro
```

### docker_image_gitea_name

Repository path and tag for the container image.

#### Default value

```YAML
docker_image_gitea_name: gitea/gitea:latest
```

### docker_image_gitea_pull

Indicate to always pull the docker image.

#### Default value

```YAML
docker_image_gitea_pull: no
```

### docker_network_gitea_name

Name of the docker network created for gitea.

#### Default value

```YAML
docker_network_gitea_name: '{{ docker_container_gitea_name }}_backend'
```

## Discovered Tags

**_docker-container-backup-all_**\
 Backup all containers' volume mounts.

**_docker-container-backup-gitea_**\
 Backup gitea volume mounts.

**_docker-container-backup-init-all_**\
 Run init backup task for all container.

**_docker-container-backup-init-gitea_**\
 Run init backup task for gitea if restic is enabled.

**_docker-container-backup-list-all_**\
 List all containers' backups.

**_docker-container-backup-list-gitea_**\
 List gitea backups.

**_docker-container-prereq-all_**\
 Ensure all pre-requisites are installed

**_docker-container-prereq-gitea_**\
 Ensure all pre-requisites for gitea are installed

**_docker-container-purge-all_**\
 Remove all containers and delete volume mounts.

**_docker-container-purge-gitea_**\
 Remove gitea and delete volume mounts.

**_docker-container-remove-all_**\
 Remove all containers.

**_docker-container-remove-gitea_**\
 Remove gitea.

**_docker-container-restore-all_**\
 Run restic restore for all restic enabled containers.

**_docker-container-restore-gitea_**\
 Run restic restore for gitea if restic is enabled.

**_docker-container-setup-all_**\
 Run setup task for all containers.

**_docker-container-setup-gitea_**\
 Run setup task for gitea.

**_never_**

## Dependencies

None.

## License

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

## Author

andif888