Visit djangoplay.org ↗
djangoplay-cli / User guide / Configuration Guide
DocsDjangoPlay CLIUser guideConfiguration Guide

Configuration Guide

Create:

1 min readApplies to v1.0.6
On this page ▾
  1. Secrets
  2. Why configuration is outside the repository
text
~/.dplay/config.yaml

The CLI expects configuration for the development site and Django settings.

Example:

yaml
site:
  host: localhost
  http_port: 3333
  http_protocol: http
  http_url: http://localhost:3333
  ssl_port: 8443
  ssl_protocol: https
  ssl_url: https://localhost:8443

django:
  settings_module: paystream.settings

subdomains:
  - issues.localhost
  - docs.localhost

Secrets

Optional secrets are loaded from:

text
~/.dplay/.secrets

Format:

text
KEY=value
ANOTHER_KEY=another-value

Blank lines and # comments are ignored.

Do not commit secrets to the DjangoPlay repository.

Why configuration is outside the repository

The CLI is intended to be installed as a reusable developer tool. Machine-local configuration therefore lives under ~/.dplay instead of being embedded in the CLI package.