mkdocs.yml

site_name: SeaTable Admin Manual
site_url: https://admin.seatable.com/
site_author: SeaTable GmbH
site_description: >
  Admin documentation for SeaTable — installation, configuration, authentication, upgrade, maintenance, and cluster deployment guide.

# Repository
repo_name: seatable/seatable-admin-docs
repo_url: https://github.com/seatable/seatable-admin-docs/

# Copyright
copyright: Copyright © 2022 - 2026 SeaTable GmbH

# Configuration
theme:
  name: material
  features:
    - navigation.footer
    - navigation.tracking
    - navigation.tabs
    - navigation.sections # top-level sections are rendered as groups in the sidebar for viewports above 1220px
    - navigation.indexes # documents can be directly attached to sections
    - navigation.top
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
    - content.code.copy
    - content.code.annotate # offer a comfortable and friendly way to attach arbitrary content to specific sections of code
  custom_dir: overrides

  # icon & favicon
  logo: assets/SeaTable256-256.png
  favicon: assets/seatable-favicon.ico

  # custom 404.html
  static_templates:
    - 404.html

  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  font:
    text: Roboto
    code: Roboto Mono

# Plugins
plugins:
  - search:
      enabled: true
      # separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])' 
      # I try to remove this to fix the search issue with "ipv6 vs IPv6"
  - exclude-search:
      exclude:
      # - installation/advanced/example.md
      # or exclude page from the search in the frontmatter with "search:\n exclude: true"
  - minify:
      minify_html: true
  - git-revision-date-localized:
      enable_creation_date: true
  - redirects:
      redirect_maps:
        "changelog/changelog-for-seatable-professional-server.md": "https://seatable.com/changelog/"
        "docker/Python-Runner/Deploy SeaTable Python Runner.md": "installation/components/python-pipeline.md"
        "docker/Enterprise-Edition/Deploy SeaTable-EE with Docker.md": "installation/basic-setup.md"
        "docker/Enterprise-Edition/migrate_seatable_editions.md": "upgrade/migrate-seatable-editions.md"
        "docker/Developer-Edition/Deploy SeaTable-DE with Docker.md": "installation/basic-setup.md"
        "editions.md": "introduction/editions.md"
        "installation.md": "installation/basic-setup.md"
        "config.md": "configuration/plugins.md"
        "maintain.md": "upgrade/upgrade-manual.md"
        "maintain/seatable_fsck.md": "maintenance/filesystem-check.md"
        "maintain/clean_database.md": "maintenance/database-cleanup.md"
        "maintain/backup_recovery.md": "maintenance/backup-recovery.md"
  - git-committers:
      repository: seatable/seatable-admin-docs
      branch: main
      enabled: !ENV ["CI", false]
      token: !ENV ["MKDOCS_GIT_COMMITTERS_APIKEY"]

hooks:
  - overrides/hooks/shortcodes.py
  - overrides/hooks/sitemap_xsl.py

# Customization
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/seatable/
    - icon: fontawesome/brands/docker
      link: https://hub.docker.com/r/seatable/seatable-enterprise
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/seatable/
  status:
    new: Added with last version
    wip: Work in progress
  analytics:
    #provider: matomo
    #site_id: 3
    #provider_url: https://wp-stats.seatable.io/

    provider: posthog
    posthog_api_key: phc_wRHcvnLs4nsJLtycPXwtckL4NahZSAlw2uV3d4dm4hT
    posthog_api_host: https://ph.seatable.com
    posthog_ui_host: https://ph.seatable.com

extra_css:
  - assets/stylesheets/extra.css
extra_javascript:
  - assets/javascripts/extra.js

# Extensions
markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - md_in_html
  - footnotes
  - toc:
      permalink: true
  - codehilite:
      guess_lang: true
  - pymdownx.details # creates collapsible elements that hide their content
  - pymdownx.superfences: # allows 1) nesting of fences 2) custom fences 3) disable indented code
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.keys # make entering and styling keyboard key presses easier
  - pymdownx.tabbed: # provides a syntax to easily add tabbed Markdown content
      alternate_style: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg # Hooks


nav:
  - Introduction:
      - index.md
      - Architecture: introduction/architecture.md
      - Security: introduction/security.md
      - Requirements: introduction/requirements.md
      - System Limitations: introduction/system-limitations.md
      - Server Editions: introduction/editions.md
      - EULA (dtable-server): introduction/dtable-server-license.md
      - Get Support: introduction/get-support.md
      - Changelog: introduction/server-changelog.md

  - Installation:
      - How to start: installation/start.md
      - Our deployment approach: installation/deployment-approach.md
      - Single-Node Deployment:
          - SeaTable Server: installation/basic-setup.md
          - SeaTable AI: installation/components/seatable-ai.md
          - HTML Server: installation/components/html-server.md
          - Python Pipeline: installation/components/python-pipeline.md
          - Whiteboard: installation/components/whiteboard.md
          - n8n: installation/components/n8n.md
          - Report Design: installation/components/seadoc.md
          - Office Editors:
              - Collabora: installation/components/collabora.md
              - OnlyOffice: installation/components/onlyoffice.md
          - Monitoring:
              - Gatus: installation/components/gatus.md
              - Dozzle: installation/components/dozzle.md
              - Uptime Kuma: installation/components/uptime-kuma.md
              - Zabbix: installation/components/zabbix.md
              - Releem: installation/components/releem.md
          - Backup: installation/components/restic.md
          - Ofelia: installation/components/ofelia.md
          - Antivirus: installation/components/clamav.md
          - FAQ / Troubleshooting: installation/faq.md

      - Advanced Topics:
          - Webserver:
              - Activate IPv6: installation/advanced/ipv6-support.md
              - Custom Reverse Proxy: installation/advanced/custom-proxy.md
              - DNS-01 Challenge: installation/advanced/webserver-dns-challenge.md
              - Custom Certificates: installation/advanced/custom-certificates.md
              - Force HTTP: installation/advanced/http-only.md
              - Additional Subdomains: installation/advanced/additional-subdomains.md
              - Air Gap Installation: installation/advanced/air-gap-installation.md
              - Webserver Security: installation/advanced/webserver-security.md
              - Maintenance Mode: installation/advanced/maintenance-mode.md
              - Advanced Settings for Caddy: installation/advanced/settings-caddy.md
          - SeaTable AI:
              - SeaTable AI (standalone): installation/advanced/seatable-ai-standalone.md
              - AI Token Pricing: installation/advanced/seatable-ai-token-pricing.md
              - LLM Self-Hosting:
                  - Prerequisites: installation/advanced/seatable-ai-prerequisites.md
                  - Ollama: installation/advanced/ollama.md
                  - vLLM: installation/advanced/vllm.md
          - S3 Object Storage:
              - Configuration: installation/advanced/s3.md
              - Migration: installation/advanced/s3-migration.md
              - Encryption: installation/advanced/s3-encryption.md
          - Python Pipeline:
              - Custom Python Runner: installation/advanced/python-pipeline-custom-python-runner.md
              - Separate Python Pipeline: installation/advanced/python-pipeline-dedicated-server.md
              - Configure Python Pipeline: installation/advanced/python-pipeline-configuration.md
              - Python Pipeline Workflow: installation/advanced/python-pipeline-workflow.md
          - Network Issues:
              - Running SeaTable without Hairpin NAT: installation/advanced/hairpin-nat.md 
          - Metrics: installation/advanced/metrics.md
          - MariaDB (standalone): installation/advanced/database-standalone.md
          - Seafile (external): installation/advanced/seafile.md

      - Cluster Deployment:
          - Introduction: installation/cluster/introduction.md
          - Requirements: installation/cluster/requirements.md
          - Step-by-step guide:
            - Basic setup: installation/cluster/basic-setup-with-external-services.md
            - dtable-db (standalone): installation/cluster/dtable-db-standalone.md
            - dtable-server (standalone): installation/cluster/dtable-server-standalone.md
            - dtable-server (two or more): installation/cluster/dtable-server-multiple.md
            - dtable-events (standalone): installation/cluster/dtable-events-background-node.md
          - Managed Services: installation/cluster/managed-services.md

  - Configuration:
      - Plugins: configuration/plugins.md
      - Email Sending: configuration/sending-email.md
      - Roles and Permissions: configuration/roles-and-permissions.md
      - Universal Apps: configuration/universal-apps.md
      - Autostart: configuration/autostart.md
      - Base Rows Limit: configuration/base-rows-limit.md
      - User Hierarchy:
          - Overview: configuration/user-hierarchy/overview.md
          - Groups: configuration/user-hierarchy/groups.md
          - Teams/Organizations: configuration/user-hierarchy/teams-organizations.md
          - Departments: configuration/user-hierarchy/departments.md
      - Authentication:
          - Overview: configuration/authentication/overview.md
          - Methods:
              - Two Factor Authentication: configuration/authentication/two-factor-auth.md
              - LDAP: configuration/authentication/ldap.md
              - OAuth: configuration/authentication/oauth.md
              - SAML: configuration/authentication/saml.md
              - SAML for teams: configuration/authentication/saml-team.md
              - JWT-Token: configuration/authentication/jwt.md
          - Switch authentication: configuration/authentication/auth-switch.md
      - Configuration:
          - Overview: configuration/overview.md
          - Customizations: configuration/customizations.md
          - Components:
              - dtable-api-gateway: configuration/components/dtable-api-gateway.md
              - dtable-db: configuration/components/dtable-db.md
              - dtable-events: configuration/components/dtable-events.md
              - dtable-server: configuration/components/dtable-server.md
              - dtable-storage-server: configuration/components/dtable-storage-server.md
              - dtable-web: configuration/components/dtable-web.md
              - seafile: configuration/components/seafile.md
              - gunicorn: configuration/components/gunicorn.md
              - nginx: configuration/components/nginx.md

  - UI Customization:
      - Overview: customization/overview.md
      #- input: customization/custom-css.md
      - Site Title: customization/site-title.md
      - Logo: customization/logo.md
      - Favicon: customization/favicon.md
      - Manual Link: customization/manual-in-nav.md
      - Navigation Items: customization/nav-items.md
      - Main Color: customization/main-color.md
      - Custom CSS: customization/custom-css.md
      - Templates: customization/templates.md
      - Page Templates: customization/page-templates.md
      - Template Snippets: customization/template-snippets.md

  - Upgrade:
      - How to upgrade: upgrade/upgrade-manual.md
      - Extra Upgrade Notices: upgrade/extra-upgrade-notice.md
      - Migrations:
          - Switch SeaTable Edition: upgrade/migrate-seatable-editions.md
          - Switch Installation Method (v4.3): upgrade/migrate-seatable-release.md

  - Maintenance:
      - Restart SeaTable: maintenance/restart-seatable.md
      - Backup and Recovery: maintenance/backup-recovery.md
      - Clean Database: maintenance/database-cleanup.md
      - Clean Storage: maintenance/storage-cleanup.md
      - Clean Big Data: maintenance/big-data-cleanup.md
      - Filesystem check: maintenance/filesystem-check.md
      - Change URL: maintenance/domain-change.md
      - Export Base: maintenance/base-export.md
      - Repair Base: maintenance/repair-base.md
      - Password reset: maintenance/password-reset.md
      - Logging: maintenance/logs.md
      - Add custom error messages: maintenance/debugging.md
      - Secrets Management: maintenance/secrets.md
      - MariaDB Tuning: maintenance/mariadb-tuning.md
      - Helper Scripts: maintenance/helper-scripts.md