privateGPT/fern/docs.yml

instances:
  - url: privategpt.docs.buildwithfern.com
    custom-domain: docs.privategpt.dev

title: PrivateGPT | Docs

redirects:
  - source: "/overview/welcome/introduction"
    destination: "/introduction"
  - source: "/installation/getting-started/main-concepts"
    destination: "/introduction"

tabs:
  manual:
    display-name: Manual
    icon: "fa-solid fa-book-open"
    skip-slug: true
  api-guide:
    display-name: API Guide
    icon: "fa-solid fa-book"
    skip-slug: true
  api-reference:
    display-name: API Reference
    icon: "fa-solid fa-code"
    skip-slug: true

navigation:
  - tab: manual
    layout:
      - section: Getting started
        skip-slug: true
        contents:
          - page: Introduction
            path: ./docs/pages/index.mdx
          - page: Quickstart
            slug: getting-started/quickstart
            path: ./docs/pages/getting-started/quickstart.mdx
          - page: How it works
            slug: getting-started/how-it-works
            path: ./docs/pages/getting-started/how-it-works.mdx
      - section: Installation Options
        skip-slug: true
        contents:
          - page: Package Install
            slug: installation/package
            path: ./docs/pages/installation/package.mdx
          - page: Docker
            slug: installation/docker
            path: ./docs/pages/installation/docker.mdx
          - page: Development
            slug: installation/local
            path: ./docs/pages/installation/local.mdx
      - section: Configuration
        skip-slug: true
        contents:
          - page: CLI
            slug: configuration/cli
            path: ./docs/pages/configuration/cli.mdx
          - page: Settings & Profiles
            slug: configuration/settings
            path: ./docs/pages/configuration/settings.mdx
          - page: Model Configuration
            slug: configuration/advanced
            path: ./docs/pages/configuration/advanced.mdx
      - section: Inference Providers
        skip-slug: true
        contents:
          - page: Overview
            slug: providers/overview
            path: ./docs/pages/providers/overview.mdx
          - page: Ollama
            slug: providers/ollama
            path: ./docs/pages/providers/ollama.mdx
          - page: LM Studio
            slug: providers/lmstudio
            path: ./docs/pages/providers/lmstudio.mdx
          - page: LlamaCPP Server
            slug: providers/llamacpp
            path: ./docs/pages/providers/llamacpp.mdx
          - page: vLLM
            slug: providers/vllm
            path: ./docs/pages/providers/vllm.mdx
      - section: Integrations
        skip-slug: true
        contents:
          - page: Overview
            slug: integrations/overview
            path: ./docs/pages/integrations/overview.mdx
          - page: Claude Code
            slug: integrations/claude-code
            path: ./docs/pages/integrations/claude-code.mdx
          - page: Claude Desktop
            slug: integrations/claude-desktop
            path: ./docs/pages/integrations/claude-desktop.mdx
          - page: Claude for Microsoft 365
            slug: integrations/claude-office
            path: ./docs/pages/integrations/claude-office.mdx
          - page: OpenCode
            slug: integrations/opencode
            path: ./docs/pages/integrations/opencode.mdx
      - section: Built-in Tools
        skip-slug: true
        contents:
          - page: Web Tools
            slug: tools/web-tools
            path: ./docs/pages/tools/web-tools.mdx
          - page: Database Tools
            slug: tools/database-tools
            path: ./docs/pages/tools/database-tools.mdx
          - page: Code Execution Tools
            slug: tools/code-execution
            path: ./docs/pages/tools/code-execution.mdx
      - section: Storage Providers
        skip-slug: true
        contents:
          - page: Vector Store
            slug: storage/vectordb
            path: ./docs/pages/storage/vectordb.mdx
          - page: Object Storage
            slug: storage/storage
            path: ./docs/pages/storage/storage.mdx
      - section: User Interface
        skip-slug: true
        contents:
          - page: Workbench
            slug: ui/workbench
            path: ./docs/pages/ui/workbench.mdx
      - section: Observability
        skip-slug: true
        contents:
          - page: Observability
            slug: observability/observability
            path: ./docs/pages/observability/observability.mdx
      - section: Community
        skip-slug: true
        contents:
          - page: Community Forks
            slug: community/forks
            path: ./docs/pages/community/forks.mdx
      - section: Reference
        skip-slug: true
        contents:
          - page: Troubleshooting
            slug: reference/troubleshooting
            path: ./docs/pages/reference/troubleshooting.mdx
  - tab: api-guide
    layout:
      - section: Core API
        skip-slug: true
        contents:
          - page: Messages
            slug: api-guide/messages
            path: ./docs/pages/api-guide/messages.mdx
          - page: Async messages
            slug: api-guide/messages-async
            path: ./docs/pages/api-guide/messages-async.mdx
          - page: Embeddings
            slug: api-guide/embeddings
            path: ./docs/pages/api-guide/embeddings.mdx
      - section: Tools & Skills
        skip-slug: true
        contents:
          - page: Built-in Tools
            slug: api-guide/tools
            path: ./docs/pages/api-guide/tools.mdx
          - page: Skills
            slug: api-guide/skills
            path: ./docs/pages/api-guide/skills.mdx
      - section: Documents
        skip-slug: true
        contents:
          - page: Ingestion
            slug: api-guide/ingestion
            path: ./docs/pages/api-guide/ingestion.mdx
          - page: Async ingestion
            slug: api-guide/ingestion-async
            path: ./docs/pages/api-guide/ingestion-async.mdx
  - tab: api-reference
    layout:
      - section: Overview
        skip-slug: true
        contents:
          - page: API Reference
            slug: api-reference/api-reference
            path: ./docs/pages/api-reference/api-reference.mdx
          - page: Client libraries
            slug: api-reference/sdks
            path: ./docs/pages/api-reference/sdks.mdx
      - api: API Reference

navbar-links:
  - type: secondary
    text: Contact us
    url: "mailto:hello@zylon.ai"
  - type: github
    value: "https://github.com/zylon-ai/private-gpt"
  - type: primary
    text: Join the Discord
    url: https://discord.com/invite/bK6mRVpErU

colors:
  accentPrimary:
    dark: "#C6BBFF"
    light: "#756E98"

logo:
  dark: docs/assets/logo_light.png
  light: docs/assets/logo_dark.png
  height: 50

favicon: docs/assets/favicon.ico