From bbb9824ad1c3ddc1571548bf19bae912a967c44b Mon Sep 17 00:00:00 2001 From: "Stanislav N. aka pztrn" Date: Sat, 12 Oct 2024 23:22:22 +0500 Subject: [PATCH] Add doc for HTTP servers configuration. --- docs/HTTP.md | 16 ++++++++++++++++ docs/INDEX.md | 2 +- 2 files changed, 17 insertions(+), 1 deletion(-) create mode 100644 docs/HTTP.md diff --git a/docs/HTTP.md b/docs/HTTP.md new file mode 100644 index 0000000..a46a074 --- /dev/null +++ b/docs/HTTP.md @@ -0,0 +1,16 @@ +# HTTP in Featurer + +Featurer starts 2 HTTP servers: + +- API server. +- CMS server. + +**As for now only API server will be used.** + +## Configuring HTTP servers + +Configuration for HTTP servers should be specified in environment variables. All HTTP servers uses same variables, replace `%s` with server name (`API` or `CMS`). + +| Key | Format | Description | +| --- | --- | --- | +| FEATURER_%s_SERVER_ADDRESS | `ip:port` | IP and port to listen on for requests. | diff --git a/docs/INDEX.md b/docs/INDEX.md index 80f4437..fb57540 100644 --- a/docs/INDEX.md +++ b/docs/INDEX.md @@ -4,7 +4,7 @@ Welcome to Featurer's documentation! ## Administrator's corner -TBW +- [Configuring HTTP servers](HTTP.md) ## Users documentation