sidebars.js

/**
 * Creating a sidebar enables you to:
 - create an ordered group of docs
 - render a sidebar for each doc of that group
 - provide next/previous navigation

 The sidebars can be generated from the filesystem, or explicitly defined here.

 Create as many sidebars as you want.
 */

module.exports = {
  tutorialSidebar: [
    {
      type: "category",
      label: "The Basics",
      link: {type: "generated-index"},
      items: [
        "overview",
        "basic/core-concepts",
        "basic/server-installation",
        "basic/try-with-docker",
        "basic/try-with-helm",
        "basic/public-api",
        "basic/tutorials",
        {
          type: "link",
          label: "PDF Download",
          href: "/pdf",
        },
      ],
    },
    {
      type: "category",
      label: "Deployment",
      link: {type: "generated-index"},
      items: [
        "deployment/nginx",
        "deployment/k8s",
        "deployment/data-initialization",
        "deployment/deploy-cdn",
        "deployment/deploy-intranet",
        "deployment/db-migration",
      ],
    },
    {
      type: "category",
      label: "How to Connect to Casdoor",
      link: {type: "generated-index"},
      items: [
        "how-to-connect/overview",
        "how-to-connect/oidc-client",
        "how-to-connect/sdk",
        "how-to-connect/single-sign-on",
        "how-to-connect/vue-sdk",
        {
          type: "category",
          label: "Desktop SDKs",
          collapsed: true,
          link: {type: "generated-index"},
          items: [
            "how-to-connect/desktop-sdks/electron-app",
            "how-to-connect/desktop-sdks/dotnet-app",
            "how-to-connect/desktop-sdks/maui-app",
            "how-to-connect/desktop-sdks/qt-app",
          ],
        },
        {
          type: "category",
          label: "Mobile SDKs",
          collapsed: true,
          link: {type: "generated-index"},
          items: [
            "how-to-connect/mobile-sdks/react-native-app",
          ],
        },
        "how-to-connect/plugin",
        "how-to-connect/nextjs",
        "how-to-connect/nuxt",
        "how-to-connect/oauth",
        "how-to-connect/cas",
        {
          type: "category",
          label: "SAML",
          collapsed: true,
          link: {type: "generated-index"},
          items: [
            "how-to-connect/saml/overview",
            "how-to-connect/saml/aws",
            "how-to-connect/saml/keycloak",
            "how-to-connect/saml/google-workspace",
            "how-to-connect/saml/appgate",
            "how-to-connect/saml/tencent-cloud",
          ],
        },
        "how-to-connect/face-id",
        "how-to-connect/webauthn",
      ],
    },
    {
      type: "category",
      label: "Developer Guide",
      link: {type: "generated-index"},
      items: [
        "developer-guide/frontend",
        "developer-guide/swagger",
      ],
    },
    {
      type: "category",
      label: "Organizations",
      link: {type: "generated-index"},
      items: [
        "organization/overview",
        "organization/organization-tree",
        "organization/passwordComplexity",
        "organization/accountCustomization",
        "organization/customize-theme",
        "organization/mfa-items",
      ],
    },
    {
      type: "category",
      label: "Applications",
      link: {type: "generated-index"},
      items: [
        "application/overview",
        "application/terminology",
        "application/config",
        "application/providers",
        "application/signin-methods",
        "application/signup-items-table",
        "application/signin-items-table",
        "application/ui-customization",
        "application/specify-login-organization",
        "application/tags",
        "application/invitation-code",
      ],
    },
    {
      type: "category",
      label: "Permissions",
      link: {type: "generated-index"},
      items: [
        "permission/overview",
        "permission/permission-configuration",
        "permission/exposed-casbin-apis",
        "permission/adapter",
      ],
    },
    {
      type: "category",
      label: "Providers",
      link: {type: "generated-index"},
      items: [
        "provider/overview",
        {
          type: "category",
          label: "OAuth",
          collapsed: true,
          link: {type: "generated-index"},
          items: [
            "provider/oauth/overview",
            "provider/oauth/google",
            "provider/oauth/googleonetap",
            "provider/oauth/github",
            "provider/oauth/linkedin",
            "provider/oauth/facebook",
            "provider/oauth/adfs",
            "provider/oauth/azureAD",
            "provider/oauth/azureADb2c",
            "provider/oauth/CustomProvider",
            "provider/oauth/okta",
            "provider/oauth/Twitter",
            "provider/oauth/Weibo",
            "provider/oauth/Wechat",
            "provider/oauth/weCom",
            "provider/oauth/Tencent",
            "provider/oauth/DingTalk",
            "provider/oauth/Steam",
            "provider/oauth/gitee",
            "provider/oauth/baidu",
            "provider/oauth/infoflow",
            "provider/oauth/lark",
          ],
        },
        {
          type: "category",
          label: "Email",
          collapsed: true,
          link: {type: "generated-index"},
          items: [
            "provider/email/overview",
            "provider/email/sendgrid",
            "provider/email/azureACS",
            "provider/email/brevo",
            "provider/email/mailhog",
          ],
        },
        {
          type: "category",
          label: "SMS",
          collapsed: true,
          link: {type: "generated-index"},
          items: [
            "provider/sms/overview",
            "provider/sms/twilio",
            "provider/sms/amazonSns",
            "provider/sms/acs",
            "provider/sms/alibabaCloud",
          ],
        },
        {
          type: "category",
          label: "Notification",
          collapsed: true,
          link: {type: "generated-index"},
          items: [
            "provider/notification/overview",
            "provider/notification/telegram",
            "provider/notification/customHttp",
            "provider/notification/slack",
            "provider/notification/googleChat",
            "provider/notification/twitter",
            "provider/notification/discord",
          ],
        },
        {
          type: "category",
          label: "Storage",
          collapsed: true,
          link: {type: "generated-index"},
          items: [
            "provider/storage/overview",
            "provider/storage/localFileSystem",
            "provider/storage/amazon-s3",
            "provider/storage/azure",
            "provider/storage/google-cloudstorage",
            "provider/storage/minio",
            "provider/storage/aliyun-oss",
            "provider/storage/tencentCloudCOS",
            "provider/storage/synology-nas",
          ],
        },
        {
          type: "category",
          label: "SAML",
          collapsed: true,
          link: {type: "generated-index"},
          items: [
            "provider/saml/overview",
            "provider/saml/custom",
            "provider/saml/keycloak",
            "provider/saml/aliyun",
          ],
        },
        {
          type: "category",
          label: "Payment",
          collapsed: true,
          link: {type: "generated-index"},
          items: [
            "provider/payment/overview",
            "provider/payment/paypal",
            "provider/payment/stripe",
            "provider/payment/Alipay",
            "provider/payment/WeChatPay",
          ],
        },
        {
          type: "category",
          label: "Captcha",
          collapsed: true,
          link: {type: "generated-index"},
          items: [
            "provider/captcha/overview",
            "provider/captcha/default",
            "provider/captcha/cloudflareTurnstile",
            "provider/captcha/recaptcha",
            "provider/captcha/hcaptcha",
            "provider/captcha/aliyunCaptcha",
            "provider/captcha/geetest",
          ],
        },
        {
          type: "category",
          label: "Web3",
          collapsed: true,
          link: {type: "generated-index"},
          items: [
            "provider/web3/metamask",
            "provider/web3/web3onboard",
          ],
        },
      ],
    },
    {
      type: "category",
      label: "Resources",
      link: {type: "generated-index"},
      items: [
        "resources/overview",
      ],
    },
    {
      type: "category",
      label: "Products",
      link: {type: "generated-index"},
      items: [
        "products/product",
        "products/payment",
      ],
    },
    {
      type: "category",
      label: "Pricing",
      link: {type: "generated-index"},
      items: [
        "pricing/overview",
        "pricing/plan",
        "pricing/pricing",
        "pricing/subscription",
      ],
    },
    {
      type: "category",
      label: "Users",
      link: {type: "generated-index"},
      items: [
        "user/overview",
        "user/multi-factor-authentication",
        "user/roles",
        "user/permissions",
      ],
    },
    {
      type: "category",
      label: "Invitations",
      link: {type: "generated-index"},
      items: [
        "invitation/overview",
      ],
    },
    {
      type: "category",
      label: "Syncer",
      link: {type: "generated-index"},
      items: [
        "syncer/overview",
        "syncer/Database",
        "syncer/Keycloak",
        "syncer/WeCom",
      ],
    },
    {
      type: "category",
      label: "Tokens",
      link: {type: "generated-index"},
      items: [
        "token/overview",
      ],
    },
    {
      type: "category",
      label: "Webhooks",
      link: {type: "generated-index"},
      items: [
        "webhooks/overview",
      ],
    },
    {
      type: "category",
      label: "LDAP",
      link: {type: "generated-index"},
      items: [
        "ldap/overview",
        "ldap/config",
        "ldap/ldapserver",
      ],
    },
    {
      type: "category",
      label: "RADIUS",
      link: {type: "generated-index"},
      items: [
        "radius/overview",
      ],
    },
    {
      type: "category",
      label: "SCIM",
      link: {type: "generated-index"},
      items: [
        "scim/overview",
      ],
    },
    {
      type: "category",
      label: "Integrations",
      link: {type: "generated-index"},
      items: [
        {
          type: "category",
          label: "C++",
          collapsed: true,
          link: {
            type: "generated-index",
            slug: "/category/cpp",
          },
          items: [
            "integration/C++/Nginx",
            "integration/C++/NginxCommunityVersion",
            "integration/C++/Envoy",
          ],
        },
        {
          type: "category",
          label: "C#",
          collapsed: true,
          link: {
            type: "generated-index",
            slug: "/category/csharp",
          },
          items: [
            "integration/CSharp/Unity",
          ],
        },
        {
          type: "category",
          label: "Go",
          collapsed: true,
          link: {type: "generated-index"},
          items: [
            "integration/go/kubernetes",
            "integration/go/openshift",
            "integration/go/bookstack",
            "integration/go/Bytebase",
            "integration/go/elk",
            "integration/go/gitea",
            "integration/go/grafana",
            "integration/go/minio",
            "integration/go/portainer",
          ],
        },
        {
          type: "category",
          label: "Java",
          collapsed: true,
          link: {type: "generated-index"},
          items: [
            "integration/java/spring-boot",
            "integration/java/spring-cloud",
            "integration/java/spring-cloud-gateway",
            {
              type: "category",
              label: "Spring Security",
              collapsed: true,
              link: {type: "generated-index"},
              items: [
                "integration/java/spring-security/spring-security-oauth",
                "integration/java/spring-security/spring-security-filter",
              ],
            },
            "integration/java/jenkins-plugin",
            "integration/java/jenkins-oidc",
            {
              type: "category",
              label: "Jira",
              collapsed: true,
              link: {type: "generated-index"},
              items: [
                "integration/java/jira2",
                "integration/java/jira",
              ],
            },
            "integration/java/Confluence",
            "integration/java/RuoYi",
            "integration/java/Pulsar-manager",
            "integration/java/shenyu",
            "integration/java/ShardingSphere",
            "integration/java/iotdb",
            "integration/java/dolphinscheduler",
            "integration/java/firezone",
            "integration/java/CloudFoundry",
            "integration/java/Thingsboard",
          ],
        },
        {
          type: "category",
          label: "JavaScript",
          collapsed: true,
          link: {type: "generated-index"},
          items: [
            "integration/javascript/firebase",
            "integration/javascript/wechat_miniprogram",
          ],
        },
        {
          type: "category",
          label: "Lua",
          collapsed: true,
          link: {type: "generated-index"},
          items: [
            "integration/lua/apisix",
          ],
        },
        {
          type: "category",
          label: "PHP",
          collapsed: true,
          link: {type: "generated-index"},
          items: [
            "integration/php/zentao",
            "integration/php/showdoc",
            "integration/php/Flarum",
            "integration/php/Moodle",
          ],
        },
        {
          type: "category",
          label: "Ruby",
          collapsed: true,
          link: {type: "generated-index"},
          items: [
            "integration/ruby/gitlab",
          ],
        },
        {
          type: "category",
          label: "Haskell",
          collapsed: true,
          link: {type: "generated-index"},
          items: [
            "integration/Haskell/Hasura",
          ],
        },
        {
          type: "category",
          label: "Python",
          collapsed: true,
          link: {type: "generated-index"},
          items: [
            "integration/python/JumpServer",
          ],
        },
      ],
    },
    {
      type: "category",
      label: "Monitoring",
      link: {type: "generated-index"},
      items: [
        "monitoring/Web-UI",
        "monitoring/Prometheus",
      ],
    },
    "internationalization",
    "contributing",
  ],
};