Skip to content
This repository was archived by the owner on Mar 6, 2025. It is now read-only.

Commit 26bdca4

Browse files
committed
doc: update readme
1 parent e191651 commit 26bdca4

1 file changed

Lines changed: 19 additions & 1 deletion

File tree

README.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,25 @@ of serving an entire Charm instance:
185185
charm serve
186186
```
187187

188-
To change hosts users can set `CHARM_HOST` to the domain or IP or their
188+
### Server settings
189+
190+
The Charm server can be configured using environment variables. These are the defaults:
191+
192+
* `CHARM_SERVER_BIND_ADDRESS`: Network interface to listen to (_default 0.0.0.0_)
193+
* `CHARM_SERVER_HOST`: Hostname to advertise (_default localhost_)
194+
* `CHARM_SERVER_SSH_PORT`: SSH server port to listen to (_default 35353_)
195+
* `CHARM_SERVER_HTTP_PORT`: HTTP server port to listen to (_default 35354_)
196+
* `CHARM_SERVER_STATS_PORT`: Stats server port to listen to (_default 35355_)
197+
* `CHARM_SERVER_HEALTH_PORT`: Health server port to listen to (_default 35356_)
198+
* `CHARM_SERVER_DATA_DIR`: Server data directory (_default ./data_)
199+
* `CHARM_SERVER_USE_TLS`: Whether to use TLS (_default false_)
200+
* `CHARM_SERVER_TLS_KEY_FILE`: The TLS key file path to use
201+
* `CHARM_SERVER_TLS_CERT_FILE`: The TLS cert file path to use
202+
* `CHARM_SERVER_PUBLIC_URL`: Server public URL, useful when hosting the Charm server behind a TLS enabled reverse proxy
203+
* `CHARM_SERVER_ENABLE_METRICS`: Whether to enable collecting Prometheus metrics (_default false_) Metrics can be accessed from `http://<CHARM_SERVER_HOST>:<CHARM_SERVER_STATS_PORT>/metrics`
204+
* `CHARM_SERVER_USER_MAX_STORAGE`: Maximum FS storage for a user (_default 0_) Zero means no limit
205+
206+
To change hosts, users can set `CHARM_HOST` to the domain or IP of their
189207
choosing:
190208

191209
```bash

0 commit comments

Comments
 (0)