Skip to content

Configuration template ​

Everything that changes how a repository behaves without a code change: environment variables, config files, secrets, feature flags and per-environment differences. Lives at docs/repos/<repo>/configuration.md.

Generated by npm run new:repo.

Never paste secret values

Document the name, purpose and where it is stored, never the value.

Template ​

md
---
title: "Configuration"
description: "Environment variables, config files, secrets and flags for {{repoName}}."
status: draft
---

# {{repoName}} configuration

TODO: One paragraph: how configuration is loaded (build time or runtime), and
where each environment's values live.

## Environment variables

| Variable | Required | Scope | Default | Description |
| --- | --- | --- | --- | --- |
| `TODO` | TODO | build / runtime / both | TODO | TODO |

## Configuration files

| File | Purpose | Notes |
| --- | --- | --- |
| `TODO` | TODO | TODO |

## Secrets

TODO: Which secrets exist, where they are stored (hosting dashboard, CI
secrets, local `.env` not committed), who can rotate them, and how.

| Secret | Stored in | Used by | Rotation |
| --- | --- | --- | --- |
| `TODO` | TODO | TODO | TODO |

## Environments

| Setting | Local | Preview | Production |
| --- | --- | --- | --- |
| TODO | TODO | TODO | TODO |

## Feature flags

TODO: Flags, where they are defined, and how to change them. Write `Not
applicable` if there are none.

## Local setup

```bash
# TODO: how to create a local config (e.g. copy an example env file)
```

Placeholders ​

text
{{repoName}}  Display name of the repository

Ediky Workflow — internal engineering documentation.