site_name: Tube Archivist Documentation
site_url: https://docs.tubearchivist.com
nav:
    - Home: 'index.md'
    - User Guide:
        - 'FAQ': 'faq.md'
        - 'URLs': 'urls.md'
        - 'Downloads Page': 'downloads.md'
        - 'Channels Pages': 'channels.md'
        - 'Video': 'video.md'
        - 'Playlists Pages': 'playlists.md'
        - 'Search': 'search.md'
        - 'Users': 'users.md'
        - Settings:
          - 'Dashboard': 'settings/dashboard.md'
          - 'User': 'settings/user.md'
          - 'Application': 'settings/application.md'
          - 'Scheduling': 'settings/scheduling.md'
          - 'Actions': 'settings/actions.md'
        - 'Advanced': 'advanced.md'
    - Installation:
        - 'Docker-Compose (default)': 'installation/docker-compose.md'
        - 'Unraid': 'installation/unraid.md'
        - 'Synology': 'installation/synology.md'
        - 'Podman': 'installation/podman.md'
        - 'Truenas Scale': 'installation/truenas-scale.md'
        - 'Helm Charts': 'installation/helm-charts.md'
    - Configuration:
        - 'LDAP Authentication': 'configuration/ldap.md'
        - 'Forward Authentication': 'configuration/forward-auth.md'
        - 'Cast Support': 'configuration/cast.md'
        - 'Stylesheets': 'configuration/stylesheets.md'
    - API:
        - 'Introduction': 'api/introduction.md'
        - 'Video': 'api/video.md'
        - 'Channel': 'api/channel.md'
        - 'Playlist': 'api/playlist.md'
        - 'Download': 'api/download.md'
        - 'Snapshot': 'api/snapshot.md'
        - 'Backup': 'api/backup.md'
        - 'Task': 'api/task.md'
        - 'Stats': 'api/stats.md'
        - 'Config': 'api/config.md'
        - 'Additional': 'api/additional.md'
    - Links:
        - 'Main site': https://www.tubearchivist.com
        - 'Join us on Discord!': https://www.tubearchivist.com/discord
        - 'License': https://github.com/tubearchivist/tubearchivist/blob/master/LICENSE
        - 'Release Notes': https://github.com/tubearchivist/tubearchivist/releases
repo_url: https://github.com/tubearchivist/docs
markdown_extensions:
    - toc:
        permalink: "#"
    - admonition
    - pymdownx.details
    - pymdownx.superfences
    - tables
    - footnotes
theme:
  name: material
  logo: assets/logo-dark.jpg
  favicon: assets/favicon.ico
  font: false
  custom_dir: overrides
  palette:
    scheme: tubearchivist
  features:
    - navigation.footer
    - content.code.copy
extra_css:
  - stylesheets/style.css
extra:
  analytics:
    provider: custom
plugins:
  - social:
      cards_layout_options:
        background_color: "#00202f"
        color: "#eeeeee"
  - search:
      lang: en