Use double dashes in docs (oauth2-proxy#530)

We only supports double dash (`--`) now, so update docs to reflect this.
dynata · May 9, 2020 · 9ed5a43 · 9ed5a43
1 parent 8d3de2d
commit 9ed5a43
Show file tree

Hide file tree

Showing 3 changed files with 114 additions and 114 deletions.
diff --git a/docs/2_auth.md b/docs/2_auth.md
@@ -306,7 +306,7 @@ If you encounter this, then you can create a `jwt_signing_key.pem` file in the t
 directory of the repo which contains the key in PEM format and then do your docker build.
 The docker build process will copy that file into your image which you can then access by
 setting the `OAUTH2_PROXY_JWT_KEY_FILE=/etc/ssl/private/jwt_signing_key.pem`
-environment variable, or by setting `-jwt-key-file=/etc/ssl/private/jwt_signing_key.pem` on the commandline.
+environment variable, or by setting `--jwt-key-file=/etc/ssl/private/jwt_signing_key.pem` on the commandline.
 
 Once it is running, you should be able to go to `http://localhost:4180/` in your browser,
 get authenticated by the login.gov integration server, and then get proxied on to your
@@ -318,7 +318,7 @@ proxy, and you would use real hostnames everywhere.
 
 Some providers do not support OIDC discovery via their issuer URL, so oauth2-proxy cannot simply grab the authorization, token and jwks URI endpoints from the provider's metadata.
 
-In this case, you can set the `-skip-oidc-discovery` option, and supply those required endpoints manually:
+In this case, you can set the `--skip-oidc-discovery` option, and supply those required endpoints manually:
 
 ```
     -provider oidc

diff --git a/docs/5_endpoints.md b/docs/5_endpoints.md
@@ -36,4 +36,4 @@ X-Auth-Request-Redirect: https://my-oidc-provider/sign_out_page
 
 (The "sign_out_page" should be the [`end_session_endpoint`](https://openid.net/specs/openid-connect-session-1_0.html#rfc.section.2.1) from [the metadata](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfig) if your OIDC provider supports Session Management and Discovery.)
 
-BEWARE that the domain you want to redirect to (`my-oidc-provider.example.com` in the example) must be added to the [`-whitelist-domain`](configuration) configuration option otherwise the redirect will be ignored.
+BEWARE that the domain you want to redirect to (`my-oidc-provider.example.com` in the example) must be added to the [`--whitelist-domain`](configuration) configuration option otherwise the redirect will be ignored.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -36,4 +36,4 @@ X-Auth-Request-Redirect: https://my-oidc-provider/sign_out_page

		(The "sign_out_page" should be the [`end_session_endpoint`](https://openid.net/specs/openid-connect-session-1_0.html#rfc.section.2.1) from [the metadata](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfig) if your OIDC provider supports Session Management and Discovery.)

		BEWARE that the domain you want to redirect to (`my-oidc-provider.example.com` in the example) must be added to the [`-whitelist-domain`](configuration) configuration option otherwise the redirect will be ignored.
		BEWARE that the domain you want to redirect to (`my-oidc-provider.example.com` in the example) must be added to the [`--whitelist-domain`](configuration) configuration option otherwise the redirect will be ignored.