r/lego-nginx: Configure LEGO for nginx

The *lego-nginx* role automates obtaining certificates for *nginx* via
ACME using `lego`.  It generates a shell script with the appropriate
arguments for `lego run`, runs it once to obtain a certificate
initially, then schedules it to run periodically via a systemd timer
unit. Using `lego`'s "hook" capability, the script signals the `nginx`
server process to reload.  This uses `doas` for now, but could be
adapted easily to use `sudo`, if the need ever arises.
unifi-restore
Dustin 2025-07-08 11:29:36 -05:00
parent 0393f074a4
commit 6d1442faf0
11 changed files with 194 additions and 0 deletions

View File

@ -0,0 +1,3 @@
location ^~ /.well-known/acme-challenge {
root /var/www/lego;
}

View File

@ -0,0 +1,4 @@
- name: reload nginx
service:
name: nginx
state: reloaded

View File

@ -0,0 +1,4 @@
dependencies:
- role: lego
tags:
- lego

View File

@ -0,0 +1,50 @@
# vim: set ft=yaml.jinja :
- name: ensure lego webroot exists
file:
path: /var/www/lego
owner: lego
group: lego
mode: u=rwx,go=rx
setype: httpd_sys_content_t
state: directory
tags:
- webroot
- name: ensure lego is allowed to reload nginx
lineinfile:
dest: /etc/doas.conf
line: permit nopass lego cmd /usr/sbin/nginx args -s reload
tags:
- doas
- name: ensure lego renew script exists
copy:
content: >+
lego
--path /var/lib/lego
--accept-tos
{% if lego_acme_server %}
--server {{ lego_acme_server }}
{% endif %}
--http --http.webroot /var/www/lego
{% for domain in lego_domains %}
--domains {{ domain }}
{% endfor %}
--email {{ lego_acme_email }}
run
--run-hook 'doas /usr/sbin/nginx -s reload'
dest: /var/lib/lego/renew.sh
owner: lego
group: lego
mode: u=rwx,go=rx
tags:
- lego-renew
- name: ensure server certificate exists
become: true
become_user: lego
command: /bin/sh /var/lib/lego/renew.sh
args:
creates: /var/lib/lego/certificates/{{ lego_domains[0] }}.json
tags:
- cert

View File

@ -0,0 +1,8 @@
- import_tasks: nginx.yml
tags:
- nginx
- lego-nginx
- import_tasks: cert.yml
tags:
- lego-nginx

View File

@ -0,0 +1,37 @@
- name: ensure nginx is installed
package:
name: nginx
state: present
tags:
- install
- name: ensure nginx is running
service:
name: nginx
state: started
tags:
- service
- name: ensure nginx is configured for lego
copy:
src: lego.nginx.conf
dest: /etc/nginx/default.d/lego.conf
owner: root
group: root
mode: u=rw,go=r
notify:
- reload nginx
tags:
- nginx-config
- name: ensure firewall allows http acme challenges
firewalld:
service: http
state: enabled
immediate: true
when: host_uses_firewalld|d(true)
tags:
- firewalld
- name: flush handlers
meta: flush_handlers

View File

@ -0,0 +1,10 @@
[Unit]
Description=Renew certificates with LEGO
Wants=network-online.target
After=network-online.target
After=httpd.service nginx.service
[Service]
Type=oneshot
User=lego
ExecStart=/bin/sh /var/lib/lego/renew.sh

View File

@ -0,0 +1,9 @@
[Unit]
Description=Periodically renew certificates with LEGO
[Timer]
RandomizedDelaySec=15m
OnActiveSec=4h
[Install]
WantedBy=timers.target

2
roles/lego/meta/main.yml Normal file
View File

@ -0,0 +1,2 @@
dependencies:
- systemd-base

66
roles/lego/tasks/main.yml Normal file
View File

@ -0,0 +1,66 @@
- name: load os-specific values
include_vars: '{{ item }}'
with_first_found:
- '{{ ansible_distribution }}-{{ ansible_distribution_version }}.yml'
- '{{ ansible_distribution }}-{{ ansible_distribution_major_version }}.yml'
- '{{ ansible_os_family }}-{{ ansible_distribution_major_version }}.yml'
- '{{ ansible_distribution }}.yml'
- '{{ ansible_os_family }}.yml'
- defaults.yml
tags:
- always
- name: ensure lego is installed
package:
name:
- acl # required for `become_user: lego`
- '{{ lego_package }}'
state: present
tags:
- install
- name: ensure lego group exists
group:
name: lego
system: true
tags:
- user
- group
- name: ensure lego user exists
user:
name: lego
group: lego
system: true
home: /var/lib/lego
createhome: true
shell: /bin/false
tags:
- user
- name: ensure lego-renew systemd units are installed
copy:
src: '{{ item }}'
dest: /etc/systemd/system/
owner: root
group: root
mode: u=rw,go=r
loop:
- lego-renew.service
- lego-renew.timer
notify:
- reload systemd
tags:
- systemd
- name: ensure lego-renew systemd timer is enabled
systemd:
name: lego-renew.timer
enabled: true
tags:
- service
- name: ensure lego-renew systemd timer is running
systemd:
name: lego-renew.timer
state: started
tags:
- service

View File

@ -0,0 +1 @@
lego_package: golang-github-acme-lego