From 25b6bac2c301091f868426363eb62d9e888830e5 Mon Sep 17 00:00:00 2001 From: Siva Chegondi Date: Thu, 30 May 2019 02:41:17 +0530 Subject: [PATCH] docs updated --- README.md | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f165d39..64bf550 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,13 @@ -# Caddyvault +# CaddyVault A TLS clustering plugin for caddyserver to use [Vault](https://vaultproject.io) as storage for storing TLS data like certificates, keys etc., state: **ALPHA** +## Prerequisite +This plugin expects the following environment. +* You need a VAULT server running and accessible from the machine/s on which caddy is running. + ## Extending caddy with CaddyVault plugin To extend caddy with CaddyVault plugin, we need to include following `import statement` in github.com/mholt/caddy/caddy/caddymain/run.go file. @@ -17,5 +21,16 @@ import ( ## Docker file Checkout following project for reference to build your own docker file. - [CaddyVault Docker](https://github.com/siva-chegondi/caddyvault-docker) + +## Configuration + +### Vault configuration +* We need to enable KV2 secrets engine on the path `certpaths`. + +### Caddy configuration +* We can enable `CaddyVault` plugin by setting environment variable `CADDY_CLUSTERING` to `vault`. +* Now set the following environment variables. + + * CADDY_CLUSTERING_VAULT_ENDPOINT + * CADDY_CLUSTERING_VAULT_KEY