- Installation — binary downloads, building from source, package managers
- Quick Start Guide — first run with env and file backends
- Docker — Docker images, Docker Compose, Kubernetes
- Configuration Guide — config file format, hierarchy, all options
- Command-Line Flags — global flags, backend-specific flags, environment variables
- Template Resources — template resource TOML files (
conf.d/*.toml) - Template Functions — Go template functions available in templates
Each backend has its own README with authentication, options, and examples:
| Backend | Guide | Watch Support |
|---|---|---|
| etcd | README | Yes |
| Consul | README | Yes |
| Vault | README | No |
| Redis | README | Yes |
| Zookeeper | README | Yes |
| File | README | Yes |
| Environment Variables | README | No |
| DynamoDB | README | No |
| SSM Parameter Store | README | No |
| Secrets Manager | README | No |
| ACM | README | No |
| EC2 IMDS | README | No |
- Multi-Backend Architectures — using multiple backends simultaneously (e.g., Consul for config + Vault for secrets)
- DNS SRV Records — backend node discovery via DNS SRV
- Service Deployment — systemd, Docker, Kubernetes deployment patterns
- Logging — log levels, JSON format, structured logging
- Noop Mode — dry runs, diff output, safe testing
- Architecture — package structure, execution flow, design patterns
- Development Guide — building, testing, debugging, adding backends
- Release Checklist — versioning, tagging, goreleaser workflow
- Contributing — code style, commit conventions, PR process