summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorkali kaneko (leap communications) <kali@leap.se>2020-08-19 19:46:19 +0200
committerkali kaneko (leap communications) <kali@leap.se>2020-08-19 19:48:07 +0200
commitf5afa79d0a51b63006ee422b138f2f6aa17f7070 (patch)
treee65d730302c24cda8c73d53e143a6312a07342eb /README.md
parent12753e2c138c446fdd81809224c8cdf7f0ecea19 (diff)
[feat] passwordless-sip
Diffstat (limited to 'README.md')
-rw-r--r--README.md27
1 files changed, 14 insertions, 13 deletions
diff --git a/README.md b/README.md
index 6197957..60936a6 100644
--- a/README.md
+++ b/README.md
@@ -10,19 +10,20 @@ 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 api server will listen_ |
-| **metricsPort** | `VPNWEB_METRICS_PORT`| 8001 | _Port where the metrics 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_ |
+| 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 api server will listen_ |
+| **metricsPort** | `VPNWEB_METRICS_PORT` | 8001 | _Port where the metrics 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_ |
+| **passwordPolicy** | `VPNWEB_PASSWORD_POLICY` | require | _Password policy, if used (one of: require, ignore)_ |
SIP2 authentication: