zitadel/docs/sidebars.js

288 lines
8.7 KiB
JavaScript
Raw Normal View History

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: 'Get to know ZITADEL',
collapsed: false,
items: [
'guides/basics/get-started',
'guides/basics/organizations',
'guides/basics/projects',
],
},
{
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',
],
},
{
type: 'category',
label: 'Installation',
collapsed: false,
items: [
{
type: 'category',
label: 'CAOS Managed',
collapsed: true,
items: [
'guides/installation/shared-cloud',
'guides/installation/managed-dedicated-instance'
],
},
{
type: 'category',
label: 'CAOS Service Packages',
collapsed: true,
items: [
'guides/installation/setup',
'guides/installation/setup-orbos',
'guides/installation/checkup'
],
},
{
type: 'category',
label: 'Self Managed',
collapsed: true,
items: [
'guides/installation/crd',
'guides/installation/gitops',
'guides/installation/orbos'
],
},
],
},
{
type: 'category',
label: 'Trainings',
collapsed: false,
items: [
'guides/trainings/introduction',
{
type: 'category',
label: 'Support Service',
collapsed: true,
items: [
'guides/trainings/supportservice/operations',
'guides/trainings/supportservice/application',
'guides/trainings/supportservice/recurring',
],
},
],
}
],
apis: [
'apis/introduction',
{
type: 'category',
label: 'API Definition',
2021-11-19 11:31:59 +01:00
collapsed: false,
items: [
{
type: 'category',
label: 'Proto',
collapsed: true,
items: [
'apis/proto/auth',
'apis/proto/management',
'apis/proto/admin',
'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/object',
'apis/proto/options'
],
},
{
type: 'category',
label: 'Assets API',
collapsed: true,
items: [
'apis/assets/assets',
],
},
],
},
{
type: 'category',
label: 'OpenID Connect & OAuth',
2021-11-19 11:31:59 +01:00
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',
2021-11-19 11:31:59 +01:00
collapsed: false,
items: [
'legal/rate-limit-policy',
'apis/ratelimits/accounts',
'apis/ratelimits/api',
],
},
],
concepts: [
'concepts/introduction',
{
type: 'category',
label: 'ZITADEL',
2021-11-19 11:31:59 +01:00
collapsed: false,
items: [
'concepts/zitadel/architecture',
{
type: 'category',
label: "Object Overview",
collapsed: false,
items: [
'concepts/zitadel/objects/overview',
'concepts/zitadel/objects/organizations',
'concepts/zitadel/objects/policies',
'concepts/zitadel/objects/projects',
'concepts/zitadel/objects/applications',
'concepts/zitadel/objects/granted_projects',
'concepts/zitadel/objects/users',
'concepts/zitadel/objects/managers',
],
},
],
}, {
type: 'category',
label: 'General',
2021-11-19 11:31:59 +01:00
collapsed: false,
items: [
'concepts/general/principles',
'concepts/general/eventstore',
],
},
{
type: 'category',
label: 'Use Cases',
2021-11-19 11:31:59 +01:00
collapsed: false,
items: [
'concepts/usecases/saas'
],
},
],
manuals: [
'manuals/introduction',
{
type: 'category',
label: 'User',
items: ['manuals/user-register', 'manuals/user-login', 'manuals/user-passwordless', 'manuals/user-password', 'manuals/user-factors', 'manuals/user-email', 'manuals/user-phone', 'manuals/user-social-login',],
collapsed: false,
},
],
legal: [
'legal/introduction',
'legal/terms-of-service',
'legal/data-processing-agreement',
{
type: 'category',
label: 'Service Descriptions',
collapsed: false,
items: [
'legal/service-level-description',
'legal/support-services',
],
},
{
type: 'category',
label: 'Dedicated Instance',
collapsed: false,
items: [
'legal/terms-of-service-dedicated',
'legal/dedicated-instance-annex',
],
},
{
type: 'category',
label: 'Support Program',
collapsed: false,
items: [
'legal/terms-support-service'
],
},
{
type: 'category',
label: 'Policies',
collapsed: false,
items: [
'legal/privacy-policy',
'legal/acceptable-use-policy',
'legal/rate-limit-policy'
],
}
],
feat(operator): make running ZITADEL easy (#1562) * docs: describe crd mode * docs: fix links * docs: fix commands and crdb resources * feat: add configure command * chore: use latest ORBOS * chore: use latest ORBOS * docs: start gitops docs * fix: compile * chore: fix build script path * chore: remove redundant prebuild * chore: add configure.go * docs: describe gitops mode * docs: point template links to main branch * docs: fix versions * feat: initialize empty keys * feat: reconfigure running ZITADEL * docs: describe crd mode * docs: fix links * docs: fix commands and crdb resources * feat: add configure command * chore: use latest ORBOS * chore: use latest ORBOS * docs: start gitops docs * fix: compile * chore: fix build script path * chore: remove redundant prebuild * chore: add configure.go * docs: describe gitops mode * docs: point template links to main branch * docs: fix versions * feat: initialize empty keys * feat: reconfigure running ZITADEL * test: fix * docs: keys are generated with configure * docs: remove keys from template * chore: pass compile time data * chore: use latest ORBOS * fix: when in-cluster, use in-cluster k8s client * fix: try in-cluster config if kubeconfig is empty * fix: reduce unneeded side effects for configure command * docs: boom version * chore: use latest ORBOS * chore: use latest ORBOS * initial commit * inital changes * commit WIP Information Architecture * commit a working state * add static assets and project * add org and fix img names * add plausible * remove img * change sidebar to easier mgmt * add openid oauth and domains * lint md * quickstarts * add auth flow * identity brokering * remove site * fix broken links * extend footer * extend readme * fix: styling * fix: zitadel logo on index * styling * border * fix: nav * fix: nav * fix: index * fix: corrected zitadelctl examples * fix: rename architecture to concepts * fix: introductions * fix: introductions * fix: introductions * docs: cli r/w secrets examples * docs: finish ZITADEL Enterprise Cloud * docs: mention ZITADEL Enterprise Cloud tier * docs: comment configuration options * docs: fix broken links * docs: move some introduction texts around * docs: twilio and email are mandatory * docs: download latest binaries Co-authored-by: Florian Forster <florian@caos.ch> Co-authored-by: fabi <fabienne.gerschwiler@gmail.com> Co-authored-by: Livio Amstutz <livio.a@gmail.com> Co-authored-by: Stefan Benz <stefan@caos.ch>
2021-04-22 18:43:34 +02:00
};