47 lines
1.4 KiB
Markdown
47 lines
1.4 KiB
Markdown
# Config
|
|
|
|
This directory is for repository-managed service configuration templates and configuration examples for Atlas.
|
|
|
|
## What Belongs Here
|
|
|
|
- nginx templates.
|
|
- systemd unit templates.
|
|
- SQL Server configuration templates.
|
|
- Non-secret example configuration.
|
|
- Documented placeholders for environment variables.
|
|
|
|
## What Must Not Be Stored Here
|
|
|
|
- Live configuration containing secrets.
|
|
- `.env` files.
|
|
- Private keys.
|
|
- TLS private keys or live certificates.
|
|
- Database backups.
|
|
- Machine-local overrides.
|
|
|
|
## Naming Conventions
|
|
|
|
- Use lower-case directory names.
|
|
- Use lower-case hyphenated file names.
|
|
- Use `.template`, `.example`, or `.sample` for files that are not live configuration.
|
|
- Use clear placeholder names such as `CHANGE_ME` or `${ENV_VAR_NAME}`.
|
|
|
|
## Expected Future Structure
|
|
|
|
Current planned areas include:
|
|
|
|
```text
|
|
config/nginx/
|
|
config/sql-server/
|
|
config/sqlserver/
|
|
config/systemd/
|
|
```
|
|
|
|
Additional service directories may be added when those services are implemented.
|
|
|
|
`config/sql-server/` contains the version-controlled Docker Compose definition and safe example environment file for the SQL Server container. The live environment file is stored outside the repository at `/etc/atlas/sql-server.env`.
|
|
|
|
## Security Considerations
|
|
|
|
Configuration templates must not contain live secrets. Secret-bearing live files should be stored outside the repository and referenced by documented paths or environment variable names.
|