]> Untitled Git - lemmy-ui.git/blob - README.md
fix submodule error
[lemmy-ui.git] / README.md
1 # Lemmy-UI
2
3 The official web app for [Lemmy](https://github.com/LemmyNet/lemmy), written in inferno.
4
5 Based off of MrFoxPro's [inferno-isomorphic-template](https://github.com/MrFoxPro/inferno-isomorphic-template).
6
7 ## Configuration
8
9 The following environment variables can be used to configure lemmy-ui:
10
11 | `ENV_VAR`                      | type     | default          | description                                                                         |
12 | ------------------------------ | -------- | ---------------- | ----------------------------------------------------------------------------------- |
13 | `LEMMY_UI_HOST`                | `string` | `0.0.0.0:1234`   | The IP / port that the lemmy-ui isomorphic node server is hosted at.                |
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. |
15 | `LEMMY_UI_LEMMY_EXTERNAL_HOST` | `string` | `0.0.0.0:8536`   | The external IP / port that lemmy is hosted at. Often `DOMAIN.TLD`.                 |
16 | `LEMMY_UI_HTTPS`               | `bool`   | `false`          | Whether to use https.                                                               |
17 | `LEMMY_UI_EXTRA_THEMES_FOLDER` | `string` | `./extra_themes` | A location for additional lemmy css themes.                                         |
18 | `LEMMY_UI_DEBUG`               | `bool`   | `false`          | Loads the [Eruda](https://github.com/liriliri/eruda) debugging utility.             |
19 | `LEMMY_UI_DISABLE_CSP`         | `bool`   | `false`          | Disables CSP security headers                                                       |
20 | `LEMMY_UI_CUSTOM_HTML_HEADER`  | `string` |                  | Injects a custom script into `<head>`.                                              |