zitadel/docs/sidebars.js
Elio Bischof 6dd4af01bf
docs(installation): improve guides (#3817)
* split config descriptions

* install and configure

* custom domains

* typo

* remove comments

* try compose with secure crdb

* secure crdb with compose

* describe ExternalSecure restriction

* add near production example

* add login credentials

* fix configure compose

* make the docs more transparent

* name archive amd64

* Revert "name archive amd64"

This reverts commit 0d4dae551b.

* fix download url

* extract archives

* fix dawin download

* fix start zitadel commands

* add helm installation docs

* remove windows

* make downloaded files description friendlier

* link to github raw

* link login process

* remove healthcheck from compose

* remove compose healthchecks

* use --tlsMode external for lb example

* uname -i

* disable tls mode locally

* Update docs/docs/guides/installation/get-started/macos.mdx

Co-authored-by: Fabi <38692350+hifabienne@users.noreply.github.com>

Co-authored-by: Fabi <38692350+hifabienne@users.noreply.github.com>
2022-06-28 13:36:59 +02:00

276 lines
6.7 KiB
JavaScript

module.exports = {
quickstarts: [
"quickstarts/introduction",
{
type: "category",
label: "Integrate ZITADEL Login in your App",
items: [
"quickstarts/login/angular",
"quickstarts/login/react",
"quickstarts/login/flutter",
"quickstarts/login/nextjs",
],
collapsed: false,
},
{
type: "category",
label: "Secure your API",
items: ["quickstarts/secure-api/go", "quickstarts/secure-api/dot-net"],
collapsed: false,
},
{
type: "category",
label: "Call the ZITADEL API",
items: [
"quickstarts/call-zitadel-api/go",
"quickstarts/call-zitadel-api/dot-net",
],
collapsed: false,
},
{
type: "category",
label: "Identity Aware Proxy",
items: ["quickstarts/identity-proxy/oauth2-proxy"],
collapsed: false,
},
],
guides: [
"guides/overview",
{
type: "category",
label: "Install ZITADEL",
collapsed: false,
items: [
"guides/installation/get-started/get-started",
"guides/installation/configure/configure",
"guides/installation/custom-domain",
"guides/installation/http2-support",
"guides/installation/loadbalancing-example/loadbalancing-example",
],
},
{
type: "category",
label: "Get to know ZITADEL",
collapsed: false,
items: [
"guides/basics/get-started",
"guides/basics/instance",
"guides/basics/organizations",
"guides/basics/projects",
"guides/basics/applications",
],
},
{
type: "category",
label: "Integrations",
collapsed: false,
items: [
"guides/integrations/authenticated-mongodb-charts",
"guides/integrations/auth0",
"guides/integrations/gitlab-self-hosted",
],
},
{
type: "category",
label: "Solution Scenarios",
collapsed: false,
items: [
"guides/solution-scenarios/introduction",
"guides/solution-scenarios/b2c",
"guides/solution-scenarios/b2b",
],
},
{
type: "category",
label: "Authentication",
collapsed: false,
items: [
"guides/authentication/login-users",
"guides/authentication/identity-brokering",
"guides/authentication/serviceusers",
],
},
{
type: "category",
label: "Authorization",
collapsed: false,
items: ["guides/authorization/oauth-recommended-flows"],
},
{
type: "category",
label: "API",
collapsed: false,
items: ["guides/api/access-zitadel-apis"],
},
{
type: "category",
label: "Customization",
collapsed: false,
items: [
"guides/customization/branding",
"guides/customization/texts",
"guides/customization/behavior"
],
},
{
type: "category",
label: "Trainings",
collapsed: true,
items: [
"guides/trainings/introduction",
"guides/trainings/application",
"guides/trainings/recurring"
],
},
],
apis: [
"apis/introduction",
{
type: "category",
label: "API Definition",
collapsed: false,
items: [
"apis/statuscodes",
{
type: "category",
label: "Proto",
collapsed: true,
items: [
"apis/proto/auth",
"apis/proto/management",
"apis/proto/admin",
"apis/proto/system",
"apis/proto/instance",
"apis/proto/org",
"apis/proto/user",
"apis/proto/app",
"apis/proto/policy",
"apis/proto/auth_n_key",
"apis/proto/change",
"apis/proto/idp",
"apis/proto/member",
"apis/proto/metadata",
"apis/proto/message",
"apis/proto/text",
"apis/proto/action",
"apis/proto/object",
"apis/proto/options",
],
},
{
type: "category",
label: "Assets API",
collapsed: true,
items: ["apis/assets/assets"],
},
"apis/actions"
],
},
{
type: "category",
label: "OpenID Connect & OAuth",
collapsed: false,
items: [
"apis/openidoauth/endpoints",
"apis/openidoauth/scopes",
"apis/openidoauth/claims",
"apis/openidoauth/authn-methods",
"apis/openidoauth/grant-types",
],
},
{
type: "category",
label: "Rate Limits",
collapsed: false,
items: [
"legal/rate-limit-policy",
"apis/ratelimits/accounts",
"apis/ratelimits/api",
],
},
],
concepts: [
"concepts/introduction",
"concepts/principles",
"concepts/eventstore",
"concepts/architecture",
{
type: "category",
label: "Structure",
collapsed: false,
items: [
"concepts/structure/overview",
"concepts/structure/instance",
"concepts/structure/organizations",
"concepts/structure/policies",
"concepts/structure/projects",
"concepts/structure/applications",
"concepts/structure/granted_projects",
"concepts/structure/users",
"concepts/structure/managers",
],
},
{
type: "category",
label: "Use Cases",
collapsed: false,
items: ["concepts/usecases/saas"],
},
{
type: "category",
label: "Features",
collapsed: false,
items: ["concepts/features/actions"],
},
],
manuals: [
"manuals/introduction",
"manuals/user-profile",
"manuals/user-login",
{
type: "category",
label: "Customer Portal",
collapsed: true,
items: [
"manuals/customerportal/overview",
"manuals/customerportal/start",
"manuals/customerportal/instances",
"manuals/customerportal/billing",
"manuals/customerportal/users",
"manuals/customerportal/support",
],
},
"manuals/troubleshooting",
],
legal: [
"legal/introduction",
"legal/terms-of-service",
"legal/data-processing-agreement",
{
type: "category",
label: "Service Description",
collapsed: false,
items: ["legal/cloud-service-description", "legal/service-level-description", "legal/support-services"],
},
{
type: "category",
label: "Additional terms",
collapsed: true,
items: [
"legal/terms-support-service",
"legal/terms-of-service-dedicated",
],
},
{
type: "category",
label: "Policies",
collapsed: false,
items: [
"legal/privacy-policy",
"legal/acceptable-use-policy",
"legal/rate-limit-policy",
],
},
],
};