From 83d0ed4cb774478631780a916fb7250b8a88779b Mon Sep 17 00:00:00 2001 From: Paul Date: Sun, 22 Apr 2018 19:47:26 +0200 Subject: [PATCH] Improve documentation --- README.md | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index bf5a2bb..e2444c7 100644 --- a/README.md +++ b/README.md @@ -13,12 +13,14 @@ linked and have no additional dependencies. Supported plattforms are: Simply download them from the "artifacts" section of this project. ### Docker A prebuilt docker image (10MB) is available: -```bash + +``` docker pull docker.klink.asia/paul/certman ``` ### From Source-Docker You can easily build your own docker image from source -```bash + +``` docker build -t docker.klink.asia/paul/certman . ``` @@ -37,4 +39,12 @@ variables: * `OAUTH2_REDIRECT_URL` the redirect URL used by the app, usually the hostname suffixed by "/login/oauth2/redirect" * `USER_ENDPOINT` the URL to the Identity provider user endpoint, for gitlab this is "/api/v4/user". The "username" attribute of the returned JSON will used for authentication. * `APP_KEY` random ASCII string, 32 characters in length. Used for cookie generation. - * `APP_LISTEN` port and ip to listen on, e.g. `:8000` or `127.0.0.1:3000` \ No newline at end of file + * `APP_LISTEN` port and ip to listen on, e.g. `:8000` or `127.0.0.1:3000` + +There are some files that need to be mounted inside the container: + + * `/ca.crt` the certificate of the server PKI + * `/ca.key` the key of the server PKI, unencrypted + * `/clients.json` the generated certificates for each client + + There is an [`docker-compose.yml example`](docker-compose.yml.example) you can use as a base for your own docker-compose service. \ No newline at end of file