# xoxys.lego

[![Build Status](https://ci.rknet.org/api/badges/ansible/xoxys.lego/status.svg)](https://ci.rknet.org/repos/ansible/xoxys.lego)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg?label=license)](https://gitea.rknet.org/ansible/xoxys.lego/src/branch/main/LICENSE)

Deploy Lego ACME client to manage Lets Encrypt certificates.

## Table of content

- [Requirements](#requirements)
- [Default Variables](#default-variables)
  - [lego_acme_account_email](#lego_acme_account_email)
  - [lego_acme_server](#lego_acme_server)
  - [lego_certificates](#lego_certificates)
  - [lego_cloudflare_api_token](#lego_cloudflare_api_token)
  - [lego_dns_resolvers](#lego_dns_resolvers)
  - [lego_key_type](#lego_key_type)
  - [lego_renew_enabled](#lego_renew_enabled)
  - [lego_renew_interval](#lego_renew_interval)
  - [lego_renew_randomized_delay](#lego_renew_randomized_delay)
  - [lego_version](#lego_version)
- [Dependencies](#dependencies)
- [License](#license)
- [Author](#author)

---

## Requirements

- Minimum Ansible version: `2.10`

## Default Variables

### lego_acme_account_email

#### Default value

```YAML
lego_acme_account_email: _unset_
```

#### Example usage

```YAML
lego_acme_account_email: user@example.com
```

### lego_acme_server

#### Default value

```YAML
lego_acme_server: https://acme-v02.api.letsencrypt.org
```

### lego_certificates

#### Default value

```YAML
lego_certificates: []
```

#### Example usage

```YAML
lego_certificates:
  - name: example
    domains:
      - example.com
      - www.example.com
    hook: |
      #!/bin/env bash
```

### lego_cloudflare_api_token

#### Default value

```YAML
lego_cloudflare_api_token: _unset_
```

#### Example usage

```YAML
lego_cloudflare_api_token: _dhTdcj9g9s7gcpbN7qsh9CR3RMVHdM7v
```

### lego_dns_resolvers

#### Default value

```YAML
lego_dns_resolvers: []
```

### lego_key_type

#### Default value

```YAML
lego_key_type: ec256
```

### lego_renew_enabled

#### Default value

```YAML
lego_renew_enabled: true
```

### lego_renew_interval

#### Default value

```YAML
lego_renew_interval: '*-*-* 1:35'
```

### lego_renew_randomized_delay

#### Default value

```YAML
lego_renew_randomized_delay: 1h
```

### lego_version

#### Default value

```YAML
lego_version: 4.18.0
```

## Dependencies

None.

## License

MIT

## Author

[Robert Kaussow](https://gitea.rknet.org/xoxys)