htwkmooc/poseidon
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add TLS documentation

Browse Source
This commit is contained in:
sirkrypt0
2021-05-03 14:54:59 +02:00
committed by Jan-Eric Hellenberg
parent b744d7f16c
commit 50b3836d25
1 changed files with 10 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -59,3 +59,13 @@ If a value is not specified, the value of the subsequent possibility is used.
### Documentation
For the OpenAPI 3.0 definition of the API Poseidon provides, see [`swagger.yaml`](docs/swagger.yaml).
### TLS
We highly encourage the use of TLS in this API to increase the security. To enable TLS, set `server.tls` or the corresponding environment variable to true and specify the `server.certfile` and `server.keyfile` options.
You can create a self-signed certificate to use with this API using the following command.
```shell
$ openssl req -x509 -nodes -newkey rsa:2048 -keyout server.rsa.key -out server.rsa.crt -days 3650
```