site_name: Charmarr
site_url: https://charmarr.tv
site_description: Kubernetes-native media automation with Juju charms
repo_url: https://github.com/charmarr/charmarr
repo_name: charmarr/charmarr

theme:
  name: material
  custom_dir: docs/overrides
  logo: assets/logos/charmarr.png
  favicon: assets/logos/charmarr.png
  palette:
    scheme: slate
    primary: black
    accent: deep orange
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - navigation.indexes
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.tabs.link

markdown_extensions:
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - admonition
  - pymdownx.details
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true

plugins:
  - search

extra:
  generator: false
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/charmarr
    - icon: fontawesome/brands/github-alt
      link: https://github.com/adhityaravi
    - icon: fontawesome/brands/discord
      link: https://discord.com/users/690270213370806313
  version:
    provider: mike

extra_css:
  - assets/extra.css

docs_dir: docs

nav:
  - Home: index.md
  - Setup:
      - setup/index.md
      - Prerequisites: setup/prerequisites.md
      - Quick Deploy: setup/quickdeploy.md
      - Manual Deploy: setup/manual.md
      - Post-Deploy: setup/post-deploy.md
  - Charms:
      - charms/index.md
      - Media Manager: charms/media-manager.md
      - Media Indexer: charms/media-indexer.md
      - Download Client: charms/download-client.md
      - Media Requester: charms/media-requester.md
      - Media Server: charms/media-server.md
      - Storage: charms/storage.md
      - VPN Gateway: charms/vpn-gateway.md
  - Migration:
      - migration/index.md
      - Overseerr → Seerr: migration/overseerr-to-seerr.md
      - Recyclarr v7 → v8: migration/recyclarr-v8.md
  - Security:
      - security/index.md
      - Networking: security/network.md
      - Secrets: security/secrets.md
  - Observability:
      - observability/index.md
      - Setup: observability/setup.md
      - Dashboards: observability/dashboards.md
      - Crowsnest: observability/crowsnest.md
  - Backup:
      - backup/index.md
  - Releases:
      - releases/index.md
      - Track 1: releases/track-1.md
  - FAQ: faq.md

copyright: Copyright © 2025 | AGPL-3.0