Readme extended

This commit is contained in:
Snowyo 2018-08-05 01:22:53 +02:00
parent 1943a2d6d5
commit f9cb61f645

View File

@ -5,21 +5,40 @@ Forked from [DanielHuisman/traefik-certificate-extractor](https://github.com/Dan
Tool to extract Let's Encrypt certificates from Traefik's ACME storage file. Can automatically restart containers using the docker API. Tool to extract Let's Encrypt certificates from Traefik's ACME storage file. Can automatically restart containers using the docker API.
## Installation ## Installation
``` ```shell
git clone https://github.com/snowmb/traefik-certificate-extractor git clone https://github.com/snowmb/traefik-certificate-extractor
cd traefik-certificate-extractor cd traefik-certificate-extractor
``` ```
## Usage ## Usage
``` ```shell
python3 extractor.py [FILE] usage: extractor.py [-h] [-c CERTIFICATE] [-d DIRECTORY] [-f] [-r] [--dry-run]
[--include [INCLUDE [INCLUDE ...]] | --exclude
[EXCLUDE [EXCLUDE ...]]]
Extract traefik letsencrypt certificates.
optional arguments:
-h, --help show this help message and exit
-c CERTIFICATE, --certificate CERTIFICATE
file that contains the traefik certificates (default
acme.json)
-d DIRECTORY, --directory DIRECTORY
output folder
-f, --flat outputs all certificates into one folder
-r, --restart_container
uses the docker API to restart containers that are
labeled accordingly
--dry-run Don't write files and do not start docker containers.
--include [INCLUDE [INCLUDE ...]]
--exclude [EXCLUDE [EXCLUDE ...]]
``` ```
Default file is `./data/acme.json`. The output directories are `./certs` and `./certs_flat`. Default file is `./data/acme.json`. The output directories are `./certs` and `./certs_flat`.
## Docker ## Docker
There is a Docker image available for this tool: [snowmb/traefik-certificate-extractor](https://hub.docker.com/r/snowmb/traefik-certificate-extractor/). There is a Docker image available for this tool: [snowmb/traefik-certificate-extractor](https://hub.docker.com/r/snowmb/traefik-certificate-extractor/).
Example run: Example run:
``` ```shell
docker run --name extractor -d \ docker run --name extractor -d \
-v /opt/traefik:/app/data \ -v /opt/traefik:/app/data \
-v ./certs:/app/certs \ -v ./certs:/app/certs \