ChristianLempa_Boilerplates/library/compose/authentik/template.yaml

---
kind: compose
schema: "1.2"
metadata:
  name: Authentik
  description: >
    Integrate Authentik Single Sign-On (SSO) for secure and streamlined user authentication.
    Authentik is an open-source identity provider that supports various authentication protocols.
    This configuration enables OAuth-based SSO, allowing users to log in using their Authentik
    credentials, enhancing security and user experience.


    Project: https://goauthentik.io/

    Documentation: https://goauthentik.io/docs/

    GitHub: https://github.com/goauthentik/authentik
  version: 2025.10.1
  author: Christian Lempa
  date: '2025-11-05'
  tags:
    - traefik
    - swarm
    - volume_modes
  next_steps: |
    1. Start Authentik:
       docker compose up -d

    2. Access the web interface:
       {% if traefik_enabled -%}
       - Via Traefik: https://{{ traefik_host }}
       {% if not traefik_enabled and network_mode == 'bridge' %}- Direct access: http://localhost:{{ ports_http }}{% endif %}
       {%- else -%}
       - Open http://localhost:{{ ports_http }} in your browser
       {%- endif %}

    3. Initial setup:
       - Follow the setup wizard to create your admin account
       - Configure authentication flows and providers
       - Set up user directory (LDAP, Active Directory, or local)

    4. Configure your first application:
       - Navigate to Applications → Create
       - Choose authentication provider (OAuth2, SAML, LDAP, etc.)
       - Configure redirect URIs and client credentials
       - Assign users or groups to the application

    5. Important configuration:
       - Secret Key: {{ authentik_secret_key }}
       - Database Password: {{ database_password }}
       - Store these credentials securely!

    6. Security recommendations:
       - Enable two-factor authentication for admin accounts
       - Configure backup flows and recovery tokens
       - Set up email notifications for security events
       - Review and customize authentication policies
       - Regularly backup the database and media files

    For more information, visit: https://goauthentik.io/docs/
spec:
  general:
    vars:
      service_name:
        default: authentik
      container_name:
        default: authentik-server
  database:
    required: true
    vars:
      database_name:
        default: authentik
      database_user:
        default: authentik
  ports:
    vars:
      ports_http:
        description: Host port for HTTP
        type: int
        default: 8000
      ports_https:
        description: Host port for HTTPS
        type: int
        default: 8443
  traefik:
    vars:
      traefik_host:
        default: authentik.home.arpa
  authentik:
    description: Configure Authentik application settings
    required: true
    vars:
      authentik_error_reporting:
        description: Enable error reporting to Authentik developers
        type: bool
        default: false
      authentik_secret_key:
        description: Secret Key
        extra: Used for cookie signing and unique user IDs
        type: str
        sensitive: true
        autogenerated: true