traefik-certs-cleaner

README

traefik-certs-cleaner

If you appreciate this project:

Description

traefik-certs-cleaner is a simple helper to clean the Traefik acme.json file by removing certificates.

It creates a new acme.json file (acme-new.json by default) without the certificates that you want to remove. After the cleaning, you should replace the content of the original acme.json by the content of the new file. Then you have to restart your Traefik instance.

NAME:
   traefik-certs-cleaner - Traefik Certificates Cleaner

USAGE:
   traefik-certs-cleaner [global options] command [command options] [arguments...]

DESCRIPTION:
   Clean ACME certificates from Traefik acme.json file.

COMMANDS:
   help, h  Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --src value, -s value            Path to the acme.json file. (default: "./acme.json") [$SRC]
   --dst value, -o value            Path to the output of the acme.json file. (default: "./acme-new.json") [$DST]
   --resolver-name value, -r value  Name of the resolver. Use * to handle all resolvers. (default: "*") [$RESOLVER_NAME]
   --domain value, -d value         Domains to remove. Use * to remove all certificates. (default: "*") [$DOMAIN]
   --revoke                         Revoke certificates (default: false) [$REVOKE]
   --dry-run                        Dry run mode. (default: true) [$DRY_RUN]
   --help, -h                       show help (default: false)

Installation

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
• Unzip the archive.
• Add traefik-certs-cleaner in your PATH.

From Docker

docker run ldez/traefik-certs-cleaner:<tag_name>

Examples

Dry run (Default)

$ traefik-certs-cleaner --src=./acme.json

The content of the new file is displayed to the console output.

Remove all certificates

Creates a new file ./acme-new.json.

Remove certificates:

$ traefik-certs-cleaner --src=./acme.json --dry-run=false

Remove and revoke certificates:

$ traefik-certs-cleaner --src=./acme.json --revoke --dry-run=false

Remove all certificates for a Specific Resolver

Creates a new file ./acme-new.json.

Remove certificates:

$ traefik-certs-cleaner --src=./acme.json --resolver-name=myresolver --dry-run=false

Remove and revoke certificates:

$ traefik-certs-cleaner --src=./acme.json --resolver-name=myresolver --revoke --dry-run=false

Remove the certificates of a Specific Domain

Creates a new file ./acme-new.json.

Remove certificates:

$ traefik-certs-cleaner --src=./acme.json --domain=example.com --dry-run=false

Remove and revoke certificates:

$ traefik-certs-cleaner --src=./acme.json --domain=example.com --revoke --dry-run=false