Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/robertdebock/ansible-role-certbot

Install and configure certbot on your system.
https://github.com/robertdebock/ansible-role-certbot

acme ansible certbot letsencrypt molecule playbook security tox

Last synced: about 1 month ago
JSON representation

Install and configure certbot on your system.

Host: GitHub
URL: https://github.com/robertdebock/ansible-role-certbot
Owner: robertdebock
License: apache-2.0
Created: 2020-07-17T08:49:11.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2024-04-26T12:25:20.000Z (8 months ago)
Last Synced: 2024-05-02T02:19:50.787Z (8 months ago)
Topics: acme, ansible, certbot, letsencrypt, molecule, playbook, security, tox
Homepage: https://robertdebock.nl/
Size: 179 KB
Stars: 10
Watchers: 3
Forks: 5
Open Issues: 2
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md

Awesome Lists containing this project

README

        # [Ansible role certbot](#certbot)

Install and configure certbot on your system.

|GitHub|GitLab|Downloads|Version|

|------|------|---------|-------|

|[![github](https://github.com/robertdebock/ansible-role-certbot/workflows/Ansible%20Molecule/badge.svg)](https://github.com/robertdebock/ansible-role-certbot/actions)|[![gitlab](https://gitlab.com/robertdebock-iac/ansible-role-certbot/badges/master/pipeline.svg)](https://gitlab.com/robertdebock-iac/ansible-role-certbot)|[![downloads](https://img.shields.io/ansible/role/d/robertdebock/certbot)](https://galaxy.ansible.com/robertdebock/certbot)|[![Version](https://img.shields.io/github/release/robertdebock/ansible-role-certbot.svg)](https://github.com/robertdebock/ansible-role-certbot/releases/)|

## [Example Playbook](#example-playbook)

This example is taken from [`molecule/default/converge.yml`](https://github.com/robertdebock/ansible-role-certbot/blob/master/molecule/default/converge.yml) and is tested on each push, pull request and release.

```yaml

---

- name: Converge

  hosts: all

  become: true

  gather_facts: true

  roles:

    - role: robertdebock.certbot

      certbot_email: [email protected]

      certbot_domains:

        - meinit.nl

        - robertdebock.nl

      certbot_ci_mode: true

```

The machine needs to be prepared. In CI this is done using [`molecule/default/prepare.yml`](https://github.com/robertdebock/ansible-role-certbot/blob/master/molecule/default/prepare.yml):

```yaml

---

- name: Prepare

  hosts: all

  become: true

  gather_facts: false

  roles:

    - role: robertdebock.bootstrap

    - role: robertdebock.cron

    - role: robertdebock.buildtools

    - role: robertdebock.epel

    - role: robertdebock.python_pip

    - role: robertdebock.openssl

      openssl_items:

        - name: apache-httpd

          common_name: "{{ ansible_fqdn }}"

    - role: robertdebock.selinux

    - role: robertdebock.httpd

```

Also see a [full explanation and example](https://robertdebock.nl/how-to-use-these-roles.html) on how to use these roles.

## [Role Variables](#role-variables)

The default values for the variables are set in [`defaults/main.yml`](https://github.com/robertdebock/ansible-role-certbot/blob/master/defaults/main.yml):

```yaml

---

# defaults file for certbot

# The certbot can configure either "apache", "haproxy", "nginx" or run "standalone".

certbot_system: apache

# You can have multiple domains, as a list to request a certificate for.

certbot_domains:

  - "{{ ansible_fqdn }}"

# An email-addres is required to register.

certbot_email: [email protected]

```

## [Requirements](#requirements)

- pip packages listed in [requirements.txt](https://github.com/robertdebock/ansible-role-certbot/blob/master/requirements.txt).

## [State of used roles](#state-of-used-roles)

The following roles are used to prepare a system. You can prepare your system in another way.

| Requirement | GitHub | GitLab |

|-------------|--------|--------|

|[robertdebock.bootstrap](https://galaxy.ansible.com/robertdebock/bootstrap)|[![Build Status GitHub](https://github.com/robertdebock/ansible-role-bootstrap/workflows/Ansible%20Molecule/badge.svg)](https://github.com/robertdebock/ansible-role-bootstrap/actions)|[![Build Status GitLab](https://gitlab.com/robertdebock-iac/ansible-role-bootstrap/badges/master/pipeline.svg)](https://gitlab.com/robertdebock-iac/ansible-role-bootstrap)|

|[robertdebock.buildtools](https://galaxy.ansible.com/robertdebock/buildtools)|[![Build Status GitHub](https://github.com/robertdebock/ansible-role-buildtools/workflows/Ansible%20Molecule/badge.svg)](https://github.com/robertdebock/ansible-role-buildtools/actions)|[![Build Status GitLab](https://gitlab.com/robertdebock-iac/ansible-role-buildtools/badges/master/pipeline.svg)](https://gitlab.com/robertdebock-iac/ansible-role-buildtools)|

|[robertdebock.cron](https://galaxy.ansible.com/robertdebock/cron)|[![Build Status GitHub](https://github.com/robertdebock/ansible-role-cron/workflows/Ansible%20Molecule/badge.svg)](https://github.com/robertdebock/ansible-role-cron/actions)|[![Build Status GitLab](https://gitlab.com/robertdebock-iac/ansible-role-cron/badges/master/pipeline.svg)](https://gitlab.com/robertdebock-iac/ansible-role-cron)|

|[robertdebock.epel](https://galaxy.ansible.com/robertdebock/epel)|[![Build Status GitHub](https://github.com/robertdebock/ansible-role-epel/workflows/Ansible%20Molecule/badge.svg)](https://github.com/robertdebock/ansible-role-epel/actions)|[![Build Status GitLab](https://gitlab.com/robertdebock-iac/ansible-role-epel/badges/master/pipeline.svg)](https://gitlab.com/robertdebock-iac/ansible-role-epel)|

|[robertdebock.httpd](https://galaxy.ansible.com/robertdebock/httpd)|[![Build Status GitHub](https://github.com/robertdebock/ansible-role-httpd/workflows/Ansible%20Molecule/badge.svg)](https://github.com/robertdebock/ansible-role-httpd/actions)|[![Build Status GitLab](https://gitlab.com/robertdebock-iac/ansible-role-httpd/badges/master/pipeline.svg)](https://gitlab.com/robertdebock-iac/ansible-role-httpd)|

|[robertdebock.openssl](https://galaxy.ansible.com/robertdebock/openssl)|[![Build Status GitHub](https://github.com/robertdebock/ansible-role-openssl/workflows/Ansible%20Molecule/badge.svg)](https://github.com/robertdebock/ansible-role-openssl/actions)|[![Build Status GitLab](https://gitlab.com/robertdebock-iac/ansible-role-openssl/badges/master/pipeline.svg)](https://gitlab.com/robertdebock-iac/ansible-role-openssl)|

|[robertdebock.python_pip](https://galaxy.ansible.com/robertdebock/python_pip)|[![Build Status GitHub](https://github.com/robertdebock/ansible-role-python_pip/workflows/Ansible%20Molecule/badge.svg)](https://github.com/robertdebock/ansible-role-python_pip/actions)|[![Build Status GitLab](https://gitlab.com/robertdebock-iac/ansible-role-python_pip/badges/master/pipeline.svg)](https://gitlab.com/robertdebock-iac/ansible-role-python_pip)|

|[robertdebock.selinux](https://galaxy.ansible.com/robertdebock/selinux)|[![Build Status GitHub](https://github.com/robertdebock/ansible-role-selinux/workflows/Ansible%20Molecule/badge.svg)](https://github.com/robertdebock/ansible-role-selinux/actions)|[![Build Status GitLab](https://gitlab.com/robertdebock-iac/ansible-role-selinux/badges/master/pipeline.svg)](https://gitlab.com/robertdebock-iac/ansible-role-selinux)|

## [Context](#context)

This role is a part of many compatible roles. Have a look at [the documentation of these roles](https://robertdebock.nl/) for further information.

Here is an overview of related roles:

![dependencies](https://raw.githubusercontent.com/robertdebock/ansible-role-certbot/png/requirements.png "Dependencies")

## [Compatibility](#compatibility)

This role has been tested on these [container images](https://hub.docker.com/u/robertdebock):

|container|tags|

|---------|----|

|[EL](https://hub.docker.com/r/robertdebock/enterpriselinux)|9|

|[Debian](https://hub.docker.com/r/robertdebock/debian)|all|

|[Fedora](https://hub.docker.com/r/robertdebock/fedora)|all|

|[Ubuntu](https://hub.docker.com/r/robertdebock/ubuntu)|all|

The minimum version of Ansible required is 2.12, tests have been done to:

- The previous version.

- The current version.

- The development version.

If you find issues, please register them in [GitHub](https://github.com/robertdebock/ansible-role-certbot/issues).

## [License](#license)

[Apache-2.0](https://github.com/robertdebock/ansible-role-certbot/blob/master/LICENSE).

## [Author Information](#author-information)

[robertdebock](https://robertdebock.nl/)

Please consider [sponsoring me](https://github.com/sponsors/robertdebock).