Skip to content
Snippets Groups Projects
README.md 2.59 KiB
Newer Older
Max Adamo's avatar
Max Adamo committed
# acme-downloader
Max Adamo's avatar
Max Adamo committed

1. [usage](#usage)
1. [compatibility](#compatibility)
1. [build](#build)

Massimiliano Adamo's avatar
Massimiliano Adamo committed
Fetches and stores a given Certificate, Full Chain, CA and Private Key.
Max Adamo's avatar
Max Adamo committed

Massimiliano Adamo's avatar
Massimiliano Adamo committed
It is meant to be used in conjunction within the Geant ACME infrastructure.
Max Adamo's avatar
Max Adamo committed

Max Adamo's avatar
Max Adamo committed
## usage
Max Adamo's avatar
Max Adamo committed

Max Adamo's avatar
Max Adamo committed
you can use the tool as following:
Max Adamo's avatar
Max Adamo committed

Max Adamo's avatar
Max Adamo committed
```bash
Max Adamo's avatar
Max Adamo committed
acme-downloader --vault-token=<VAULT-TOKEN> --redis-token=<REDIS_TOKEN> \
Max Adamo's avatar
Max Adamo committed
    --cert-name=foo-ev-cert.geant.org --team-name=swd
Max Adamo's avatar
Max Adamo committed
```

<span style="text-decoration: underline">If the certificate is being replaced, the tool throws an exit status equal to 64 and you can reload your application in order to use the new certificate.</span>
Massimiliano Adamo's avatar
Massimiliano Adamo committed

You can check all the options using `--help`:
Max Adamo's avatar
Max Adamo committed

```bash
Max Adamo's avatar
Max Adamo committed
ACME Downloader:
  - fetches and stores a given Certificate, Full Chain, CA and Private Key
Max Adamo's avatar
Max Adamo committed

Usage:
Max Adamo's avatar
Max Adamo committed
  acme-downloader --redis-token=REDISTOKEN --vault-token=VAULTTOKEN --cert-name=CERTNAME --team-name=TEAMNAME [--days=DAYS] [--type=TYPE] [--cert-destination=CERTDESTINATION] [--fullchain-destination=FULLCHAINDESTINATION] [--key-destination=KEYDESTINATION] [--ca-destination=CADESTINATION]
  acme-downloader -h | --help
Max Adamo's avatar
Max Adamo committed
  acme-downloader -v | --version
  acme-downloader -b | --build
Max Adamo's avatar
Max Adamo committed

Options:
Max Adamo's avatar
Max Adamo committed
  -h --help                                     Show this screen
  -v --version                                  Print version information and exit
Max Adamo's avatar
Max Adamo committed
  -b --build                                    Print version and build information and exit
  --redis-token=REDISTOKEN                      Redis access token
  --vault-token=VAULTTOKEN                      Vault access token
  --cert-name=CERTNAME                          Certificate name
  --team-name=TEAMNAME                          Team name: swd, dream_team, it, ne, ti...
  --days=DAYS                                   Days before expiration [default: 30]
  --type=TYPE                                   Type, EV or OV [default: EV]
  --cert-destination=CERTDESTINATION            Cert Destination [default: /etc/ssl/certs/<cert-name>.crt]
  --fullchain-destination=FULLCHAINDESTINATION  Full Chain Destination[default: /etc/ssl/certs/<cert-name>_fullchain.crt]
  --key-destination=KEYDESTINATION              Key Destination [default: /etc/ssl/private/<cert-name>.key]
Massimiliano Adamo's avatar
Massimiliano Adamo committed
  --ca-destination=CADESTINATION                CA Destination [default: /etc/ssl/certs/COMODO_<type>.crt]
  --wildcard                                    The certificate type is wildcard
Max Adamo's avatar
Max Adamo committed
```
Max Adamo's avatar
Max Adamo committed

## compatibility

Maybe 43 different platforms but tested on Linux and Windows only.
Max Adamo's avatar
Max Adamo committed

## build

Massimiliano Adamo's avatar
Massimiliano Adamo committed
It compiles on several platforms and architectures.
Massimiliano Adamo's avatar
Massimiliano Adamo committed
Please run the script in this repository to check all available options:
Max Adamo's avatar
Max Adamo committed

```bash
Massimiliano Adamo's avatar
Massimiliano Adamo committed
./build.sh --help
Max Adamo's avatar
Max Adamo committed
```