diff --git a/docs/container.md b/docs/container.md index 6670d54..2d6aa14 100644 --- a/docs/container.md +++ b/docs/container.md @@ -1,60 +1 @@ -# 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_service_suffix: production # For running multiple instances of the same service - -docker_host_user: true # Creates a user on the host and makes the docker container use the same uid/gid. Bind mount volume directories will be owned by this user - -docker_database: postgres # Database to set up in a separate container, supports postgres, mariadb and mongo -database_passwords: # Needed for postgres and mariadb - gitea: secret - -docker_additional_services: - - memcached - -docker_volumes: - - name: data - path: /data - - src: /var/lib/gitea/.ssh - path: /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 - -dockerfile: # For building a custom container image locally - run: - - "apt-get update && apt-get install -y libmemcached-dev zlib1g-dev && pecl install memcached-3.2.0 && docker-php-ext-enable memcached" - - -``` +Please see `roles/container/meta/arguments_specs.yml` for all possible variables