images/ovpn-certman
8
0
Fork 0
Code Issues Pull requests 1 Releases Wiki Activity

Improve documentation

Browse source
This commit is contained in:
Paul 2018-04-22 19:47:26 +02:00
parent f83b9ae696
commit 83d0ed4cb7
1 changed files with 13 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -13,12 +13,14 @@ linked and have no additional dependencies. Supported plattforms are:
Simply download them from the "artifacts" section of this project. Simply download them from the "artifacts" section of this project.
### Docker ### Docker
A prebuilt docker image (10MB) is available: A prebuilt docker image (10MB) is available:
```bash
```
docker pull docker.klink.asia/paul/certman docker pull docker.klink.asia/paul/certman
``` ```
### From Source-Docker ### From Source-Docker
You can easily build your own docker image from source You can easily build your own docker image from source
```bash
```
docker build -t docker.klink.asia/paul/certman . docker build -t docker.klink.asia/paul/certman .
``` ```
@ -38,3 +40,11 @@ variables:
* `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. * `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_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` * `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.