]> Untitled Git - lemmy-ui.git/blobdiff - README.md
Merge branch 'custom-emojis' of https://github.com/makotech222/lemmy-ui into makotech...
[lemmy-ui.git] / README.md
index 5ecb19149dde47ccf7d28711d8f5935025313768..e1e6e1fda2e8051367d01ecc79eb9b5ff02fd612 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,4 +1,21 @@
-# lemmy-isomorphic-ui\r
+# lemmy-ui\r
 \r
-A trial run at making an isomorphic UI for lemmy, based off of MrFoxPro's [inferno-isomorphic-template](https://github.com/MrFoxPro/inferno-isomorphic-template).\r
+The official web app for [Lemmy](https://github.com/LemmyNet/lemmy), written in inferno.\r
 \r
+Based off of MrFoxPro's [inferno-isomorphic-template](https://github.com/MrFoxPro/inferno-isomorphic-template).\r
+\r
+## Configuration\r
+\r
+The following environment variables can be used to configure lemmy-ui:\r
+\r
+`ENV_VAR` | type | default | description\r
+--- | --- | --- | ---\r
+`LEMMY_UI_HOST` | `string` | `0.0.0.0:1234` | The IP / port that the lemmy-ui isomorphic node server is hosted at.\r
+`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
+`LEMMY_UI_LEMMY_EXTERNAL_HOST` | `string` | `0.0.0.0:8536` | The external IP / port that lemmy is hosted at. Often `DOMAIN.TLD`.\r
+`LEMMY_UI_LEMMY_WS_HOST` | `string` | `0.0.0.0:8536` | An alternate location for lemmy's websocket address. Not usually necessary.\r
+`LEMMY_UI_HTTPS` | `bool` | `false` | Whether to use https.\r
+`LEMMY_UI_EXTRA_THEMES_FOLDER` | `string` | `./extra_themes` | A location for additional lemmy css themes.\r
+`LEMMY_UI_DEBUG` | `bool` | `false` | Loads the [Eruda](https://github.com/liriliri/eruda) debugging utility.\r
+`LEMMY_UI_DISABLE_CSP` | `bool` | `false` | Disables CSP security headers\r
+`LEMMY_UI_CUSTOM_HTML_HEADER` | `string` | | Injects a custom script into `<head>`.\r