mkdocs.yml

site_name: Documentation
site_url: https://docs.netalertx.com
repo_url: https://github.com/netalertx/NetAlertX/
edit_uri: blob/main/docs/
docs_dir: docs
use_directory_urls: true
site_description: >-
  The main documentation resource for NetAlertX - a network scanner and presence detector
# static_dir: docs/img
nav:
  - Home: index.md

  - Installation:
      - Installation options: INSTALLATION.md
      - Quick setup: INITIAL_SETUP.md
      - Docker:
        - Docker Guide: DOCKER_INSTALLATION.md
        - Docker Compose: DOCKER_COMPOSE.md
        - Docker File Permissions: FILE_PERMISSIONS.md
        - Docker Updates: UPDATES.md
        - Docker Maintenance: DOCKER_MAINTENANCE.md
      - Docker Startup Troubleshooting:
        - ARP flux sysctls: docker-troubleshooting/arp-flux-sysctls.md
        - Aufs capabilities: docker-troubleshooting/aufs-capabilities.md
        - Excessive capabilities: docker-troubleshooting/excessive-capabilities.md
        - File permissions: docker-troubleshooting/file-permissions.md
        - Incorrect user: docker-troubleshooting/incorrect-user.md
        - Missing capabilities: docker-troubleshooting/missing-capabilities.md
        - Mount issues: docker-troubleshooting/mount-configuration-issues.md
        - Network mode: docker-troubleshooting/network-mode.md
        - Nginx mount: docker-troubleshooting/nginx-configuration-mount.md
        - Port conflicts: docker-troubleshooting/port-conflicts.md
        - Read only: docker-troubleshooting/read-only-filesystem.md
        - Running as root: docker-troubleshooting/running-as-root.md
      - Other:
        - Synology Guide: SYNOLOGY_GUIDE.md
        - Portainer Stacks: DOCKER_PORTAINER.md
        - Community Guides: COMMUNITY_GUIDES.md
        - Bare-metal (Experimental): HW_INSTALL.md
        - Migration Guide: MIGRATION.md
      - Help:
        - Common issues: COMMON_ISSUES.md
  - Setup:
      - Getting started:
        - Subnets: SUBNETS.md
        - Enable Plugins: PLUGINS.md
        - Pi-hole Guide: PIHOLE_GUIDE.md
        - Home Assistant: HOME_ASSISTANT.md
        - Emails: SMTP.md
        - Backups: BACKUPS.md
        - Security Features: SECURITY_FEATURES.md
        - Security Considerations: SECURITY.md
      - Advanced guides:
        - Remote Networks: REMOTE_NETWORKS.md
        - Notifications Guide: NOTIFICATIONS.md
        - Notification Text Templates: NOTIFICATION_TEMPLATES.md
        - Custom PUID/GUID: PUID_PGID_SECURITY.md
        - Name Resolution: NAME_RESOLUTION.md
        - Authelia: AUTHELIA.md
        - Performance: PERFORMANCE.md
        - Reverse DNS: REVERSE_DNS.md
        - Reverse Proxy: REVERSE_PROXY.md
        - Webhooks (n8n): WEBHOOK_N8N.md
        - Workflows: WORKFLOWS.md
        - Workflow Examples: WORKFLOW_EXAMPLES.md
        - Docker Swarm: DOCKER_SWARM.md
      - Best practice advisories:
        - Eyes on glass: ADVISORY_EYES_ON_GLASS.md
        - Multi-network monitoring: ADVISORY_MULTI_NETWORK.md
      - Help:
        - Common issues: COMMON_ISSUES.md
        - Random MAC: RANDOM_MAC.md
        - Incorrect Offline Detection: FIX_OFFLINE_DETECTION.md
  - Device guides:
      - Editing Devices:
        - Management: DEVICE_MANAGEMENT.md
        - Bulk Editing: DEVICES_BULK_EDITING.md
        - Custom Properties: CUSTOM_PROPERTIES.md
        - Device Display Settings: DEVICE_DISPLAY_SETTINGS.md
        - Session Info: SESSION_INFO.md
        - Field Lock/Unlock: DEVICE_FIELD_LOCK.md
      - Icons and Topology:
        - Icons: ICONS.md
        - Network Topology: NETWORK_TREE.md
  - Troubleshooting:
      - General Tips: DEBUG_TIPS.md
      - Common Issues: COMMON_ISSUES.md
      - Inspecting Logs: LOGGING.md
      - API Server Issues: DEBUG_API_SERVER.md
      - Invalid JSON Issues: DEBUG_INVALID_JSON.md
      - PHP Issues: DEBUG_PHP.md
      - Plugin Issues: DEBUG_PLUGINS.md
      - Web UI Port Issues: WEB_UI_PORT_DEBUG.md
      - Workflows Issues: WORKFLOWS_DEBUGGING.md
  - Development:
      - Plugin and app development:
        - Environment Setup: DEV_ENV_SETUP.md
        - Builds: BUILDS.md
        - Devcontainer: DEV_DEVCONTAINER.md
        - Devcontainer Ports: DEV_PORTS_HOST_MODE.md
        - Custom Plugins:
          - Overview: PLUGINS_DEV.md
          - Quick Start: PLUGINS_DEV_QUICK_START.md
          - Data Contract: PLUGINS_DEV_DATA_CONTRACT.md
          - Settings System: PLUGINS_DEV_SETTINGS.md
          - Data Sources: PLUGINS_DEV_DATASOURCES.md
          - UI Components: PLUGINS_DEV_UI_COMPONENTS.md
          - Config Lifecycle: PLUGINS_DEV_CONFIG.md
        - Frontend Development: FRONTEND_DEVELOPMENT.md
        - Database: DATABASE.md
        - Settings: SETTINGS_SYSTEM.md
        - Versions: VERSIONS.md
        - Icon and Type guessing: DEVICE_HEURISTICS.md
      - API:
        - Overview: API.md
        - Devices Collection: API_DEVICES.md
        - Device: API_DEVICE.md
        - Device Field Lock: API_DEVICE_FIELD_LOCK.md
        - Sessions: API_SESSIONS.md
        - Settings: API_SETTINGS.md
        - Events: API_EVENTS.md
        - Messaging in-app: API_MESSAGING_IN_APP.md
        - Metrics: API_METRICS.md
        - Net Tools: API_NETTOOLS.md
        - Online History: API_ONLINEHISTORY.md
        - Sync: API_SYNC.md
        - Logs: API_LOGS.md
        - SSE: API_SSE.md
        - GraphQL: API_GRAPHQL.md
        - DB query: API_DBQUERY.md
        - MCP: API_MCP.md
        - Tests: API_TESTS.md
        - SUPERSEDED OLD API Overview: API_OLD.md
      - Integrations:
        - Webhook Secret: WEBHOOK_SECRET.md
        - Helper scripts: HELPER_SCRIPTS.md


theme:
  name: material
  logo: img/netalertx_docs.png  # Reference the favicon here
  favicon: img/netalertx_docs.png
  custom_dir: docs/overrides
  metadata:
    description: "NetAlertX Documentation - The go-to resource for all things related to NetAlertX."
    image: "https://raw.githubusercontent.com/netalertx/NetAlertX/main/front/img/netalertx_docs.png"
  extra:
    home_hide_sidebar: true
    analytics:
      provider: google
      property: G-KCRSGLP8J2
    social:
    - icon: fontawesome/brands/github
      link: https://github.com/jokob-sk
    - icon: fontawesome/brands/docker
      link: https://hub.docker.com/r/jokobsk/netalertx/
    - icon: fontawesome/brands/x-twitter
      link: https://x.com/NetAlertX
  features:
    - announce.dismiss
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    # - content.code.select
    # - content.footnote.tooltips
    # - content.tabs.link
    - content.tooltips
    # - header.autohide
    # - navigation.expand
    - navigation.footer
    - navigation.indexes
    # - navigation.instant
    # - navigation.instant.prefetch
    # - navigation.instant.progress
    # - navigation.prune
    - navigation.sections
    - navigation.tabs
    # - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
    # - toc.integrate
  palette:
    - scheme: slate  # Default to dark mode
      primary: indigo  # Dark blue
      accent: deep-purple  # Adjust accent color if needed
      toggle:
        icon: material/lightbulb
        name: Switch to light mode
    - scheme: default  # Light mode (optional)
      primary: black
      accent: deep-purple
      toggle:
        icon: material/lightbulb-outline
        name: Switch to dark mode
markdown_extensions:
  - admonition
  - pymdownx.superfences
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.tabbed
  - pymdownx.details
  - pymdownx.snippets
  - pymdownx.blocks.tab
  - pymdownx.blocks.admonition
  - pymdownx.blocks.details
  - pymdownx.mark
  - pymdownx.tasklist
  - pymdownx.emoji
  - pymdownx.magiclink
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
plugins:
  - gh-admonitions
  - search
  - glightbox

# Custom CSS
extra_css:
  - stylesheets/custom.css
  - https://cdnjs.cloudflare.com/ajax/libs/font-awesome/7.0.1/css/all.min.css

favicon: /img/netalertx_docs.png