mkdocs.yml

site_name: Poweradmin Documentation
site_url: https://docs.poweradmin.org
site_description: Documentation for Poweradmin - PowerDNS Web Administration Tool

repo_url: https://github.com/poweradmin/poweradmin-docs
edit_uri: edit/main/docs/

theme:
  name: readthedocs
  highlightjs: true
  hljs_languages:
    - php
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - search.highlight
  extra:
    - screenshots
  custom_dir: overrides
    
extra_css:
  - css/extra.css

extra:
  announcement: "This documentation covers Poweradmin 4.x. Some sections are still being expanded."

validation:
  links:
    absolute_links: relative_to_docs
    anchors: warn
    unrecognized_links: warn

nav:
  - Home: index.md
  - Getting Started:
      - Overview: getting-started/overview.md
      - Features: getting-started/features.md
      - Quick Evaluation:
          - Docker Demo: getting-started/docker-demo.md
          - Headless / API-First Quickstart: getting-started/headless-quickstart.md
#          - First Steps: getting-started/first-steps.md
#          - Example Configurations: getting-started/examples.md
      - System Requirements: getting-started/requirements.md

  - Installation:
      - Overview: installation/index.md
      - Docker:
          - Docker Installation: installation/docker.md
          - Docker Secrets: installation/docker-secrets.md
          - Reverse Proxy: installation/reverse-proxy.md
      - Operating Systems:
          - Debian: installation/debian.md
          - Ubuntu: installation/ubuntu.md
          - CentOS/RHEL: installation/centos.md
      - Database Setup:
          - MySQL/MariaDB: database/mysql-configuration.md
          - PostgreSQL: database/postgresql-configuration.md
          - SQLite: database/sqlite.md
          - Database Schema: database/schema.md
      - Web Installer Wizard: installation/wizard.md
      - Manual Installation: installation/manual.md
      - Composer: installation/composer.md
      - Remote Setup: installation/remote-setup-guide.md

  - Configuration:
      - Basic Configuration: configuration/basic.md
      - DNS Settings: configuration/dns-settings.md
      - DNS Wizards: configuration/dns-wizards.md
      - Database Configuration: configuration/database.md
      - PowerDNS API: configuration/powerdns-api.md
      - DNSSEC: configuration/dnssec.md
      - Logging Setup: configuration/logging.md
      - LDAP Integration: configuration/ldap.md
      - OIDC Authentication: configuration/oidc.md
      - SAML Authentication: configuration/saml.md
      - Mail Configuration: configuration/mail.md
      - Record Type Customization: configuration/record-types.md
      - UI Customization:
          - Overview: configuration/ui/overview.md
          - Themes: configuration/ui/themes.md
          - Layout: configuration/ui/layout.md
          - Custom CSS: configuration/ui/custom-css.md
      - Permissions: configuration/permissions.md
      - Password Policies: configuration/password-policies.md
      - Security Policies: configuration/security-policies.md
      - API Configuration: configuration/api.md
      - WHOIS Configuration: configuration/whois.md
      - RDAP Configuration: configuration/rdap.md
      - Zone Import/Export: configuration/zone-import-export.md
      - User Agreements: configuration/user-agreements.md
      - Username Recovery: configuration/username-recovery.md
      - Avatar System: configuration/avatars.md
      - Database Logging: configuration/database-logging.md
      - Legacy Configuration (v3.x): configuration/legacy-configuration.md

  - User Guide:
      - User Management:
          - Users and Roles: user-guide/users-roles.md
          - User Groups: user-guide/groups.md
          - Multi-Factor Authentication: user-guide/mfa.md
          - Permissions: user-guide/permissions.md
      - DNS Management:
          - Zone Management: user-guide/zones.md
          - DNS Templates: user-guide/dns-templates.md
          - Reverse DNS (PTR): user-guide/reverse-dns.md
          - Bulk and Batch Operations: user-guide/bulk-operations.md
          - NAPTR Records: user-guide/naptr-records.md
          - TXT Records (SPF / DKIM / DMARC): user-guide/txt-records.md
          - Dynamic DNS:
              - Overview: user-guide/ddns/overview.md
              - Configuration: user-guide/ddns/configuration.md
              - Client Setup: user-guide/ddns/client-setup.md
              - Using cURL: user-guide/ddns/using-curl.md

  - Advanced Topics:
#      - Security:
#          - Best Practices: advanced/security-best-practices.md
#          - API Security: advanced/api-security.md
#          - Authentication Methods: advanced/authentication.md
      - Logging:
          - Log Configuration: advanced/logging-config.md
          - fail2ban Integration: advanced/fail2ban.md
#          - Log Analysis: advanced/log-analysis.md
#      - Performance:
#          - Optimization: advanced/optimization.md
#          - Caching: advanced/caching.md

  - Maintenance:
      - Overview: maintenance/index.md
#      - Backup and Restore: maintenance/backup-restore.md
#      - Monitoring: maintenance/monitoring.md
      
  - Upgrading:
      - Overview: upgrading/index.md
      - v4.x Series:
          - v4.4.0: upgrading/v4.4.0.md
          - v4.3.0: upgrading/v4.3.0.md
          - v4.2.0: upgrading/v4.2.0.md
          - v4.1.0: upgrading/v4.1.0.md
          - v4.0.5: upgrading/v4.0.5.md
          - v4.0.0: upgrading/v4.0.0.md
      - v3.x Series:
          - v3.9.x:
              - v3.9.7: upgrading/v3.9.7.md
              - v3.9.3: upgrading/v3.9.3.md
              - v3.9.2: upgrading/v3.9.2.md
              - v3.9.1: upgrading/v3.9.1.md
              - v3.9.0: upgrading/v3.9.0.md
          - v3.8.x:
              - v3.8.1: upgrading/v3.8.1.md
              - v3.8.0: upgrading/v3.8.0.md
          - v3.7.x:
              - v3.7.0: upgrading/v3.7.0.md
          - v3.6.x:
              - v3.6.1: upgrading/v3.6.1.md
              - v3.6.0: upgrading/v3.6.0.md
          - v3.5.x:
              - v3.5.1: upgrading/v3.5.1.md
              - v3.5.0: upgrading/v3.5.0.md
          - v3.4.x:
              - v3.4.2: upgrading/v3.4.2.md
              - v3.4.1: upgrading/v3.4.1.md
              - v3.4.0: upgrading/v3.4.0.md
          - v3.3.x:
              - v3.3.0: upgrading/v3.3.0.md
          - v3.2.x:
              - v3.2.0: upgrading/v3.2.0.md
          - v3.1.x:
              - v3.1.0: upgrading/v3.1.0.md
          - v3.0.x:
              - v3.0.0: upgrading/v3.0.0.md
      - v2.x Series:
          - v2.2.x:
              - v2.2.2: upgrading/v2.2.2.md
              - v2.2.1: upgrading/v2.2.1.md
              - v2.2.0: upgrading/v2.2.0.md
          - v2.1.x:
              - v2.1.9: upgrading/v2.1.9.md
              - v2.1.8: upgrading/v2.1.8.md
              - v2.1.7: upgrading/v2.1.7.md
              - v2.1.6: upgrading/v2.1.6.md
              - v2.1.5: upgrading/v2.1.5.md
              - v2.1.4: upgrading/v2.1.4.md
              - v2.1.3: upgrading/v2.1.3.md
              - v2.1.2: upgrading/v2.1.2.md
              - v2.1.1: upgrading/v2.1.1.md
              - v2.1.0: upgrading/v2.1.0.md

  - Troubleshooting:
#      - Common Issues: troubleshooting/common-issues.md
      - Debugging: troubleshooting/debugging.md
      - Reset Admin Password: troubleshooting/reset-admin-password.md
#      - FAQ: troubleshooting/faq.md

  - API Reference:
      - API Overview: api/overview.md
      - Authentication: api/authentication.md
      - Endpoints: api/endpoints.md

  - Contributing:
      - Development Setup: contributing/development.md
      - Coding Standards: contributing/coding-standards.md
      - Testing: contributing/testing.md
      - Translations: contributing/translations.md

plugins:
  - search
  - glightbox:
      touchNavigation: true
      loop: false
      effect: zoom
      slide_effect: slide
      width: 100%
      height: auto
      zoomable: true
      draggable: true