{"id":24884261,"url":"https://github.com/dreknix/docker-compose-base","last_synced_at":"2025-07-31T11:32:04.902Z","repository":{"id":174373191,"uuid":"652124903","full_name":"dreknix/docker-compose-base","owner":"dreknix","description":"Docker compose base instance (traefik, portainer, ...)","archived":false,"fork":false,"pushed_at":"2024-04-13T22:35:04.000Z","size":33,"stargazers_count":1,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-04-14T04:08:49.526Z","etag":null,"topics":["docker","docker-compose","portainer","traefik"],"latest_commit_sha":null,"homepage":"","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dreknix.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2023-06-11T06:58:30.000Z","updated_at":"2024-04-15T18:46:00.017Z","dependencies_parsed_at":null,"dependency_job_id":"fb8379ba-4464-4025-9afd-8d58f24f7d1f","html_url":"https://github.com/dreknix/docker-compose-base","commit_stats":null,"previous_names":["dreknix/docker-compose-base"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dreknix%2Fdocker-compose-base","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dreknix%2Fdocker-compose-base/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dreknix%2Fdocker-compose-base/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dreknix%2Fdocker-compose-base/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dreknix","download_url":"https://codeload.github.com/dreknix/docker-compose-base/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245821135,"owners_count":20677987,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker","docker-compose","portainer","traefik"],"created_at":"2025-02-01T14:26:39.087Z","updated_at":"2025-03-27T09:42:41.276Z","avatar_url":"https://github.com/dreknix.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Docker compose instance for Traefik, Portainer, ...\n\nDocker compose base instance (Traefik, Portainer, ...)\n\n## Setup\n\nCheckout the repository:\n\n``` console\ngit clone https://github.com/dreknix/docker-compose-base.git base\ncd base/\n```\n\n## Traefik\n\nAdjust the configuration files:\n\nThe environment variables defined in `.env` configure the local adjustments of\nthis Docker compose instance.\n\n``` console\ncp .env.dist .env\nnano .env\n```\n\nThe following environment variables could be configured:\n\n* `ENV_TRAEFIK_HOST` - fqdn of the Traefik host\n* `ENV_TRAEFIK_EMAIL` - email for Let's Encrypt\n* `ENV_TRAEFIK_REALM` - realm for basic authentication (default: `traefik`)\n* `ENV_TRAEFIK_IPALLOWLIST` - ip allow list for Traefik (default: `127.0.0.1/8`)\n\nThe static configuration of Traefik should normally not be changed. The main\nreason the adjust this configuration is to enable debug information.\n\n``` console\ncp traefik.env.dist traefik.env\nnano traefik.env\n```\n\nAdd users for the basic authentication of Traefik. The default user is `traefik`\nwith the same password.\n\n``` console\ncp .traefik_secrets.txt.dist .traefik_secrets.txt\nnano .traefik_secrets.txt\n```\n\nEach line in this file is create via `htpasswd -nbB \u003cuser\u003e \"\u003cpass\u003e\"`.\n\nFor additional dynamic configurations create a file in `traefik-config/`.\n\nCreate the networks:\n\n``` console\ndocker network create frontend\ndocker network create backend\n```\n\n## Portainer\n\nThe password for the default `admin` user is set via the file\n`.portainer_admin_secret.txt`. This password is stored in plain text in this\nfile.\n\n``` console\nnano .portainer_admin_secret.txt\n```\n\nFor safety reasons the default `admin` user should be deleted after another user\nwith administrator permissions was created.\n\nThe portainer database is encrypted with the key stored in the file\n`.portainer_key_secret.txt`.\n\n``` console\nnano .portainer_key_secret.txt\n```\n\nCreate the volume:\n\n``` console\ndocker volume create base_portainer_data\n```\n\n## Start\n\nStart the first time in foreground to check the output.\n\n``` console\ndocker compose up\n```\n\n## Test\n\nRedirect your browser to `https://${ENV_TRAEFIK_HOST}/whoami` for testing.\n\nThe following services are included in this instance:\n\n* `https://${ENV_TRAEFIK_HOST}/` - nginx web server for static files\n* `https://${ENV_TRAEFIK_HOST}/traefik/`\n* `https://${ENV_TRAEFIK_HOST}/portainer/`\n* `https://${ENV_TRAEFIK_HOST}/whoami`\n\n## Setup with Ansible\n\n### Playbook\n\n``` yaml\n- name: Deploy Docker compose instance Traefik, Portainer, ...\n  hosts: docker_base\n  tasks:\n    - name: Import role 'dreknix.docker_deploy'\n      ansible.builtin.import_role:\n        name: dreknix.docker_deploy\n      vars:\n        docker_deploy_name: base\n        docker_deploy_git_repo: https://github.com/dreknix/docker-compose-base\n        docker_deploy_file_dirs:\n          - \"{{ playbook_dir }}/files/base\"\n        docker_deploy_template_dirs:\n          - \"{{ playbook_dir }}/templates/base/all\"\n          - \"{{ playbook_dir }}/templates/base/{{ inventory_hostname }}\"\n        docker_deploy_touched_files:\n          - path: traefik-certs/acme.json\n            mode: u=rw,go=\n        docker_deploy_delete_unmanaged_files: true\n        docker_deploy_volumes:\n          - base_portainer_data\n        docker_deploy_networks:\n          - frontend\n          - backend\n```\n\n### Variables\n\n``` yaml\n# fqdm of host\ndocker_deploy_base_traefik_host: dreknix.example.com\n\n# list of Traefik users (generate passwords with: htpasswd -nbB user pass)\ndocker_deploy_base_traefik_users:\n  - 'dreknix:$2y$05$P388kB5vG/I1Tv3qy8p.uOMeDgjh7ST54qS4RppuXjCQzJq/9U76C'\n\ndocker_deploy_base_traefik_api: true\n\ndocker_deploy_base_traefik_api_dashboard: true\n\ndocker_deploy_base_traefik_api_debug: false\n\ndocker_deploy_base_traefik_accesslog: false\n\n# password for user 'admin' in Portainer\ndocker_deploy_base_portainer_admin_password: \"**changeme**\"\n\ndocker_deploy_base_portainer_key: \"**changeme\"\n```\n\n### Files\n\n* `files/base/nginx/html/favicon.ico`\n\n### Templates\n\n#### Traefik\n\n* `templates/base/all/.env.j2`\n\n``` bash\nENV_TRAEFIK_HOST='{{ docker_deploy_base_traefik_host | mandatory }}'\n\nENV_TRAEFIK_EMAIL='{{ docker_deploy_base_traefik_email | default(\"dreknix@proton.me) }}'\n\nENV_TRAEFIK_REALM='{{ docker_deploy_base_traefik_realm | default(\"traefik\") }}'\n\nENV_TRAEFIK_IPALLOWLIST='{{ docker_deploy_base_traefik_ipallowlist | default(\"127.0.0.1/8\") }}'\n```\n\n* `templates/base/all/.traefik_secrets.txt.j2`\n\n``` text\n{%- for user in docker_deploy_base_traefik_users | default([]) %}\n{{ user }}\n{% endfor %}\n```\n\n* `templates/base/all/traefik.env.j2`\n\n``` bash\n#\n# see: https://doc.traefik.io/traefik/reference/static-configuration/env/\n#\n\n# port 80 is needed for Let's Encrypt HTTP-01 challenge\nTRAEFIK_ENTRYPOINTS_web=\"true\"\nTRAEFIK_ENTRYPOINTS_web_ADDRESS=\":80\"\n# port 443 - main entry point\nTRAEFIK_ENTRYPOINTS_websecure=\"true\"\nTRAEFIK_ENTRYPOINTS_websecure_ADDRESS=\":443\"\n\n# add Docker provider - config via Docker labels\nTRAEFIK_PROVIDERS_DOCKER=\"true\"\n# do not expose Docker labels of this instance\nTRAEFIK_PROVIDERS_DOCKER_EXPOSEDBYDEFAULT=\"false\"\n\n# add File provider - config via files in /config\nTRAEFIK_PROVIDERS_FILE_DIRECTORY=\"/config\"\nTRAEFIK_PROVIDERS_FILE_WATCH=\"true\"\n\n# if you omit this you will get the \"Internal Server Error\" due to\n# self-signed certificate on an internal server port\nTRAEFIK_SERVERSTRANSPORT_INSECURESKIPVERIFY=\"true\"\n\n# Certificates resolvers configuration must be part of the static\n# configuration (here, environment variables)\nTRAEFIK_CERTIFICATESRESOLVERS_LERESOLVER=\"true\"\nTRAEFIK_CERTIFICATESRESOLVERS_LERESOLVER_ACME_EMAIL=\"${ENV_TRAEFIK_EMAIL}\"\nTRAEFIK_CERTIFICATESRESOLVERS_LERESOLVER_ACME_STORAGE=\"/etc/letsencrypt/acme.json\"\nTRAEFIK_CERTIFICATESRESOLVERS_LERESOLVER_ACME_HTTPCHALLENGE=\"true\"\nTRAEFIK_CERTIFICATESRESOLVERS_LERESOLVER_ACME_HTTPCHALLENGE_ENTRYPOINT=\"web\"\nTRAEFIK_CERTIFICATESRESOLVERS_LERESOLVER_ACME_TLSCHALLENGE=\"false\"\n\nTRAEFIK_API=\"{{ docker_deploy_base_traefik_api | bool | lower}}\"\nTRAEFIK_API_DASHBOARD=\"{{ docker_deploy_base_traefik_api_dashboard | bool | lower }}\"\nTRAEFIK_API_DEBUG=\"{{ docker_deploy_base_traefik_api_debug | bool | lower }}\"\n\nTRAEFIK_ACCESSLOG=\"{{ docker_deploy_base_traefik_accesslog | bool | lower }}\"\n```\n\n* `templates/base/all/traefik-config/example.yaml.j2`\n\n#### Portainer\n\n* `templates/base/all/.portainer_admin_secret.txt.j2`\n\n``` text\n{{ docker_deploy_base_portainer_admin_password }}\n```\n\n* `templates/base/all/.portainer_key_secret.txt.j2`\n\n``` text\n{{ docker_deploy_base_portainer_key }}\n```\n\n#### Static pages\n\n* `templates/base/all/nginx/html/index.html.j2`\n\n## License\n\n[MIT](https://github.com/dreknix/docker-compose-base/blob/main/LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdreknix%2Fdocker-compose-base","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdreknix%2Fdocker-compose-base","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdreknix%2Fdocker-compose-base/lists"}