Initial Commit

README.md

@@ -1,3 +1,52 @@
-# Port-Forwarding-Services
+# RelayDock
 
-This is a Full Stack Port Forwarding Service. You can run it on a linux machine and forward a port with a extra systemd service.
+## Pakete installieren
+
+```bash
+sudo apt update
+sudo apt install -y python3-flask socat jq
+```
+
+## Dateien kopieren
+
+```bash
+sudo mkdir -p /opt/relaydock-web /etc/relaydock
+sudo cp -r ./* /opt/relaydock-web/
+sudo cp /opt/relaydock-web/config.json /etc/relaydock/config.json
+sudo cp /opt/relaydock-web/relaydock@.service /etc/systemd/system/
+sudo cp /opt/relaydock-web/relaydock.target /etc/systemd/system/
+sudo cp /opt/relaydock-web/relaydock-web.service /etc/systemd/system/
+sudo cp /opt/relaydock-web/relaydock-instance.sh /usr/local/bin/
+sudo cp /opt/relaydock-web/relaydock-reconcile.sh /usr/local/bin/
+sudo chmod +x /usr/local/bin/relaydock-instance.sh /usr/local/bin/relaydock-reconcile.sh
+```
+
+## sudoers für Web-UI
+
+```bash
+sudo visudo
+```
+
+Dann ergänzen:
+
+```text
+www-data ALL=(ALL) NOPASSWD: /bin/systemctl start relaydock@*.service
+www-data ALL=(ALL) NOPASSWD: /bin/systemctl stop relaydock@*.service
+www-data ALL=(ALL) NOPASSWD: /bin/systemctl restart relaydock@*.service
+www-data ALL=(ALL) NOPASSWD: /bin/systemctl daemon-reload
+www-data ALL=(ALL) NOPASSWD: /usr/local/bin/relaydock-reconcile.sh *
+```
+
+Wenn du den Webdienst als root laufen lässt, brauchst du das nicht, sicherer ist aber ein eigener User mit sauberem sudoers-Eintrag.
+
+## Start
+
+```bash
+sudo systemctl daemon-reload
+sudo systemctl enable --now relaydock-web.service
+sudo /usr/local/bin/relaydock-reconcile.sh /etc/relaydock/config.json
+```
+
+## Aufruf
+
+Weboberfläche dann auf Port 8080 öffnen.