ansible-roles-shlink

This role is designed to deploy uptime kuma as a standalone podman container

• https://shlink.io/documentation/install-docker-image/

Task Configuration

Define shlink_url, this will useful in conjunction with a proxy role such as traefik or nginx

Define shlink_path if the container user has a custom homedir such as something under /srv..

There are several other values that should be defined and secured vial ansible vault

• shlink_db_pass
• shlink_mail_pass

ports

26656/TCP for CometBFT P2P, should be public
26657/TCP for CometBFT RPC, should be private
26660/TCP for CometBFT metrics, should be private
26658/TCP for Penumbra ABCI, should be private

9000/TCP for Penumbra metrics, should be private
8080/TCP for Penumbra gRPC, should be private
443/TCP for Penumbra HTTPS, optional, should be public if enabled

- name: Setup proxy and service
  hosts: somehost
  become: true
  roles:
    - role: shlink
      shlink_url: shlink.somehost.somewhere
      shlink_enable_openid_signin: true
      shlink_enable_openid_signup: true
      shlink_mail_outgoing_enable: true
      shlink_mail_outgoing_port: 587
      shlink_mail_outgoing_host: mail.somehost.somewhere
      shlink_mail_outgoing_user: git@somehost.somewhere
      shlink_mail_outgoing_pass: "{{ shlink_mail_pass }}"
      shlink_mail_incoming_enabled: true
      shlink_mail_incoming_tls: true
      shlink_mail_incoming_reply_to: git+%{token}@somehost.somewhere
      shlink_mail_incoming_host: mail.somehost.somewhere
      shlink_mail_incoming_port: 143
      shlink_mail_incoming_user: git@somehost.somewhere
      shlink_mail_incoming_pass: "{{ shlink_mail_pass }}"
    - role: traefik
      traefik_routes:
        - name: shlink
          host: "{{ shlink_url }}"
          srv: "{{ traefik_host_address }}:3001"
    - role: firewalld
      firewalld_add:
        - name: public
          services:
            - http
            - https
          forwards:
            - port: 80
              to: 8080
            - port: 443
              to: 8443

Deployment and Removal

Sometimes you need to manually stop the running containers to get a clean run when re-deploying Services must be stopped as the respecitve user or another means to aquire the correct user scope for systemd

systemctl --user stop container-traefik.service
systemctl --user stop container-shlink.service

Deploy

ansible-playbook -i hosts site.yml --tags=firewalld,traefik,shlink --limit=somehost

Remove

ansible-playbook -i hosts site.yml --tags=firewalld,traefik,shlink --extra-vars "container_state=absent firewall_action=remove" --limit=somehost