sidebars.js

/**
 * @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
const sidebars = {
  documentation: [
    'docs/index',
    'docs/quickstart',
    {
      type: 'category',
      label: 'Deploy',
      items: [
        {
          id: 'docs/deploy/releases',
          type: 'doc',
          label: 'Releases',
        },
        {
          type: 'category',
          label: 'Pomerium Core',
          link: {type: 'doc', id: 'docs/deploy/core'},
          items: [{type: 'autogenerated', dirName: 'docs/deploy/core'}],
        },
        {
          type: 'category',
          label: 'Enterprise',
          link: {type: 'doc', id: 'docs/deploy/enterprise'},
          items: [
            'docs/deploy/enterprise/quickstart',
            'docs/deploy/enterprise/install',
            'docs/deploy/enterprise/configure',
            'docs/deploy/enterprise/changelog',
            'docs/deploy/enterprise/upgrading',
          ],
        },
        {
          type: 'category',
          label: 'Kubernetes',
          link: {type: 'doc', id: 'docs/deploy'},
          items: [{type: 'autogenerated', dirName: 'docs/deploy/k8s'}],
        },
        {
          type: 'category',
          label: 'Clients',
          link: {type: 'doc', id: 'docs/deploy/clients'},
          items: [{type: 'autogenerated', dirName: 'docs/deploy/clients'}],
        },
        'docs/deploy/production-deployment',
      ],
    },
    {
      type: 'category',
      label: 'Capabilities',
      items: [
        // core & open source
        //
        // Core concepts
        'docs/capabilities/authentication',
        'docs/capabilities/authorization',
        'docs/capabilities/ppl',
        'docs/capabilities/routing',
        // secondary capabilities
        {
          type: 'doc',
          label: 'Audit Logs',
          id: 'docs/capabilities/audit-logs',
        },
        'docs/capabilities/hosted-authenticate-service',
        'docs/capabilities/self-hosted-authenticate-service',
        'docs/capabilities/jwt-verification',
        'docs/capabilities/mtls-clients',
        'docs/capabilities/mtls-services',
        'docs/capabilities/getting-users-identity',
        'docs/capabilities/single-sign-out',
        'docs/capabilities/programmatic-access',
        'docs/capabilities/load-balancing',
        'docs/capabilities/kubernetes-access',
        {
          type: 'category',
          label: 'TCP over HTTP',
          link: {type: 'doc', id: 'docs/capabilities/tcp'},
          items: [{type: 'autogenerated', dirName: 'docs/capabilities/tcp'}],
        },

        // Enterprise
        {
          id: 'docs/capabilities/impersonation',
          className: 'enterprise',
          type: 'doc',
          label: 'User Impersonation',
        },
        {
          id: 'docs/capabilities/device-identity',
          className: 'enterprise',
          type: 'doc',
          label: 'Device Identity',
        },
        {
          id: 'docs/capabilities/enterprise-api',
          className: 'enterprise',
          type: 'doc',
          label: 'Management API',
        },
        {
          id: 'docs/capabilities/original-request-context',
          className: 'enterprise',
          type: 'doc',
          label: 'Original User Context',
        },
        {
          id: 'docs/capabilities/branding',
          className: 'enterprise',
          type: 'doc',
          label: 'Custom Branding / Errors',
        },
        {
          id: 'docs/capabilities/metrics',
          className: 'enterprise',
          type: 'doc',
          label: 'Metrics',
        },
        {
          id: 'docs/capabilities/reports',
          className: 'enterprise',
          type: 'doc',
          label: 'Reports',
        },
        {
          id: 'docs/capabilities/service-accounts',
          className: 'enterprise',
          type: 'doc',
          label: 'Service Accounts',
        },
        {
          id: 'docs/capabilities/high-availability',
          className: 'enterprise',
          type: 'doc',
          label: 'High Availability',
        },
        {
          id: 'docs/capabilities/namespacing',
          className: 'enterprise',
          type: 'doc',
          label: 'Namespaces',
        },
      ],
    },
    {
      type: 'category',
      label: 'Concepts',
      items: [{type: 'autogenerated', dirName: 'docs/concepts'}],
    },
    {
      type: 'category',
      label: 'Identity Providers',
      link: {
        type: 'doc',
        id: 'docs/identity-providers/index',
      },
      items: [
        'docs/identity-providers/apple',
        'docs/identity-providers/auth0',
        'docs/identity-providers/azure',
        'docs/identity-providers/cognito',
        'docs/identity-providers/github',
        'docs/identity-providers/gitlab',
        'docs/identity-providers/google',
        'docs/identity-providers/oidc',
        'docs/identity-providers/okta',
        'docs/identity-providers/one-login',
        'docs/identity-providers/ping',
      ],
    },
    {
      type: 'category',
      label: 'Integrations',
      link: {type: 'doc', id: 'docs/integrations'},
      items: [
        {
          id: 'docs/integrations/bamboohr',
          className: 'enterprise',
          type: 'doc',
          label: 'BambooHR',
        },
        {
          id: 'docs/integrations/geoip',
          className: 'enterprise',
          type: 'doc',
          label: 'GeoIP Ranges',
        },
        {
          id: 'docs/integrations/ip-ranges',
          className: 'enterprise',
          type: 'doc',
          label: 'Well-Known IP Ranges',
        },
        {
          id: 'docs/integrations/tor-exit-nodes',
          className: 'enterprise',
          type: 'doc',
          label: 'Tor Exit Nodes',
        },
        {
          id: 'docs/integrations/vpn-providers',
          className: 'enterprise',
          type: 'doc',
          label: 'VPN Providers',
        },
        {
          id: 'docs/integrations/zenefits',
          className: 'enterprise',
          type: 'doc',
          label: 'Zenefits',
        },
      ],
    },
    {
      type: 'category',
      label: 'Internals',
      link: {type: 'doc', id: 'docs/internals/architecture'},
      items: [{type: 'autogenerated', dirName: 'docs/internals'}],
    },
    {
      type: 'category',
      label: 'Community',
      link: {type: 'doc', id: 'docs/community'},
      items: [{type: 'autogenerated', dirName: 'docs/community'}],
    },
  ],
  reference: [
    {
      type: 'category',
      label: 'Reference',
      link: {
        type: 'doc',
        id: 'docs/reference',
      },
      items: [{type: 'autogenerated', dirName: 'docs/reference'}],
    },
  ],
  guides: [
    {
      type: 'category',
      label: 'Guides',
      link: {
        type: 'generated-index',
        title: 'Pomerium Guides',
        description:
          'Step by step guides for common apps, services, platforms, and use-cases with Pomerium!',
        keywords: ['guides'],
        slug: 'docs/guides',
      },
      items: [{type: 'autogenerated', dirName: 'docs/guides'}],
    },
  ],
};

module.exports = sidebars;