{"id":17660898,"url":"https://github.com/soulteary/traefik-v3-example","last_synced_at":"2026-02-18T15:02:29.473Z","repository":{"id":251592755,"uuid":"837840889","full_name":"soulteary/traefik-v3-example","owner":"soulteary","description":"Traefik 3.x Quick Start Example / Traefik 3.x 快速上手示例","archived":false,"fork":false,"pushed_at":"2026-01-19T12:45:48.000Z","size":163,"stargazers_count":39,"open_issues_count":0,"forks_count":9,"subscribers_count":2,"default_branch":"main","last_synced_at":"2026-01-19T19:38:36.518Z","etag":null,"topics":["cloudflare","docker","flare","maildev","owlmail","stargate","traefik","traefik-v3","user-auth"],"latest_commit_sha":null,"homepage":"https://soulteary.com/2024/08/04/best-practices-for-traefik-3-in-docker-getting-started-quickly.html","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/soulteary.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-08-04T07:37:14.000Z","updated_at":"2026-01-19T12:45:51.000Z","dependencies_parsed_at":"2024-08-04T10:27:53.415Z","dependency_job_id":"13dd9287-1083-4a6a-9f3f-f25038f70b3a","html_url":"https://github.com/soulteary/traefik-v3-example","commit_stats":null,"previous_names":["soulteary/traefik-v3-example"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/soulteary/traefik-v3-example","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/soulteary%2Ftraefik-v3-example","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/soulteary%2Ftraefik-v3-example/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/soulteary%2Ftraefik-v3-example/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/soulteary%2Ftraefik-v3-example/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/soulteary","download_url":"https://codeload.github.com/soulteary/traefik-v3-example/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/soulteary%2Ftraefik-v3-example/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29582832,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-18T13:56:48.962Z","status":"ssl_error","status_checked_at":"2026-02-18T13:54:34.145Z","response_time":162,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["cloudflare","docker","flare","maildev","owlmail","stargate","traefik","traefik-v3","user-auth"],"created_at":"2024-10-23T17:09:37.987Z","updated_at":"2026-02-18T15:02:29.456Z","avatar_url":"https://github.com/soulteary.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Traefik v3.x Quick Start Example\n\n[English](README.md) | [中文](README.zh.md)\n\n![Traefik v3.x Quick Start Example](.github/assets/banner.jpg)\n\nThis project demonstrates how to quickly get started with Traefik v3.x, including dynamic service integration and certificate configuration.\n\nIf you find this example helpful, please give it a star ✨. If you want to receive updates about this project, you can click watch 👀 and choose your preferred notification mode.\n\n## Features\n\n- ✅ **Dynamic Service Integration**: Automatic service discovery and configuration based on Docker labels\n- ✅ **Multiple Certificate Configurations**: Support for both ACME automatic certificate issuance and local certificates\n- ✅ **HTTP/3 Support**: Enable HTTP/3 (QUIC) protocol support\n- ✅ **Dashboard Interface**: Built-in Traefik Dashboard visualization interface\n- ✅ **HTTPS Redirect**: Automatically redirect HTTP requests to HTTPS\n- ✅ **GZIP Compression**: Automatically enable response content compression\n- ✅ **Health Checks**: Built-in health check mechanism\n- ✅ **Production Ready**: Anonymous data collection and version checking disabled, suitable for production environments\n\n## Project Structure\n\n```\ntraefik-v3-example/\n├── scripts/                   # Utility scripts directory\n│   └── prepare-network.sh    # Docker network creation script\n├── traefik/                   # Traefik service configurations\n│   ├── base/                 # Base configuration (requires environment variables)\n│   ├── acme/                 # ACME automatic certificate configuration\n│   └── local-certs/          # Local certificate configuration\n├── traefik-make-local-certs/  # Certificate generation tool\n├── traefik-app-examples/     # Application integration examples\n│   ├── flare/                # Flare service integration example\n│   ├── stargate/             # Stargate Forward Auth service example\n│   └── owlmail/              # OwlMail email testing service example\n├── README.md                  # This document (English)\n└── README.zh.md               # This document (Chinese)\n```\n\n## Quick Start\n\n### Prerequisites\n\n- Docker 20.10+\n- Docker Compose 2.0+\n- Basic Linux/Unix command line knowledge\n\n### Step 1: Prepare Docker Network\n\nTraefik requires a dedicated Docker network:\n\n```bash\n./scripts/prepare-network.sh\n```\n\nOr create it manually:\n\n```bash\ndocker network create traefik\n```\n\n### Step 2: Choose Startup Method\n\nChoose different configuration methods based on your needs:\n\n#### Method 1: Use Local Certificates (Suitable for Testing)\n\n1. **Generate Self-Signed Certificates**:\n   - Refer to [Certificate Generation Tool Documentation](traefik-make-local-certs/README.md)\n\n2. **Start Traefik**:\n   - Refer to [Local Certificate Configuration Documentation](traefik/local-certs/README.md)\n\n#### Method 2: Use ACME Automatic Certificate (Suitable for Production)\n\n1. **Configure ACME**:\n   - Refer to [ACME Configuration Documentation](traefik/acme/README.md)\n\n2. **Start Traefik**:\n   - Refer to [ACME Configuration Documentation](traefik/acme/README.md)\n\n#### Method 3: Use Base Configuration (Requires Complete Environment Variables)\n\n- Refer to [Base Configuration Documentation](traefik/base/README.md)\n\n### Step 3: Access Dashboard\n\nAfter successful startup, access the Traefik Dashboard:\n\n- HTTPS: `https://traefik.example.com/dashboard/`\n- API: `https://traefik.example.com/api/`\n\n\u003e Note: Please replace `traefik.example.com` with your actual configured domain name and ensure DNS resolution is correct.\n\n## Detailed Documentation\n\n### Traefik Configuration\n\n- **[Base Configuration](traefik/base/README.md)**: Requires complete environment variable configuration, supports both ACME and local certificates\n- **[ACME Certificate Configuration](traefik/acme/README.md)**: Uses Let's Encrypt automatic certificate issuance (requires DNS API Token)\n- **[Local Certificate Configuration](traefik/local-certs/README.md)**: Uses local self-signed certificates, suitable for testing environments\n\n### Tools and Examples\n\n- **[Certificate Generation Tool](traefik-make-local-certs/README.md)**: Uses certs-maker container to generate self-signed certificates\n- **[Flare Service Example](traefik-app-examples/flare/README.md)**: Complete example of Flare service integration with Traefik\n- **[Stargate Forward Auth Example](traefik-app-examples/stargate/README.md)**: Stargate authentication service integration example, includes protected service demonstration\n- **[OwlMail Email Testing Service Example](traefik-app-examples/owlmail/README.md)**: OwlMail email testing service integration example, supports SMTP and Web interface\n\n## Related Resources\n\n### Complete Usage Guide\n\n- [Best Practices for Traefik 3 in Docker: Quick Start](https://soulteary.com/2024/08/04/best-practices-for-traefik-3-in-docker-getting-started-quickly.html)\n\n### Related Projects\n\n- [Traefik](https://github.com/traefik/traefik) - Cloud-native reverse proxy and load balancer\n- [certs-maker](https://github.com/soulteary/certs-maker) - Certificate generation tool\n- [docker-flare](https://github.com/soulteary/docker-flare) - Flare service Docker image\n- [Stargate](https://github.com/soulteary/stargate) - Lightweight Forward Auth authentication service\n- [OwlMail](https://github.com/soulteary/owlmail) - Email development and testing tool, compatible with MailDev\n\n### Official Documentation\n\n- [Traefik Official Documentation](https://doc.traefik.io/traefik/)\n- [Traefik Docker Provider](https://doc.traefik.io/traefik/providers/docker/)\n- [Traefik ACME Configuration](https://doc.traefik.io/traefik/https/acme/)\n\n## License\n\nSee the [LICENSE](LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsoulteary%2Ftraefik-v3-example","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsoulteary%2Ftraefik-v3-example","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsoulteary%2Ftraefik-v3-example/lists"}