]> Untitled Git - lemmy-ui.git/commitdiff
Documenting and changing a few env vars. Fixes #661 (#739)
authorDessalines <dessalines@users.noreply.github.com>
Thu, 4 Aug 2022 18:21:20 +0000 (14:21 -0400)
committerGitHub <noreply@github.com>
Thu, 4 Aug 2022 18:21:20 +0000 (20:21 +0200)
README.md
src/server/index.tsx
src/shared/env.ts

index a6969d03a45f56995784c92e6031d496d7f3a18b..e1e6e1fda2e8051367d01ecc79eb9b5ff02fd612 100644 (file)
--- a/README.md
+++ b/README.md
@@ -3,3 +3,19 @@
 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
index d508dab33f28d84c92ccb1396446e136942bd5b5..ebaa9477633863e3df5113704215584c9db35a40 100644 (file)
@@ -189,7 +189,7 @@ server.get("/*", async (req, res) => {
     const symbols = renderToString(SYMBOLS);
     const helmet = Helmet.renderStatic();
 
-    const config: ILemmyConfig = { wsHost: process.env.LEMMY_WS_HOST };
+    const config: ILemmyConfig = { wsHost: process.env.LEMMY_UI_LEMMY_WS_HOST };
 
     res.send(`
            <!DOCTYPE html>
index 2088bd69d6af03d6119c86e426c08d5f890f96e1..12260e151106b9c20cc64088612a3c19f5fc9999 100644 (file)
@@ -3,7 +3,7 @@ import { isBrowser } from "./utils";
 const testHost = "0.0.0.0:8536";
 
 let internalHost =
-  (!isBrowser() && process.env.LEMMY_INTERNAL_HOST) || testHost; // used for local dev
+  (!isBrowser() && process.env.LEMMY_UI_LEMMY_INTERNAL_HOST) || testHost; // used for local dev
 export let externalHost: string;
 let host: string;
 let wsHost: string;
@@ -27,10 +27,10 @@ if (isBrowser()) {
   secure = window.location.protocol == "https:" ? "s" : "";
 } else {
   // server-side
-  externalHost = process.env.LEMMY_EXTERNAL_HOST || testHost;
+  externalHost = process.env.LEMMY_UI_LEMMY_EXTERNAL_HOST || testHost;
   host = internalHost;
-  wsHost = process.env.LEMMY_WS_HOST || externalHost;
-  secure = process.env.LEMMY_HTTPS == "true" ? "s" : "";
+  wsHost = process.env.LEMMY_UI_LEMMY_WS_HOST || externalHost;
+  secure = process.env.LEMMY_UI_HTTPS == "true" ? "s" : "";
 }
 
 export const httpBaseInternal = `http://${host}`; // Don't use secure here