Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ldez/traefik-certs-cleaner

A simple helper to clean the Traefik `acme.json` file by removing and revoking certificates.
https://github.com/ldez/traefik-certs-cleaner

acme certificates cleaner traefik

Last synced: about 2 months ago
JSON representation

A simple helper to clean the Traefik `acme.json` file by removing and revoking certificates.

Host: GitHub
URL: https://github.com/ldez/traefik-certs-cleaner
Owner: ldez
License: other
Created: 2022-01-26T15:10:19.000Z (almost 3 years ago)
Default Branch: master
Last Pushed: 2024-01-31T20:01:35.000Z (11 months ago)
Last Synced: 2024-10-03T12:44:32.723Z (2 months ago)
Topics: acme, certificates, cleaner, traefik
Language: Go
Homepage:
Size: 141 KB
Stars: 34
Watchers: 4
Forks: 2
Open Issues: 0
Metadata Files:
- Readme: readme.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

awesome-starred - ldez/traefik-certs-cleaner - A simple helper to clean the Traefik `acme.json` file by removing and revoking certificates. (others)

README

        # traefik-certs-cleaner

[![GitHub release](https://img.shields.io/github/release/ldez/traefik-certs-cleaner.svg)](https://github.com/ldez/traefik-certs-cleaner/releases/latest)

[![Build Status](https://github.com/ldez/traefik-certs-cleaner/workflows/Main/badge.svg?branch=master)](https://github.com/ldez/traefik-certs-cleaner/actions)

[![Docker Image Version (latest semver)](https://img.shields.io/docker/v/ldez/traefik-certs-cleaner)](https://hub.docker.com/r/ldez/traefik-certs-cleaner/)

[![Go Report Card](https://goreportcard.com/badge/github.com/ldez/traefik-certs-cleaner)](https://goreportcard.com/report/github.com/ldez/traefik-certs-cleaner)

If you appreciate this project:

[![Sponsor](https://img.shields.io/badge/Sponsor%20me-%E2%9D%A4%EF%B8%8F-pink)](https://github.com/sponsors/ldez)

## 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](https://github.com/ldez/traefik-certs-cleaner/releases/)

* Unzip the archive.

* Add `traefik-certs-cleaner` in your `PATH`.

### From Docker

```bash

docker run ldez/traefik-certs-cleaner:

```

## Examples

### Dry run (Default)

```console

$ 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:

```console

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

```

Remove and revoke certificates:

```console

$ 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:

```console

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

```

Remove and revoke certificates:

```console

$ 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:

```console

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

```

Remove and revoke certificates:

```console

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

```