From 6da07c8be89be0d40e8bdae9d773bfb5d2d33ad9 Mon Sep 17 00:00:00 2001 From: "kali kaneko (leap communications)" Date: Tue, 4 Feb 2020 21:15:48 +0100 Subject: [docs] document flags and env vars - Resolves: #5 --- README.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 5848fb2..e423b67 100644 --- a/README.md +++ b/README.md @@ -3,4 +3,36 @@ vpnweb A minimalistic webapp in Go to service API/JSON for the LEAP VPN +Configuration +------------- + +You can pass generic configuration options either as a flag or an environment +variable. Some specific options can be passed only as env vars (like +authentication credentials). + +| Flag | Env var | default | Description | +|-------------------|:--------------------:|----------------------|-------------------------------------------------------:| +| **apiPath** | `VPNWEB_API_PATH` | /etc/leap/config/vpn | _Path for the public API static files_ | +| **providerCaCrt** | `VPNWEB_PROVIDER_CA` | /etc/leap/ca/ca.crt | _Path for the provider CA certificate_ | +| **port** | `VPNWEB_PORT` | 8000 | _Port where the server will listen_ | +| **tls** | | false | _Enable TLS on the service_ | +| **tlsCrt** | `VPNWEB_TLSCRT` | | _Path to the cert file for TLS_ | +| **tlsKey** | `VPNWEB_TLSKEY` | | _Path to the key file for TLS_ | +| **vpnCaCrt** | `VPNWEB_CACRT` | | _Path to the CA public key used for VPN certificates_ | +| **vpnCaKey** | `VPNWEB_CAKEY` | | _Path to the CA private key used for VPN certificates_ | +| **auth** | `VPNWEB_AUTH` | | _Authentication module to use (one of: sip2, anon)_ | +| **authSecret** | `VPNWEB_AUTH_SECRET` | | _Authentication secret to sign auth tokens_ | + + +SIP2 authentication: + +| Env var | Description | +|:-----------------------------:|-----------------------------------------------------:| +| `VPNWEB_SIP_USER` | Administrative user for the SIP2 telnet interface | +| `VPNWEB_SIP_PASS` | Administrative pass for the SIP2 telnet interface | +| `VPNWEB_SIP_HOST` | Host to connect to the SIP2 telnet interface | +| `VPNWEB_SIP_PORT` | Port to connect to the SIP2 telnet interface | +| `VPNWEB_SIP_LIBR_LOCATION` | Port to connect to the SIP2 telnet interface | +| `VPNWEB_SIP_TERMINATOR` | Telnet terminator used by the endpoint (default: \r) | + -- cgit v1.2.3