X-Git-Url: http://these/git/?a=blobdiff_plain;f=README.md;h=f1917bff15cf07d6f27e61e5aa6fa47cf6ece068;hb=HEAD;hp=e1e6e1fda2e8051367d01ecc79eb9b5ff02fd612;hpb=c2f628312f76c726f002d3bafbe8eb9f78109947;p=lemmy-ui.git diff --git a/README.md b/README.md index e1e6e1f..f1917bf 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,20 @@ -# lemmy-ui - -The official web app for [Lemmy](https://github.com/LemmyNet/lemmy), written in inferno. - -Based off of MrFoxPro's [inferno-isomorphic-template](https://github.com/MrFoxPro/inferno-isomorphic-template). - -## Configuration - -The following environment variables can be used to configure lemmy-ui: - -`ENV_VAR` | type | default | description ---- | --- | --- | --- -`LEMMY_UI_HOST` | `string` | `0.0.0.0:1234` | The IP / port that the lemmy-ui isomorphic node server is hosted at. -`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. -`LEMMY_UI_LEMMY_EXTERNAL_HOST` | `string` | `0.0.0.0:8536` | The external IP / port that lemmy is hosted at. Often `DOMAIN.TLD`. -`LEMMY_UI_LEMMY_WS_HOST` | `string` | `0.0.0.0:8536` | An alternate location for lemmy's websocket address. Not usually necessary. -`LEMMY_UI_HTTPS` | `bool` | `false` | Whether to use https. -`LEMMY_UI_EXTRA_THEMES_FOLDER` | `string` | `./extra_themes` | A location for additional lemmy css themes. -`LEMMY_UI_DEBUG` | `bool` | `false` | Loads the [Eruda](https://github.com/liriliri/eruda) debugging utility. -`LEMMY_UI_DISABLE_CSP` | `bool` | `false` | Disables CSP security headers -`LEMMY_UI_CUSTOM_HTML_HEADER` | `string` | | Injects a custom script into ``. +# Lemmy-UI + +The official web app for [Lemmy](https://github.com/LemmyNet/lemmy), written in inferno. + +Based off of MrFoxPro's [inferno-isomorphic-template](https://github.com/MrFoxPro/inferno-isomorphic-template). + +## Configuration + +The following environment variables can be used to configure lemmy-ui: + +| `ENV_VAR` | type | default | description | +| ------------------------------ | -------- | ---------------- | ----------------------------------------------------------------------------------- | +| `LEMMY_UI_HOST` | `string` | `0.0.0.0:1234` | The IP / port that the lemmy-ui isomorphic node server is hosted at. | +| `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. | +| `LEMMY_UI_LEMMY_EXTERNAL_HOST` | `string` | `0.0.0.0:8536` | The external IP / port that lemmy is hosted at. Often `DOMAIN.TLD`. | +| `LEMMY_UI_HTTPS` | `bool` | `false` | Whether to use https. | +| `LEMMY_UI_EXTRA_THEMES_FOLDER` | `string` | `./extra_themes` | A location for additional lemmy css themes. | +| `LEMMY_UI_DEBUG` | `bool` | `false` | Loads the [Eruda](https://github.com/liriliri/eruda) debugging utility. | +| `LEMMY_UI_DISABLE_CSP` | `bool` | `false` | Disables CSP security headers | +| `LEMMY_UI_CUSTOM_HTML_HEADER` | `string` | | Injects a custom script into ``. |