154 lines
3.5 KiB
Markdown
154 lines
3.5 KiB
Markdown
# traefik-certs-dumper
|
|
|
|
[](https://github.com/ldez/traefik-certs-dumper/releases/latest)
|
|
[](https://travis-ci.org/ldez/traefik-certs-dumper)
|
|
[](https://hub.docker.com/r/ldez/traefik-certs-dumper/)
|
|
[](https://goreportcard.com/report/github.com/ldez/traefik-certs-dumper)
|
|
|
|
If you appreciate this project:
|
|
|
|
[](https://saythanks.io/to/ldez)
|
|
|
|
## Features
|
|
|
|
- Supported sources:
|
|
- file ("acme.json")
|
|
- KV stores (Consul, Etcd, Zookeeper, Boltdb)
|
|
- Watch changes:
|
|
- from file ("acme.json")
|
|
- from KV stores (Consul, Etcd, Zookeeper)
|
|
- Output formats:
|
|
- use domain as sub-directory (allow custom names and extensions)
|
|
- flat (domain as filename)
|
|
- Hook (only with watch mode and if the data source changes)
|
|
|
|
## Installation
|
|
|
|
### Download / CI Integration
|
|
|
|
```bash
|
|
curl -sfL https://raw.githubusercontent.com/ldez/traefik-certs-dumper/master/godownloader.sh | bash -s -- -b $GOPATH/bin v1.5.0
|
|
```
|
|
|
|
<!--
|
|
To generate the script:
|
|
|
|
```bash
|
|
godownloader --repo=ldez/traefik-certs-dumper -o godownloader.sh
|
|
|
|
# or
|
|
|
|
godownloader --repo=ldez/traefik-certs-dumper > godownloader.sh
|
|
```
|
|
-->
|
|
|
|
### From Binaries
|
|
|
|
You can use pre-compiled binaries:
|
|
|
|
* To get the binary just download the latest release for your OS/Arch from [the releases page](https://github.com/ldez/traefik-certs-dumper/releases/)
|
|
* Unzip the archive.
|
|
* Add `traefik-certs-dumper` in your `PATH`.
|
|
|
|
### From Docker
|
|
|
|
```bash
|
|
docker run ldez/traefik-certs-dumper:<tag_name>
|
|
```
|
|
|
|
## Usage
|
|
|
|
- [traefik-certs-dumper](docs/traefik-certs-dumper.md)
|
|
- [traefik-certs-dumper file](docs/traefik-certs-dumper_file.md)
|
|
- [traefik-certs-dumper kv](docs/traefik-certs-dumper_kv.md)
|
|
|
|
## Examples
|
|
|
|
### Simple Dump
|
|
|
|
```console
|
|
$ traefik-certs-dumper file
|
|
dump
|
|
├──certs
|
|
│ └──my.domain.com.key
|
|
└──private
|
|
├──my.domain.com.crt
|
|
└──letsencrypt.key
|
|
```
|
|
|
|
### Change source and destination
|
|
|
|
```console
|
|
$ traefik-certs-dumper file --source ./acme.json --dest ./dump/test
|
|
test
|
|
├──certs
|
|
│ └──my.domain.com.key
|
|
└──private
|
|
├──my.domain.com.crt
|
|
└──letsencrypt.key
|
|
```
|
|
|
|
### Use domain as sub-directory
|
|
|
|
```console
|
|
$ traefik-certs-dumper file --domain-subdir=true
|
|
dump
|
|
├──my.domain.com
|
|
│ ├──certificate.crt
|
|
│ └──privatekey.key
|
|
└──private
|
|
└──letsencrypt.key
|
|
```
|
|
|
|
#### Change file extension
|
|
|
|
```console
|
|
$ traefik-certs-dumper file --domain-subdir --crt-ext=.pem --key-ext=.pem
|
|
dump
|
|
├──my.domain.com
|
|
│ ├──certificate.pem
|
|
│ └──privatekey.pem
|
|
└──private
|
|
└──letsencrypt.key
|
|
```
|
|
|
|
#### Change file name
|
|
|
|
```console
|
|
$ traefik-certs-dumper file --domain-subdir --crt-name=fullchain --key-name=privkey
|
|
dump
|
|
├──my.domain.com
|
|
│ ├──fullchain.crt
|
|
│ └──privkey.key
|
|
└──private
|
|
└──letsencrypt.key
|
|
```
|
|
|
|
### KV store
|
|
|
|
#### Consul
|
|
|
|
```console
|
|
$ traefik-certs-dumper kv consul --endpoints localhost:8500
|
|
```
|
|
|
|
#### Etcd
|
|
|
|
```console
|
|
$ traefik-certs-dumper kv etcd --endpoints localhost:2379
|
|
```
|
|
|
|
#### Boltdb
|
|
|
|
```console
|
|
$ traefik-certs-dumper kv boltdb --endpoints /the/path/to/mydb.db
|
|
```
|
|
|
|
#### Zookeeper
|
|
|
|
```console
|
|
$ traefik-certs-dumper kv zookeeper --endpoints localhost:2181
|
|
```
|
|
|
|
|