diff --git a/docs/container.md b/docs/container.md new file mode 100644 index 0000000..d733648 --- /dev/null +++ b/docs/container.md @@ -0,0 +1,45 @@ +# Required variables +These variables are required. Example values included. Some general variables might also be required for this role. + +``` +docker_service: gitea +docker_image: gitea/gitea:latest + +ports: + gitea: + http: 8080 # ports[docker_service].http (or https) needed for reverse proxy + +``` + +# Variables for http reverse proxy + +``` +reverse_proxy_type: caddy # Defaults to caddy, set to none if no reverse proxy is needed. Supported values: none, caddy, traefik +docker_image_http_port: 3000 # the port used inside the container for http + +docker_vhost_domains: + gitea: + - git.domain.tld + + +``` + +# Other optional variables + +``` +docker_database: postgres # Database to set up in a separate container, supports postgres and mongo +database_passwords: # Needed for postgres + gitea: secret + +docker_volumes: + - gitea_data:/data + - /var/lib/gitea/.ssh:/data/git/.ssh +docker_published_ports: + - "127.0.0.1:{{ ports.gitea.ssh }}:22" +docker_env: + USER_UID: 2132 + GITEA__database__DB_TYPE: postgres + +docker_network_mode: host # Usually you don't want to define this + +```