]> Untitled Git - lemmy-ui.git/blob - README.md
Documenting and changing a few env vars. Fixes #661 (#739)
[lemmy-ui.git] / README.md
1 # lemmy-ui\r
2 \r
3 The official web app for [Lemmy](https://github.com/LemmyNet/lemmy), written in inferno.\r
4 \r
5 Based off of MrFoxPro's [inferno-isomorphic-template](https://github.com/MrFoxPro/inferno-isomorphic-template).\r
6 \r
7 ## Configuration\r
8 \r
9 The following environment variables can be used to configure lemmy-ui:\r
10 \r
11 `ENV_VAR` | type | default | description\r
12 --- | --- | --- | ---\r
13 `LEMMY_UI_HOST` | `string` | `0.0.0.0:1234` | The IP / port that the lemmy-ui isomorphic node server is hosted at.\r
14 `LEMMY_UI_LEMMY_INTERNAL_HOST` | `string` | `0.0.0.0:8536` | The internal IP / port that lemmy is hosted at. Often `lemmy:8536` if using docker.\r
15 `LEMMY_UI_LEMMY_EXTERNAL_HOST` | `string` | `0.0.0.0:8536` | The external IP / port that lemmy is hosted at. Often `DOMAIN.TLD`.\r
16 `LEMMY_UI_LEMMY_WS_HOST` | `string` | `0.0.0.0:8536` | An alternate location for lemmy's websocket address. Not usually necessary.\r
17 `LEMMY_UI_HTTPS` | `bool` | `false` | Whether to use https.\r
18 `LEMMY_UI_EXTRA_THEMES_FOLDER` | `string` | `./extra_themes` | A location for additional lemmy css themes.\r
19 `LEMMY_UI_DEBUG` | `bool` | `false` | Loads the [Eruda](https://github.com/liriliri/eruda) debugging utility.\r
20 `LEMMY_UI_DISABLE_CSP` | `bool` | `false` | Disables CSP security headers\r
21 `LEMMY_UI_CUSTOM_HTML_HEADER` | `string` | | Injects a custom script into `<head>`.\r