Skip to content

Commit 3509aae

Browse files
committed
make README for non-tls ports more readable
1 parent eabc748 commit 3509aae

2 files changed

Lines changed: 11 additions & 3 deletions

File tree

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,23 @@ go run ./cmd/snmp-proxy
2020

2121
By default the service listens on `https://localhost:8443`.
2222

23-
To use port `8080` with TLS enabled:
23+
To run HTTP on the default non-TLS port:
2424

2525
```bash
2626
SNMP_PROXY_BASIC_AUTH_USERNAME=user \
2727
SNMP_PROXY_BASIC_AUTH_PASSWORD=pass \
28-
SNMP_PROXY_LISTEN_ADDRESS=:8080 \
28+
SNMP_PROXY_TLS_ENABLED=false \
2929
go run ./cmd/snmp-proxy
3030
```
3131

32+
To enable TLS on any custom port, use the TLS flag with the listen-address flag:
33+
34+
```bash
35+
SNMP_PROXY_BASIC_AUTH_USERNAME=user \
36+
SNMP_PROXY_BASIC_AUTH_PASSWORD=pass \
37+
go run ./cmd/snmp-proxy -tls-enabled=true -listen-address=:9443
38+
```
39+
3240
## Docker
3341

3442
```bash

SPEC.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -416,7 +416,7 @@ Periodic stats should include at least:
416416

417417
| Variable | Default | Requirement |
418418
| --- | --- | --- |
419-
| `SNMP_PROXY_TLS_ENABLED` | `true` | boolean |
419+
| `SNMP_PROXY_TLS_ENABLED` | `true` | boolean; controls HTTP vs HTTPS independently of port |
420420
| `SNMP_PROXY_LISTEN_ADDRESS` | `:8443` with TLS, else `:8080` | valid listen address |
421421
| `SNMP_PROXY_TLS_CERT_PATH` | `certs/server.crt` | path |
422422
| `SNMP_PROXY_TLS_KEY_PATH` | `certs/server.key` | path |

0 commit comments

Comments
 (0)