{"id":26649014,"url":"https://github.com/hjmcnew/portainer-docker-compose","last_synced_at":"2026-04-27T12:05:05.479Z","repository":{"id":283498082,"uuid":"951966651","full_name":"hjmcnew/portainer-docker-compose","owner":"hjmcnew","description":"Portainer EE docker compose files","archived":false,"fork":false,"pushed_at":"2025-03-20T15:13:30.000Z","size":17,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-20T15:34:22.673Z","etag":null,"topics":["docker","docker-compose","docker-compose-files","portainer","portainer-ee"],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hjmcnew.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,"publiccode":null,"codemeta":null}},"created_at":"2025-03-20T14:20:55.000Z","updated_at":"2025-03-20T15:13:32.000Z","dependencies_parsed_at":"2025-03-20T15:35:11.665Z","dependency_job_id":"027d8225-9285-4821-a7a7-69d293ed794a","html_url":"https://github.com/hjmcnew/portainer-docker-compose","commit_stats":null,"previous_names":["hjmcnew/portainer-docker-compose"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hjmcnew%2Fportainer-docker-compose","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hjmcnew%2Fportainer-docker-compose/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hjmcnew%2Fportainer-docker-compose/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hjmcnew%2Fportainer-docker-compose/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hjmcnew","download_url":"https://codeload.github.com/hjmcnew/portainer-docker-compose/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245377954,"owners_count":20605375,"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","docker-compose-files","portainer","portainer-ee"],"created_at":"2025-03-25T00:47:43.889Z","updated_at":"2026-04-27T12:05:05.473Z","avatar_url":"https://github.com/hjmcnew.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Portainer Docker Compose\n\nDocker Compose configurations for deploying [Portainer EE](https://www.portainer.io/) with automated Let's Encrypt SSL certificates via DNS-01 challenge (Route53).\n\n## Repository Structure\n\n```\nportainer/             # Portainer EE server with SSL and cert automation\n  docker-compose.yaml\nportainer-agent/       # Standalone Portainer Agent for remote endpoints\n  docker-compose.yaml\n```\n\n## Components\n\n### Portainer Server (`portainer/`)\n\nThe main compose file deploys three services:\n\n- **Portainer EE** — management UI served over TLS on port `9443`\n- **Certbot** — obtains and stores Let's Encrypt certificates using the `dns-route53` plugin\n- **Ofelia** — cron scheduler that renews certificates weekly and restarts Portainer when certs are updated\n\nThe Portainer Agent is included via compose `include` from `portainer-agent/docker-compose.yaml`.\n\n### Portainer Agent (`portainer-agent/`)\n\nA standalone Portainer Agent deployment on port `9001`, suitable for adding remote Docker endpoints to your Portainer instance.\n\n## Prerequisites\n\n- Docker Engine with Compose V2 (`docker compose`)\n- An AWS Route53-hosted domain (for DNS-01 certificate validation)\n- AWS credentials with Route53 permissions\n\n## Getting Started\n\n1. Clone the repository:\n\n    ```sh\n    git clone https://github.com/hjmcnew/portainer-docker-compose.git\n    cd portainer-docker-compose\n    ```\n\n2. Create a `.env` file in the `portainer/` directory with your configuration:\n\n    ```env\n    DOMAIN=portainer.example.com\n    EMAIL=you@example.com\n    AWS_ACCESS_KEY_ID=your-key-id\n    AWS_SECRET_ACCESS_KEY=your-secret-key\n    ```\n\n3. Start the stack:\n\n    ```sh\n    cd portainer\n    docker compose up -d\n    ```\n\n    Certbot will obtain a certificate on first run. The healthcheck waits for the cert to be issued before Portainer starts.\n\n4. Access Portainer at `https://your-domain:9443`.\n\n### Deploying Only the Agent\n\nTo deploy just the Portainer Agent on a remote host:\n\n```sh\ncd portainer-agent\ndocker compose up -d\n```\n\n## Certificate Renewal\n\nOfelia handles automated renewal on a weekly schedule:\n\n1. Certbot attempts renewal and sets a flag file if the certificate was updated\n2. A follow-up job checks for the flag, restarts Portainer to load the new cert, and clears the flag\n\nNo manual intervention is required.\n\n## CI\n\n- **Docker Compose Lint** — validates compose files on push and PRs using [dclint](https://github.com/zavoloklom/docker-compose-linter)\n- **Dependabot** — monitors for Docker image and GitHub Actions updates weekly (major version bumps are ignored for Docker images)\n\n## Contributing\n\n1. Fork the repository.\n2. Create a new branch (`git checkout -b feature/your-feature-name`).\n3. Make your changes.\n4. Commit your changes (`git commit -m 'Add some feature'`).\n5. Push to the branch (`git push origin feature/your-feature-name`).\n6. Open a Pull Request.\n\n## License\n\nThis project is licensed under the BSD 3-Clause License — see the [LICENSE](LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhjmcnew%2Fportainer-docker-compose","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhjmcnew%2Fportainer-docker-compose","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhjmcnew%2Fportainer-docker-compose/lists"}