Skip to content

Commit 456012a

Browse files
authored
Document example configuration files in README
Added details about example configuration files in the README.
1 parent 2f21cb2 commit 456012a

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,18 @@ Configuration for the application tries to emulate the mod_epp configuration as
105105
to make migration easier. The configuration is placed in `config/sys.config` file, it takes a format
106106
of Erlang property list.
107107

108+
There are three example configuration files in `config/`:
109+
110+
* `sys.config` – default configuration used for real deployments. Values such as `tls_port`,
111+
`epp_session_url` and certificate paths are typically provided via environment variables (eg.
112+
`${TLS_PORT}`, `${EPP_SESSION_URL}`), so the same file can be reused across environments.
113+
* `docker.config` – configuration tuned for running inside Docker. It uses hardcoded ports,
114+
certificate paths under `/opt/ca/...` and EPP endpoints pointing to the `epp` container
115+
(eg. `http://epp:3000/epp/…`).
116+
* `test.config` – local development/test configuration. It enables `dev_mode`, uses local ports
117+
and points EPP endpoints to `http://localhost:9292/...`, with test CA material under
118+
`test_ca/`.
119+
108120
*Configuration variables*
109121

110122
| Variable name | Expected values | Apache equivalent | Definition

0 commit comments

Comments
 (0)