Skip to content

Commit

Permalink
Merge pull request #3 from LinkMaq/v0.1.3-docs
Browse files Browse the repository at this point in the history
docs: update ReadMe
  • Loading branch information
LinkMaq authored Oct 11, 2022
2 parents e8f56fc + 9fc8d61 commit 168e89c
Showing 1 changed file with 16 additions and 3 deletions.
19 changes: 16 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,8 @@ Usage:
modelxd [flags]
Flags:
--ca-file string tls ca file
--cert-file string tls cert file
--enable-redirect enable blob storage redirect
-h, --help help for modelxd
--key-file string tls key file
--listen string listen address (default ":8080")
--oidc-issuer string oidc issuer
--s3-access-key string s3 access key
Expand All @@ -58,6 +55,9 @@ Flags:
--s3-region string s3 region
--s3-secret-key string s3 secret key
--s3-url string s3 url (default "https://s3.amazonaws.com")
--tls-ca string tls ca file
--tls-cert string tls cert file
--tls-key string tls key file
-v, --version version for modelxd
```

Expand All @@ -74,6 +74,19 @@ modelxd --listen=:8080 \
--enable-redirect=true
```

**Using HTTPS**

If both of the following options are provided, the server will listen and serve HTTPS:

- --tls-cert=<crt> - path to tls certificate chain file
- --tls-key=<key> - path to tls key file

HTTPS with Client Certificate Authentication

If the above HTTPS values are provided in addition to below, the server will listen and serve HTTPS and authenticate client requests against the CA certificate:

- --tls-ca-cert=<cacert> - path to tls certificate file

**Using OIDC with KubeGems**

Make sure you KubeGems API is properly access
Expand Down

0 comments on commit 168e89c

Please sign in to comment.