Explorar o código

Server: Readme documentation for server run on localhost

Christian Kahlau %!s(int64=2) %!d(string=hai) anos
pai
achega
8820bd2d7f
Modificáronse 1 ficheiros con 69 adicións e 0 borrados
  1. 69 0
      Readme.md

+ 69 - 0
Readme.md

@@ -10,6 +10,75 @@ curl -fsSL https://gogs.hostbbq.com/hostbbq/hostbbq-monitoring/raw/master/daemon
 
 ## Monitoring Server & Web UI
 
+### Local Development
+
+> ℹ Für Entwicklungszwecke kann der Monitoring Server auch lokal betrieben werden. ⚠ Dabei muss allerdings darauf geachtet werden, dass der Sync für die Server Metrics deaktiviert ist (`DEV_MODE=1`), damit der lokale DEV Server nicht der Live-Instanz die Server Metrics Daten weg klaut.
+
+1. Runtime Dependencies installieren:
+
+```bash
+$ cd server/
+$ npm install
+```
+
+2. Live-Datenbank kopieren:
+
+z.B. per Terminal mittels `scp`:
+
+```bash
+$ mkdir data
+$ scp -p <user>@portantonio.hostbbq.net:/opt/hbbq/monitoring/data/data.db ./data/data-live.db
+
+# data/data-live.db als Sicherung behalten, falls was schief geht,
+# data/data.db aus Kopie von data/data-live.db erstellen:
+$ cp data/data-live.db data/data.db
+```
+
+... oder auch einfach manuell mit WinSCP/FileZilla/... (ℹ Das Datenbank-File muss nach `server/data/data.db` - falls Unterordner noch nicht vorhanden, anlegen.)
+
+3. `.env`-File (in `server/`-Root) mit folgendem Inhalt anlegen:
+
+```bash
+LOG_LEVEL=DEBUG
+WEB_PORT=8880
+DATA_DIR=data
+GOOGLE_APPLICATION_CREDENTIALS="google-cloud/firebase-adminsdk.json"
+NOTIFICATION_ICON_URL="https://fcm.hostbbq.net/logo.png"
+DEV_MODE=1
+```
+
+4. Server starten:
+
+```bash
+$ npm start
+```
+
+Danach sollte der Server unter [http://localhost:8880]() zur Verfügung stehen.
+
+5. Angular Dev Server Proxy umleiten:
+
+`ng/proxy-conf.json`:
+
+```diff
+@@ -1,7 +1,7 @@
+ [
+   {
+     "context": ["/api"],
+-    "target": "http://10.8.0.1:8880",
++    "target": "http://localhost:8880",
+     "secure": false,
+     "pathRewrite": { "^/api": "" }
+   }
+```
+
+6. Angular Dev Server wie gewohnt starten:
+
+```bash
+$ cd ng/
+$ (npm install)?
+$ npm start
+```
+
 ### Install
 
 ```bash