From 9de30aea59de44850af4556efc5bc1a3e27a8069 Mon Sep 17 00:00:00 2001 From: Anita Kumar Date: Thu, 4 Oct 2018 17:03:06 +0100 Subject: [PATCH] documentation: document HTTPS flags Updated Documentation to include HTTPS --- Documentation/deployment.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/Documentation/deployment.md b/Documentation/deployment.md index 3a8f274c..5dc4bc1d 100644 --- a/Documentation/deployment.md +++ b/Documentation/deployment.md @@ -320,6 +320,16 @@ $ curl http://matchbox.example.com $ openssl s_client -connect matchbox-rpc.example.com:443 -CAfile ca.crt -cert client.crt -key client.key ``` +# HTTPS - The read-only Matchbox API is also available with HTTPS + +To start matchbox in this mode you will need the following flags set: + +| Name | Type | Description | +|----------------|--------|---------------------------------------------------------------| +| -web-ssl | bool | true/false | +| -web-cert-file | string | Path to the server TLS certificate file | +| -web-key-file | string | Path to the server TLS key file | + ### Operational notes * Secrets: Matchbox **can** be run as a public facing service. However, you **must** follow best practices and avoid writing secret material into machine user-data. Instead, load secret materials from an internal secret store.