diff --git a/README.md b/README.md index 1bde97a..92c44bd 100644 --- a/README.md +++ b/README.md @@ -68,7 +68,7 @@ keypresses silently stop working. Run the test after touching that code; assets/ calibration.bin 512-byte dump from a real radio deploy/ nginx vhost for the HTTPS front end - docs/reverse-proxy.md how https://k6v6.mckero.dn42/ is served + docs/reverse-proxy.md how https://k6v3.mckero.dn42/ is served docs/screenshots/ LCD captures used in this README tools/ run, screenshot, inject keys, probe state keypad_test.py keypad regression test, boots its own instance @@ -190,7 +190,7 @@ Two constraints worth knowing before you use it: ### Reaching it from elsewhere The deployment here runs the server on loopback and puts nginx in front of it for -TLS, at `https://k6v6.mckero.dn42/`. See +TLS, at `https://k6v3.mckero.dn42/`. See [docs/reverse-proxy.md](docs/reverse-proxy.md) for the vhost, including the two settings that matter for this app: `proxy_buffering off` (or the frame stream arrives in bursts) and `X-Forwarded-For` (or every log line is attributed to diff --git a/deploy/nginx-k6v6.conf b/deploy/nginx-k6v3.conf similarity index 96% rename from deploy/nginx-k6v6.conf rename to deploy/nginx-k6v3.conf index 7103243..6632573 100644 --- a/deploy/nginx-k6v6.conf +++ b/deploy/nginx-k6v3.conf @@ -9,14 +9,14 @@ server { listen 172.21.91.140:80; listen [fd3c:3f9b:6424:2::5]:80; - server_name k6v6.mckero.dn42; + server_name k6v3.mckero.dn42; return 301 https://$host$request_uri; } server { listen 172.21.91.140:443 ssl; listen [fd3c:3f9b:6424:2::5]:443 ssl; - server_name k6v6.mckero.dn42; + server_name k6v3.mckero.dn42; ssl_certificate /etc/letsencrypt/live/mckero-wildcard/fullchain.pem; ssl_certificate_key /etc/letsencrypt/live/mckero-wildcard/privkey.pem; diff --git a/docs/reverse-proxy.md b/docs/reverse-proxy.md index e12cdeb..afb1db1 100644 --- a/docs/reverse-proxy.md +++ b/docs/reverse-proxy.md @@ -1,6 +1,6 @@ # Serving the web UI over HTTPS -How `https://k6v6.mckero.dn42/` is set up on this host. The emulator UI itself +How `https://k6v3.mckero.dn42/` is set up on this host. The emulator UI itself speaks plain HTTP on loopback; nginx terminates TLS and proxies to it. ## Why a proxy at all @@ -11,21 +11,21 @@ letting nginx face the network means the existing certificate and the existing ## The vhost -Lives in `/etc/nginx/sites-available/k6v6`, symlinked into `sites-enabled/`. A copy -is kept in this repo at [`deploy/nginx-k6v6.conf`](../deploy/nginx-k6v6.conf), since +Lives in `/etc/nginx/sites-available/k6v3`, symlinked into `sites-enabled/`. A copy +is kept in this repo at [`deploy/nginx-k6v3.conf`](../deploy/nginx-k6v3.conf), since nothing else here version-controls `/etc`. server { listen 172.21.91.140:80; listen [fd3c:3f9b:6424:2::5]:80; - server_name k6v6.mckero.dn42; + server_name k6v3.mckero.dn42; return 301 https://$host$request_uri; } server { listen 172.21.91.140:443 ssl; listen [fd3c:3f9b:6424:2::5]:443 ssl; - server_name k6v6.mckero.dn42; + server_name k6v3.mckero.dn42; ssl_certificate /etc/letsencrypt/live/mckero-wildcard/fullchain.pem; ssl_certificate_key /etc/letsencrypt/live/mckero-wildcard/privkey.pem; @@ -92,8 +92,8 @@ the UI is not reachable from the internet. Records to point at it: - k6v6.mckero.dn42. A 172.21.91.140 - k6v6.mckero.dn42. AAAA fd3c:3f9b:6424:2::5 + k6v3.mckero.dn42. A 172.21.91.140 + k6v3.mckero.dn42. AAAA fd3c:3f9b:6424:2::5 ## Pitfalls hit while setting this up @@ -114,19 +114,19 @@ connections, check `ss -ltnp | grep 443` before looking anywhere else. # both families, and check the certificate rather than skipping it with -k curl -s -o /dev/null -w '%{http_code}\n' \ - --resolve 'k6v6.mckero.dn42:443:172.21.91.140' \ - https://k6v6.mckero.dn42/ + --resolve 'k6v3.mckero.dn42:443:172.21.91.140' \ + https://k6v3.mckero.dn42/ curl -s -g -o /dev/null -w '%{http_code}\n' \ - --resolve 'k6v6.mckero.dn42:443:[fd3c:3f9b:6424:2::5]' \ - https://k6v6.mckero.dn42/ + --resolve 'k6v3.mckero.dn42:443:[fd3c:3f9b:6424:2::5]' \ + https://k6v3.mckero.dn42/ # the stream must deliver frames continuously, not in one burst at the end - curl -sk --resolve 'k6v6.mckero.dn42:443:172.21.91.140' \ - https://k6v6.mckero.dn42/stream | head -c 20000 | grep -c PNG + curl -sk --resolve 'k6v3.mckero.dn42:443:172.21.91.140' \ + https://k6v3.mckero.dn42/stream | head -c 20000 | grep -c PNG # log attribution: entries should carry the real client address, not 127.0.0.1 - curl -sk --resolve 'k6v6.mckero.dn42:443:172.21.91.140' \ - https://k6v6.mckero.dn42/api/logs + curl -sk --resolve 'k6v3.mckero.dn42:443:172.21.91.140' \ + https://k6v3.mckero.dn42/api/logs Measured after setup: HTTP 200 on both families with the certificate validating, first stream frame in 0.01 s, 7 frames in 12 s on an idle screen, and log entries