Skip to content
Logo LogoDocumentation
⌘ K
Logo LogoDocumentation
Logo
All versions

Current Index

  • Contribution Guide
  • Customize 🧩
    • custom.env πŸ—οΈ
    • Common Overrides βš™οΈ
  • Documentation πŸ“
    • Comments πŸ’¬
    • Requirement Keywords (RFC 2119) πŸ“‹
    • Links πŸ”—
    • Semantics and Writing ✍️
    • Headlines 🏷️
    • Documentation Structure πŸ—‚οΈ
      • Role README πŸ“„
      • Docs README πŸ“„
      • Markdown πŸ“‹
      • Sphinx πŸ“š
  • Requirements πŸ“‹
    • File Naming
    • File Structure
    • Cross-linking
    • See Also
  • Contribution Flow πŸ”€
    • Repository Configuration 🧩
    • Step-by-Step Flow πŸͺœ
    • Discussion πŸ’¬

Full Index

  • About
    • Agent Instructions πŸ€–
    • Changelog
    • Code of Conduct
    • Contributing to Infinito.Nexus
    • Infinito.Nexus Community License (Non-Commercial)
    • Security Policy
    • Support and Contact πŸ’Ό
    • Todos
    • Compose Configuration 🧩
      • CoreDNS Sidecar Config πŸ›°οΈ
      • Package-Cache Wiring πŸ“¦
      • Package-Cache Frontend (TLS-terminating reverse proxy) πŸ”
      • Registry-Cache Wiring πŸͺž
    • Documentation πŸ“
      • Administration πŸ› οΈ
        • CI & Self-Hosted Runners πŸƒ
        • Deploy Guide πŸš€
        • Installation Guide πŸš€
        • Configuration πŸ› οΈ
          • Email Configuration πŸ“¬
          • RBAC πŸ›‚
      • Agent documentation πŸ€–
        • Agent action guides 🧭
          • Committing
          • Development
          • Pull Requests
          • Push, Trigger, Pull
          • Refactoring and Optimization
          • Release Articles
          • Requirements
          • Testing
          • Debugging
            • CI Debugging
            • Local Deploy Debugging
            • Log File Inspection
          • Agent iteration loops
            • Compose Loop
            • Playwright Spec Loop
            • Roundtrip Loop
            • Runner Iteration
            • Swarm Loop
            • Workflow Loop
        • Agent file rules πŸ“
          • Agent group_vars rules
            • applications lookup
          • Agent role file rules 🎭
            • javascript.js
            • playwright.env.j2
            • playwright.spec.js agent procedure
            • `style.css`
        • Agent meta guidance 🧠
          • About AGENTS.md
          • Caveman: Token Compression
          • Ethics and Morality
          • Help
          • Purpose
      • Changelog Archive πŸ“š
        • 0.1.0 (2025-12-09)
        • 0.1.1 (2025-12-10)
        • 0.2.0 (2025-12-10)
        • 0.2.1 (2025-12-10)
        • 0.3.0 (2025-12-17)
        • 0.3.1 (2025-12-18)
        • 0.3.2 (2025-12-19)
        • 0.3.3 (2025-12-21)
        • 0.3.4 (2025-12-21)
        • 0.3.5 (2025-12-21)
        • 0.4.0 (2025-12-29)
        • 0.5.0 (2025-12-30)
        • 0.6.0 (2025-12-31)
        • 0.7.0 (2026-01-05)
        • 0.7.1 (2026-01-06)
        • 0.7.2 (2026-01-06)
        • 0.8.0 (2026-01-06)
        • 0.9.0 (2026-01-07)
        • 0.10.0 (2026-01-08)
        • 0.11.0 (2026-01-10)
        • 0.12.0 (2026-01-25)
        • 1.0.0 (2026-02-03)
        • 2.0.0 (2026-02-08)
        • 2.1.0 (2026-02-08)
        • 2.1.1 (2026-02-08)
        • 2.1.2 (2026-02-08)
        • 2.1.3 (2026-02-08)
        • 2.1.4 (2026-02-08)
        • 2.1.5 (2026-02-09)
        • 2.1.6 (2026-02-09)
        • 2.1.7 (2026-02-09)
        • 2.1.8 (2026-02-09)
        • 2.1.9 (2026-02-10)
        • 3.0.0 (2026-02-11)
        • 4.0.0 (2026-02-13)
        • 4.0.1 (2026-02-15)
        • 4.0.2 (2026-02-15)
        • 4.0.3 (2026-02-16)
        • 4.1.0 (2026-02-17)
        • 5.0.0 (2026-02-25)
        • 5.1.0 (2026-02-28)
        • 5.2.0 (2026-03-21)
        • 6.0.0 (2026-04-25)
        • 7.0.0 (2026-05-08)
        • 8.0.0 (2026-05-27)
        • 8.0.1 (2026-05-28)
        • 8.0.2 (2026-05-28)
        • 8.0.3 (2026-05-28)
        • 8.0.4 (2026-05-28)
      • Contribution Guide
        • Customize 🧩
        • Documentation πŸ“
        • Requirements πŸ“‹
        • Contribution Flow πŸ”€
        • Actions πŸš€
          • Local Deploy πŸš€
          • Refactoring πŸ”§
          • Release πŸš€
          • Review Requirements πŸ”
          • Testing and Validation βœ…
          • Debugging guides 🐞
            • CI Failures and Debugging πŸ›
            • Network 🌐
          • Test guidance πŸ§ͺ
            • External Tests 🌐
            • Integration Tests πŸ”—
            • Lint πŸ”
            • Playwright Tests 🎭
            • Regression Guards πŸ›‘οΈ
            • Suppression Markers 🚫
            • Unit Tests πŸ§ͺ
        • Artefact documentation 🧱
          • Scripts 🧰
          • Utilities 🐍
          • File artefact rules πŸ“„
            • `compose.yml` 🐳
            • `Makefile` πŸ› οΈ
            • Docs README rules πŸ—‚οΈ
              • Docs README πŸ“„
            • Plugin file rules πŸ”Œ
              • Lookup plugin rules πŸ”Ž
                • `applications` lookup πŸ“¦
                • `users` lookup πŸ‘₯
            • Role file rules πŸ› οΈ
              • `Dockerfile` 🐳
              • `javascript.js` πŸ“œ
              • `playwright.spec.js` 🎭
              • Role README πŸ“„
              • `style.css` 🎨
              • `meta/variants.yml` 🧬
          • Git artefacts πŸ—‚οΈ
            • Branch 🌿
            • Commit πŸ“
            • Continuous Integration πŸ”„
            • Pull Request πŸ”€
            • Remotes 🌐
          • Image artefact guidance πŸ–ΌοΈ
            • Image Mirroring πŸͺž
            • Role Image Configuration 🐳
        • Design 🎨
          • Repository Architecture πŸ—οΈ
          • Deployment Modes 🚒
          • Deployment Exceptions ⚠️
          • Inventory πŸ—οΈ
          • Code Principles πŸ“
          • Variants 🧬
          • Identity and Access Management πŸ”
            • Common 🧭
            • LDAP πŸ“’
            • OIDC πŸͺͺ
            • RBAC πŸ›‚
          • Language-specific code rules πŸ—£οΈ
            • Shell 🐚
        • Environment guide πŸ–₯️
          • Local Caches πŸ“¦
          • Manage Low-Hardware Resources
          • Supported Operation Systems
          • Development Environment Setup πŸ› οΈ
          • Environment Variables
          • Platform setup guides 🌍
            • Linux
            • macOS
            • Windows (WSL2)
        • Organisation πŸ›οΈ
          • Communication πŸ’¬
          • Organisational Principles πŸ“
        • Tooling guides 🧰
          • Act Workflow Checks 🎭
          • Ansible 🎭
          • Docker and Runtime Commands 🐳
          • Makefile Commands πŸ› οΈ
          • Agent Tooling πŸ€–
            • Cheatsheet πŸ“‹
            • Agent Guidelines for humans
            • Claude Code πŸ€–
              • Claude Code Sandbox πŸ–οΈ
              • Claude Code Security Assumptions πŸ›‘οΈ
              • Claude Code Settings πŸ€–
          • GHCR guides πŸ“¦
            • GHCR Authentication πŸ”‘
            • Mirror Cleanup: Deleting Private GHCR Packages πŸ—‘οΈ
          • GitHub governance guides πŸ›‘οΈ
            • Repository Settings πŸ”§
            • GitHub Actions guides 🎬
              • CI Configuration βš™οΈ
              • Instructions replay πŸ“–
              • CI Secrets πŸ”
              • GitHub Actions 🎬
            • Branch Governance 🌿
              • Branch Protection πŸ”’
      • Requirements πŸ“‹
        • 000 - Template
        • 014 - Dedicated CI Runner via `svc-runner` Role
        • 017 - Playwright `biber` non-admin RBAC coverage
        • 018 - Playwright LDAP authentication coverage
        • 023 - Docker Swarm Deployment with NFS-backed Shared Volumes
        • 023 - Setup Penpot
        • 024 - ERPNext Role with OIDC SSO
        • 025 - MCP Role Integration
        • 025 - Matrix Role Ansible Flavor (matrix-docker-ansible-deploy)
        • 026 - Unified Addon Syntax
        • 027 - Integration Matrix
        • 028 - atmo.rsvp (AT Protocol Events) Role + Mobilizon/ActivityPub Bridge
        • 028 - Semaphore UI Role with OIDC SSO + LDAP
        • 029 - Checkmk Role with oauth2-proxy SSO + LDAP
        • 030 - Jellyfin Role with LDAP / OIDC SSO
        • 031 - LLM Gateway and Model Backends (LiteLLM)
        • 031 - svc-net-tor: Full Tor Onion Node
        • 032 - Kernel-Isolated AI Agent Employees with Flowise Supervisor
        • 032 - OpenBao Secrets Manager with Keycloak OIDC, RBAC Policies and Static-Seal Auto-Unseal
        • 033 - Home Assistant Role with MCP Server Surface
        • 034 - Embodied Robot Platform for Hermes (svc-ai-robot)
        • 035 - MCP Proxy Expansion and Application Interconnection
        • 036 - Native AI Gateway Integration
        • 037 - World Monitor Role behind the oauth2-proxy SSO Gate
        • 039 - svc-net-wireguard: Test Full Meshes on the Role's Own CI Row
      • Security guidance πŸ”’
        • Security Guidelines πŸ›‘οΈ
        • Security Guidelines πŸ›‘οΈ
    • Custom Modules (`library/`)
    • Packaging Layout
    • Ansible Plugins (`plugins/`) 🧩
      • Custom Filter Plugins for Infinito.Nexus
      • Custom Lookup Plugins for Infinito.Nexus
    • Ansible Collection Requirements
    • Application Categories
      • Ansible Role Glossary
      • Application Glosar
      • Blue-ray Disc
      • Chromium
      • CopyQ
      • Workstation Docker
      • Dotlinker
      • Firefox
      • Git
      • GNOME Desktop
      • GNOME Caffeine
      • GNOME Extensions Manager
      • GNOME Terminal
      • GnuCash
      • Jrnl
      • KeePassXC
      • LibreOffice
      • micro
      • Neovim
      • Nextcloud Client ️
        • Todos
      • OBS Studio
      • QBittorrent
      • RetroArch
      • Spotify
      • SSH Agent
      • Torbrowser
      • Virtual Box
      • Zoom
      • Arduino Development Utilities
      • Base Development Toolchain
      • Development Utilities
      • Fakeroot
      • GCC
      • Git
      • Java
      • Locales
      • Make Installation
      • dev-nix
        • to-dos
      • Node.js
      • npm
        • Todos
      • Python Development Utilities
      • Shell
      • Epson Multiprinter Driver
      • Intel Driver
      • LID Switch Driver
      • Proprietary Drivers
      • Hunspell
      • Kevins Package Manager
      • Package Manager Installation
        • Todos
      • LiteLLM Gateway
      • LM Studio
      • MCP Adapter
      • Ollama
      • Robot Platform
        • TODO
      • Backup to External Device
      • Backup NFS
      • Backup Remote Server
      • Backup Host Secrets
      • Backup Docker Volumes
        • Todos
      • Elasticsearch
        • Administration
      • MariaDB
        • Administration
        • defaults/
        • vars/
      • Memcached
      • OpenLDAP
        • Todos
      • PostgreSQL
        • Administration
        • Todos
        • PostgreSQL Docker Upgrade: Major Version Migration
      • Qdrant
        • Administration
        • Todos
        • Qdrant Docker Upgrade
      • RabbitMQ
      • Redis
        • Administration
      • Typesense
      • Unbound
      • Firewall ruleset
      • Tor Onion Service
      • Tor SMTP Gateway (svc-net-tor-smtp)
      • WireGuard
      • MSI Keyboard Driver
        • Todo
      • Storage Optimizer
        • Todos
      • Swapfile
      • OpenResty
      • Docker Registry Cache
      • Docker Registry
      • Self-Hosted Runner
      • NFS Client
      • NFS Server
        • TODO
      • Docker Swarm Manager
      • Docker Swarm
      • Kata & gVisor
      • sys-ca-selfsigned
      • sys-cleanup
      • Infinito.Nexus CLI
      • Unified Service Failure Notifier
      • Automated Email Alerts for Service Failures
      • Automated Telegram Alerts for Service Failures
      • Cleanup Docker Anonymous Volumes
      • Cleanup Backups Service
      • Certbot Reaper
      • Cleanup Disc Space
      • Cleanup Docker Resources
      • Cleanup Failed Backups
      • sys-ctl-hlth-btrfs
      • Docker Container Health Check
      • Health CSP Crawler
      • sys-ctl-hlth-disc-space
      • sys-ctl-hlth-journalctl
      • sys-ctl-hlth-msmtp
      • Container Runtime Health Check
        • To-dos
      • Docker Volumes Health Check
      • Webserver Health Check
        • Todo
      • Docker Compose Certificate Sync Service
        • Wildcard Certificate Setup with Let's Encrypt
      • NGINX Certbot Automation
      • System Btrfs Auto Balancer
      • Docker Auto Restart
      • Docker Healer
      • sys-daemon
      • Cloudflare DNS Records
      • Hetzner Reverse DNS
      • sys-dns-wildcards
      • NGINX Global Matomo & Theming Modifier Role
      • Global CSS Injection for NGINX
      • iFrame Notifier for NGINX
      • Global JavaScript Injector for NGINX
      • sys-front-inj-logout
      • NGINX Matomo Tracking Role
      • sys-front-tls
      • sys-front-tls-letsencrypt
      • sys-front-tls-selfsigned
      • Hostname
      • Lint
      • System Maintenance Lock
      • sys-openssl
      • Operating System Images
      • Python-Pip
      • sys-pip-install
      • sys-service
      • sys-service-loader
        • TODOs
      • sys-service-terminator
      • Database Docker Composition
      • Front Base (HTTPS + Cloudflare + Handlers)
      • NGINX Domain Setup
      • Database Docker with Web Proxy
      • Sudo
      • Content Delivery Network
      • Certbot
      • NGINX HTTPS Certificate Retrieval
      • sys-svc-cln-domains
      • Docker Compose
        • Todos
      • sys-svc-compose-ca
      • sys-svc-compose-php
      • Docker Server
        • sys-svc-container – Files Overview
      • sys-svc-dns
      • Svc Engine
      • Journalctl
      • sys-svc-mail
      • msmtp
      • sys-svc-mail-smtp
      • sys-svc-mcp-reconcile
      • NSS
      • Svc Objstore
      • NGINX Docker Reverse Proxy
        • Todos
      • Central Database
      • SSH Service (Client)
      • sshd
      • Webserver
        • To-dos
      • Webserver HTTPS Provisioning
      • Systemd Timer
      • sys-token-store
      • System Utility: Git Pull (Shallow & Pinned)
      • System Version ️
      • Test E2E Cli
      • Test: E2E Playwright Runner
        • Agent Instructions: test-e2e-playwright
      • Package update
      • User
      • Administrator User
      • User for Backup Provider
      • Root User
      • Workstation User
      • Akaunting
        • Administration
        • To-dos
      • Baserow
      • BigBlueButton
        • Todo
      • Bluesky
        • Administration
        • Installation
        • To-dos
      • BookWyrm
        • Todos
      • Bridgy Fed
      • Checkmk
      • Chess
      • Confluence
      • Dashboard
      • Decidim
      • Discourse
        • Todo
      • ERPNext
      • EspoCRM
      • Fediwall
        • Todos
      • Fider
      • Flowise
      • Friendica
        • TODOs
      • Funkwhale
      • FusionDirectory
        • To-dos
      • Gitea
      • GitLab
      • Hermes Agent
        • TODO
      • Home Assistant
      • Hugo
        • Hugo: Administration
      • Jellyfin
      • Jenkins
      • Jira
      • Jitsi Meet
      • Joomla
      • Keycloak
        • Todos
      • KIX
      • LAM
      • Listmonk
        • Installation and Configuration
        • To-dos
        • Upgrade
      • LiteLLM Admin UI
        • TODO
      • LittleJS
      • Magento
        • To-dos
      • Mailu
        • Todos
      • Mastodon
      • Matomo
      • Matrix
        • Todo
      • Mattermost
      • MediaWiki
      • MIG
        • Todos
      • Mini-QR
        • To-dos
      • MinIO
      • Mobilizon
        • TODO
      • Moodle
      • n8n
      • Presentation
      • Nextcloud
        • Nextcloud Docs
          • Administration
          • Nextcloud Applications
          • Database Management (local)
          • Identity and Access Management
          • Add LDAP Users Manually for Immediate Sharing
          • OCC (Nextcloud Command Line) πŸ”§
          • User Administration
        • Variables
      • Odoo ERP
        • TODO
      • OpenBao
      • OpenClaw
        • TODO
      • OpenCloud
        • web-app-opencloud TODO πŸ“
      • OpenProject
        • Todo
      • OpenTalk
        • web-app-opentalk TODO πŸ“
      • Open WebUI
      • PeerTube
        • Setup Peertube
        • Todos
        • upgrade version
      • Penpot
      • pgAdmin
      • phpldapadmin
        • Todo
      • PhpMyAdmin
      • web-app-pihole
      • Pixelfed
        • Pixelfed Administration
      • Postmarks
        • Todo
      • Pretix
      • Prometheus
      • Roulette Wheel
      • SeaweedFS
        • TODO
      • Semaphore UI
      • Shopware
      • Snipe‑IT
      • Social Home
        • Todo
      • Sphinx
      • Stalwart Mail Server
      • SuiteCRM
      • Taiga
      • Wazuh
      • WordPress
        • Administration
      • XWiki
      • YOURLS
        • Administration
      • Zammad
      • Redirector
      • World Wide Web
        • To-dos
      • Assets Server
      • Content Delivery Network
      • Collabora
      • Coturn
      • Corporate Design
      • File Server
      • HTML Server
      • Imprint
      • LibreTranslate
      • Universal Logout
        • Todos
      • Asset Mirror (Privacy Proxy)
      • OnlyOffice
      • Simple Icons
      • XMPP
    • Script Collection
      • Container Scripts
        • Container Purge πŸ—‘οΈ
          • Entity Purge πŸ—‘οΈ
      • Docker Runner Scripts 🐳
      • Git Workflow Helpers πŸ”
      • GitHub Workflow Helpers πŸ”§
        • Run Cancellation 🚫
        • Repository Cleanup 🧹
        • Release Gates πŸ›‘οΈ
        • Workflow Input Resolution πŸ”Ž
        • Runner Hygiene 🧹
        • Update Pipeline πŸ”„
      • Image Scripts
      • Install Scripts
      • Lint Scripts
      • System Scripts
        • AppArmor Administration πŸ›‘οΈ
        • Network Administration
          • DNS Helpers
            • DNS Setup Scripts 🌐
          • Docker Network Helpers
          • IPv6 Helpers
        • System Purge
        • systemd Administration Scripts βš™οΈ
          • systemd. Enable βœ…
        • TLS Administration Scripts πŸ”’
          • CA Trust Scripts πŸ”
      • Test Utilities πŸ§ͺ
        • Workspace Test Suite
    • Cross-role tasks
    • Templates
    • Tests πŸ§ͺ
      • End-to-End Tests 🎭
      • External Tests 🌐
      • Integration Tests πŸ”—
        • Ansible Integration Tests 🧩
          • Action Plugin Tests 🧩
          • Filter Plugin Tests πŸ”
          • Group Vars Tests πŸ“¦
          • Handler Tests πŸ›ŽοΈ
          • Inventory Tests πŸ“’
          • Jinja Template Tests πŸ§ͺ
          • Lookup Plugin Tests πŸ”Ž
            • `lookup('config', …)` Path Validation πŸ”Ž
          • Playbook Tests 🎬
          • Vars & Defaults Tests πŸ“
        • Identity & Access Integration Tests πŸ”
          • Password Handling Tests πŸ”‘
          • SSO Tests πŸ”
            • RBAC Group-Path Tests πŸ›‘οΈ
        • Infrastructure Integration Tests πŸ—οΈ
          • Backup Tests πŸ’Ύ
          • Compose Tests 🧱
          • Docker Tests 🐳
          • Network Tests πŸ•ΈοΈ
          • Service Registry Tests πŸ›°οΈ
        • Meta-Layout Integration Tests πŸ—‚οΈ
          • Category Tests πŸ—‚οΈ
          • CLI Tests πŸ–₯️
          • Domain Tests 🌐
          • GitHub Workflow Tests βš™οΈ
        • Role Structure Tests πŸ“š
          • Application Role Tests πŸ“¦
            • Application ID Tests πŸ†”
          • Dashboard Integration Scope Tests πŸŽ›οΈ
          • Include/Import Existence Tests πŸ“Ž
          • Role `meta/main.yml` Tests 🧾
            • Role Dependency Tests πŸ”—
            • `server` Block Tests πŸ›‘οΈ
            • Role `meta/services.yml` Tests πŸ›ŽοΈ
              • Prometheus Service Tests πŸ“ˆ
              • Repository Declaration Tests πŸ“¦
              • `run_after` Dependency Tests ⏭️
            • Role `meta/variants.yml` Tests πŸ”€
          • Role Naming Tests 🏷️
          • Playwright Parity Tests 🎭
          • Run-Once Flag Tests 🏁
          • When-Guard Tests 🚦
      • Lint Tests πŸ”
      • Regression Guards πŸ›‘οΈ
      • Unit Tests πŸ§ͺ
    • Shared Utilities (`utils/`)
      • Cache Helpers πŸ’Ύ
      • Cleanup Utilities 🧹
      • Diagnostics: recursive container rescue snapshot
      • Domain Helpers 🌐
      • utils/env πŸ“
        • utils/env/handlers 🧩
      • utils/install
        • utils/install/lint
      • Role Utilities 🧩
        • Application Utilities (`utils/roles/applications/`) 🧩
          • Application Service Helpers 🧩
        • Role Validation Helpers βœ…
      • Templating Utilities 🧩

Documentation
/
Contribution Guide

Contribution GuideΒΆ

Main Categories

  • Contribution Flow πŸ”€
  • Development Environment Setup πŸ› οΈ
  • Code Principles πŸ“

Β© 2025, Kevin Veen-BirkenbachΒ Built with Sphinx 9.2.0