Skip to content

Commit

Permalink
Merge pull request #9 from siva-chegondi/doc-added
Browse files Browse the repository at this point in the history
docs updated
  • Loading branch information
siva-chegondi committed Jun 1, 2019
2 parents cdc9dac + 25b6bac commit d932635
Showing 1 changed file with 17 additions and 2 deletions.
19 changes: 17 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.
Expand All @@ -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

0 comments on commit d932635

Please sign in to comment.