From 9c545d1ace4761598a4f94e06a749f669e7c7c88 Mon Sep 17 00:00:00 2001 From: Kilian Krause Date: Thu, 6 Jul 2023 00:02:01 +0200 Subject: [PATCH] fix documentation to match new TCP port of webui --- README.md | 4 ++-- contrib/README.md | 2 +- contrib/apache2.conf | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 99ec031..063ace2 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ Either clone repository (and install dependencies either through distribution or pipx install https://git-nks-public.tik.uni-stuttgart.de/net/python-capport -In production put a reverse proxy in front of the local web ui (on 127.0.0.1:8000), and handle `/static` path either to `src/capport/api/static/` or your customized version of static files. +In production put a reverse proxy in front of the local web ui (on 127.0.0.1:5001), and handle `/static` path either to `src/capport/api/static/` or your customized version of static files. See the `contrib` directory for config of other software needed to setup a captive portal. @@ -22,7 +22,7 @@ Requests with a `setlang=` query parameter will set the language and t ## Run -Run `./start-api.sh` to start the web ui (listens on 127.0.0.1:8000 by default). +Run `./start-api.sh` to start the web ui (listens on 127.0.0.1:5001 by default). Run `./start-control.sh` to start the "controller" ("enforcement") part; this needs to be run as root (i.e. as `CAP_NET_ADMIN` of the current network namespace). diff --git a/contrib/README.md b/contrib/README.md index c3bf77d..a06dce4 100644 --- a/contrib/README.md +++ b/contrib/README.md @@ -15,7 +15,7 @@ Network (HA) setup with IPv4 NAT: - webserver on nodes: * port 8080: receives transparent http redirects from the firewall; should return a temporary redirect to your portal page. * port 80: redirect to https - * port 443: reverse-proxy to 127.0.0.1:8000 (the webui backend), but serve `/static` directly from directory (see main README) + * port 443: reverse-proxy to 127.0.0.1:5001 (the webui backend), but serve `/static` directly from directory (see main README) To access the portal page on the clients you'll need a DNS-name; it should point to the virtual addresses. In some ways downlink address is preferred, but you also might want to avoid private addresses - i.e. use the uplink IPv4 address and the downlink IPv6 address. diff --git a/contrib/apache2.conf b/contrib/apache2.conf index eeec041..26ffa14 100644 --- a/contrib/apache2.conf +++ b/contrib/apache2.conf @@ -39,5 +39,5 @@ Listen 8080 ProxyRequests Off ProxyPreserveHost On ProxyPass /static ! - ProxyPass / http://127.0.0.1:8000/ + ProxyPass / http://127.0.0.1:5001/