diff --git a/active/podman_certbot/certbot.md b/active/podman_certbot/certbot.md new file mode 100644 index 0000000..17a42ab --- /dev/null +++ b/active/podman_certbot/certbot.md @@ -0,0 +1,173 @@ +# Podman certbot + +- [Podman certbot](#podman-certbot) + - [Setup certbot Project](#setup-certbot-project) + - [Install certbot](#install-certbot) + - [Create the certbot user](#create-the-certbot-user) + - [Write the certbot compose spec](#write-the-certbot-compose-spec) + - [A Note on Volumes](#a-note-on-volumes) + - [Convert certbot compose spec to quadlets](#convert-certbot-compose-spec-to-quadlets) + - [Create any container-mounted directories](#create-any-container-mounted-directories) + - [Start and enable your systemd quadlet](#start-and-enable-your-systemd-quadlet) + - [Expose certbot](#expose-certbot) + - [firewalld](#firewalld) + - [Backup certbot](#backup-certbot) + - [Upgrade certbot](#upgrade-certbot) + - [Upgrade Quadlets](#upgrade-quadlets) + - [Uninstall](#uninstall) + - [Notes](#notes) + - [SELinux](#selinux) + +## Setup certbot Project + +- [ ] Copy and rename this folder to active/podman_certbot +- [ ] Find and replace certbot with the name of the service. +- [ ] Create the rootless user to run the podman containers +- [ ] Write the compose.yaml spec for your service +- [ ] Convert the compose.yaml spec to a quadlet +- [ ] Install the quadlet on the podman server +- [ ] Expose the quadlet service +- [ ] Install a backup service and timer + +## Install certbot + +### Create the certbot user + +```bash +# SSH into your podman server as root +useradd certbot +loginctl enable-linger $(id -u certbot) +systemctl --user --machine=certbot@.host enable podman-restart +systemctl --user --machine=certbot@.host enable --now podman.socket +mkdir -p /home/certbot/.config/containers/systemd +``` + +### Write the certbot compose spec + +```bash +podman run -it --rm --name certbot \ +-v "/etc/letsencrypt:/etc/letsencrypt:Z" \ +-v "/var/lib/letsencrypt:/var/lib/letsencrypt:Z" \ +certbot/certbot certonly -d keycloak.reeseapps.com -d keycloak.reeselink.com + +``` + +#### A Note on Volumes + +Named volumes are stored at `/home/certbot/.local/share/containers/storage/volumes/`. + +### Convert certbot compose spec to quadlets + +Run the following to convert a compose.yaml into the various `.container` files for systemd: + +```bash +# Generate the systemd service +podman run \ +--security-opt label=disable \ +--rm \ +-v $(pwd)/active/podman_certbot/:/compose \ +-v $(pwd)/active/podman_certbot/quadlets:/quadlets \ +quay.io/k9withabone/podlet \ +-f /quadlets \ +-i \ +--overwrite \ +compose /compose/compose.yaml + +# Copy the files to the server +export PODMAN_SERVER= +scp -r active/podman_certbot/quadlets/. $PODMAN_SERVER:/home/certbot/.config/containers/systemd/ +ssh $PODMAN_SERVER chown -R certbot:certbot /home/certbot/.config/containers/systemd/ +``` + +### Create any container-mounted directories + +SSH into your podman server as root: + +```bash +machinectl shell certbot@ +podman unshare +mkdir some_volume +# Chown to the namespaced user with UID 1000 +# This will be some really obscure UID outside the namespace +# This will also solve most permission denied errors +chown -R 1000:1000 some_volume +``` + +### Start and enable your systemd quadlet + +SSH into your podman server as root: + +```bash +machinectl shell certbot@ +systemctl --user daemon-reload +systemctl --user restart certbot +# Enable auto-update service which will pull new container images automatically every day +systemctl --user enable --now podman-auto-update.timer +``` + +### Expose certbot + +1. If you need a domain, follow the [DDNS instructions](/active/podman_ddns/ddns.md#install-a-new-ddns-service) +2. For a web service, follow the [Caddy instructions](/active/podman_caddy/caddy.md#adding-a-new-caddy-record) +3. Finally, follow your OS's guide for opening ports via its firewall service. + +#### firewalld + +```bash +# command to get current active zone and default zone +firewall-cmd --get-active-zones +firewall-cmd --get-default-zone + +# command to open 443 on tcp +firewall-cmd --permanent --zone= --add-port=443/tcp + +# command to open 80 and 443 on tcp and udp +firewall-cmd --permanent --zone= --add-port={80,443}/{tcp,udp} + +# command to list available services and then open http and https +firewall-cmd --get-services +firewall-cmd --permanent --zone= --add-service={http,https} +``` + +## Backup certbot + +Follow the [Borg Backup instructions](/active/systemd_borg/borg.md#set-up-a-client-for-backup) + +## Upgrade certbot + +### Upgrade Quadlets + +Upgrades should be a repeat of [writing the compose spec](#convert-certbot-compose-spec-to-quadlets) and [installing the quadlets](#start-and-enable-your-systemd-quadlet) + +```bash +export PODMAN_SERVER= +scp -r quadlets/. $PODMAN_SERVER$:/home/certbot/.config/containers/systemd/ +ssh certbot systemctl --user daemon-reload +ssh certbot systemctl --user restart certbot +``` + +## Uninstall + +```bash +# Stop the user's services +systemctl --user disable podman-restart +podman container stop --all +systemctl --user disable --now podman.socket +systemctl --user disable --now podman-auto-update.timer + +# Delete the user (this won't delete their home directory) +# userdel might spit out an error like: +# userdel: user certbot is currently used by process 591255 +# kill those processes and try again +userdel certbot +``` + +## Notes + +### SELinux + + + +:z allows a container to share a mounted volume with all other containers. + +:Z allows a container to reserve a mounted volume and prevents any other container from accessing. diff --git a/active/podman_certbot/quadlets/README.md b/active/podman_certbot/quadlets/README.md new file mode 100644 index 0000000..0ea23f9 --- /dev/null +++ b/active/podman_certbot/quadlets/README.md @@ -0,0 +1,3 @@ +# Quadlets + +Put your quadlets here. diff --git a/active/podman_certbot/quadlets/certbot.service b/active/podman_certbot/quadlets/certbot.service new file mode 100644 index 0000000..8f2a69d --- /dev/null +++ b/active/podman_certbot/quadlets/certbot.service @@ -0,0 +1,10 @@ +[Unit] +Description=Runs certbot renew +After=syslog.target network.target auditd.service +Wants=network-online.target + +[Service] +ExecStart=/usr/bin/command -with -arguments + +[Install] +WantedBy=multi-user.target \ No newline at end of file diff --git a/active/podman_certbot/quadlets/certbot.timer b/active/podman_certbot/quadlets/certbot.timer new file mode 100644 index 0000000..c1ece1b --- /dev/null +++ b/active/podman_certbot/quadlets/certbot.timer @@ -0,0 +1,11 @@ +[Unit] +Description=Daily certbot certificate renewal + +[Timer] +OnCalendar=daily +AccuracySec=12h +Persistent=true +Unit=certbot.service + +[Install] +WantedBy=timers.target