TheArchive/zitadel
1
0
Fork 0
mirror of https://github.com/zitadel/zitadel.git synced 2025-07-02 20:08:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore(docs): update docusaurus

Browse Source
This commit is contained in:
Florian Forster 2025-02-26 16:11:55 +01:00
parent 70bddceda8
commit 31b6dad257
No known key found for this signature in database
20 changed files with 4327 additions and 1575 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/babel.config.js
View File

@ -1,4 +0,0 @@
module.exports = {
presets: [require.resolve("@docusaurus/core/lib/babel/preset")],
compact: auto
};

2
docs/docs/apis/benchmarks/_template.mdx
View File

@ -63,7 +63,7 @@ TODO: describe the outcome of the test?
## Endpoint latencies
import OutputSource from "!!raw-loader!./output.json";
import OutputSource from "raw-loader!./output.json";
import { BenchmarkChart } from '/src/components/benchmark_chart';

2
docs/docs/apis/benchmarks/v2.65.0/machine_jwt_profile_grant/index.mdx
View File

@ -34,7 +34,7 @@ Tests are halted after this test run because of too many [client read events](ht
## /token endpoint latencies
import OutputSource from "!!raw-loader!./output.json";
import OutputSource from "./output.json";
import { BenchmarkChart } from '/src/components/benchmark_chart';

2
docs/docs/apis/benchmarks/v2.66.0/machine_jwt_profile_grant/index.mdx
View File

@ -35,7 +35,7 @@ The tests showed heavy database load by time by the first two database queries.
## Endpoint latencies
import OutputSource from "!!raw-loader!./output.json";
import OutputSource from "./output.json";
import { BenchmarkChart } from '/src/components/benchmark_chart';

26
docs/docs/apis/v3.mdx
View File

@ -4,19 +4,19 @@ title: APIs V3 (Preview)
import DocCardList from "@theme/DocCardList";
import CodeBlock from "@theme/CodeBlock";
import ActionServiceProto from "!!raw-loader!./_v3_action_service.proto";
import ActionExecutionProto from "!!raw-loader!./_v3_action_execution.proto";
import ActionTargetProto from "!!raw-loader!./_v3_action_target.proto";
import ActionSearchProto from "!!raw-loader!./_v3_action_search.proto";
import IDPServiceProto from "!!raw-loader!./_v3_idp_service.proto";
import IDPProto from "!!raw-loader!./_v3_idp.proto";
import IDPSearchProto from "!!raw-loader!./_v3_idp_search.proto";
import IDPGitLabProto from "!!raw-loader!./_v3_idp_gitlab.proto";
import LanguageServiceProto from "!!raw-loader!./_v3_language_service.proto";
import LanguageProto from "!!raw-loader!./_v3_language.proto";
import ObjectProto from "!!raw-loader!./_v3_object.proto";
import ResourceObjectProto from "!!raw-loader!./_v3_resource_object.proto";
import SettingsObjectProto from "!!raw-loader!./_v3_settings_object.proto";
import ActionServiceProto from "raw-loader!./_v3_action_service.proto";
import ActionExecutionProto from "raw-loader!./_v3_action_execution.proto";
import ActionTargetProto from "raw-loader!./_v3_action_target.proto";
import ActionSearchProto from "raw-loader!./_v3_action_search.proto";
import IDPServiceProto from "raw-loader!./_v3_idp_service.proto";
import IDPProto from "raw-loader!./_v3_idp.proto";
import IDPSearchProto from "raw-loader!./_v3_idp_search.proto";
import IDPGitLabProto from "raw-loader!./_v3_idp_gitlab.proto";
import LanguageServiceProto from "raw-loader!./_v3_language_service.proto";
import LanguageProto from "raw-loader!./_v3_language.proto";
import ObjectProto from "raw-loader!./_v3_object.proto";
import ResourceObjectProto from "raw-loader!./_v3_resource_object.proto";
import SettingsObjectProto from "raw-loader!./_v3_settings_object.proto";
The APIs described in this section are currently either in _Preview_ stage or not implemented, yet.
Before using these APIs, pleases consider the [API release policy below](#api-release-policy)

4
docs/docs/self-hosting/deploy/compose.mdx
View File

@ -4,8 +4,8 @@ sidebar_label: Docker Compose
---
import CodeBlock from '@theme/CodeBlock';
import DockerComposeSource from '!!raw-loader!./docker-compose.yaml'
import DockerComposeSaSource from '!!raw-loader!./docker-compose-sa.yaml'
import DockerComposeSource from 'raw-loader!./docker-compose.yaml'
import DockerComposeSaSource from 'raw-loader!./docker-compose-sa.yaml'
import Disclaimer from './_disclaimer.mdx'
import DefaultUser from './_defaultuser.mdx'
import Next from './_next.mdx'

10
docs/docs/self-hosting/deploy/loadbalancing-example/loadbalancing-example.mdx
View File

@ -3,11 +3,11 @@ title: A ZITADEL Load Balancing Example
---
import CodeBlock from '@theme/CodeBlock';
import DockerComposeSource from '!!raw-loader!./docker-compose.yaml'
import ExampleTraefikSource from '!!raw-loader!./example-traefik.yaml'
import ExampleZITADELConfigSource from '!!raw-loader!./example-zitadel-config.yaml'
import ExampleZITADELSecretsSource from '!!raw-loader!./example-zitadel-secrets.yaml'
import ExampleZITADELInitStepsSource from '!!raw-loader!./example-zitadel-init-steps.yaml'
import DockerComposeSource from 'raw-loader!./docker-compose.yaml'
import ExampleTraefikSource from 'raw-loader!./example-traefik.yaml'
import ExampleZITADELConfigSource from 'raw-loader!./example-zitadel-config.yaml'
import ExampleZITADELSecretsSource from 'raw-loader!./example-zitadel-secrets.yaml'
import ExampleZITADELInitStepsSource from 'raw-loader!./example-zitadel-init-steps.yaml'
import NoteInstanceNotFound from '../troubleshooting/_note_instance_not_found.mdx';
With this example configuration, you create a near production environment for ZITADEL with [Docker Compose](https://docs.docker.com/compose/).

8
docs/docs/self-hosting/manage/configure/_compose.mdx
View File

@ -1,8 +1,8 @@
import CodeBlock from '@theme/CodeBlock';
import DockerComposeSource from '!!raw-loader!./docker-compose.yaml'
import ExampleZITADELConfigSource from '!!raw-loader!./example-zitadel-config.yaml'
import ExampleZITADELSecretsSource from '!!raw-loader!./example-zitadel-secrets.yaml'
import ExampleZITADELInitStepsSource from '!!raw-loader!./example-zitadel-init-steps.yaml'
import DockerComposeSource from 'raw-loader!./docker-compose.yaml'
import ExampleZITADELConfigSource from 'raw-loader!./example-zitadel-config.yaml'
import ExampleZITADELSecretsSource from 'raw-loader!./example-zitadel-secrets.yaml'
import ExampleZITADELInitStepsSource from 'raw-loader!./example-zitadel-init-steps.yaml'
The docker compose example mounts the example zitadel configuration files to the ZITADEL container.

4
docs/docs/self-hosting/manage/configure/_helm.mdx
View File

@ -1,6 +1,6 @@
import CodeBlock from '@theme/CodeBlock';
import ExampleZITADELValuesSource from '!!raw-loader!./example-zitadel-values.yaml'
import ExampleZITADELValuesSecretsSource from '!!raw-loader!./example-zitadel-values-secrets.yaml'
import ExampleZITADELValuesSource from 'raw-loader!./example-zitadel-values.yaml'
import ExampleZITADELValuesSecretsSource from 'raw-loader!./example-zitadel-values-secrets.yaml'
By default, the chart installs a secure ZITADEL and CockroachDB.
The example files makes an insecure ZITADEL accessible by port forwarding the ZITADEL service to localhost.

6
docs/docs/self-hosting/manage/configure/_linuxunix.mdx
View File

@ -1,7 +1,7 @@
import CodeBlock from '@theme/CodeBlock';
import ExampleZITADELConfigSource from '!!raw-loader!./example-zitadel-config.yaml'
import ExampleZITADELSecretsSource from '!!raw-loader!./example-zitadel-secrets.yaml'
import ExampleZITADELInitStepsSource from '!!raw-loader!./example-zitadel-init-steps.yaml'
import ExampleZITADELConfigSource from 'raw-loader!./example-zitadel-config.yaml'
import ExampleZITADELSecretsSource from 'raw-loader!./example-zitadel-secrets.yaml'
import ExampleZITADELInitStepsSource from 'raw-loader!./example-zitadel-init-steps.yaml'
### Configure by Files

4
docs/docs/self-hosting/manage/configure/configure.mdx
View File

@ -9,8 +9,8 @@ import LinuxUnix from "./_linuxunix.mdx";
import Compose from "./_compose.mdx";
import Helm from "./_helm.mdx";
import CodeBlock from "@theme/CodeBlock";
import DefaultsYamlSource from "!!raw-loader!./defaults.yaml";
import StepsYamlSource from "!!raw-loader!./steps.yaml";
import DefaultsYamlSource from "raw-loader!./defaults.yaml";
import StepsYamlSource from "raw-loader!./steps.yaml";
This guide assumes you are familiar with [running ZITADEL using the least amount of configuration possible](/docs/self-hosting/deploy/overview).

2
docs/docs/self-hosting/manage/reverseproxy/_proxy_guide_overview.mdx
View File

@ -1,5 +1,5 @@
import CodeBlock from '@theme/CodeBlock';
import ComposeYaml from "!!raw-loader!./docker-compose.yaml";
import ComposeYaml from "raw-loader!./docker-compose.yaml";
<>With these examples, you create and run a minimal {props.link} configuration for ZITADEL with <a href="https://docs.docker.com/compose">Docker Compose</a>.
Whereas the guide focuses on the configuration for {props.link}, you can inspect the configurations for ZITADEL and the database in the base Docker Compose file.</>

8
docs/docs/self-hosting/manage/reverseproxy/caddy/caddy.mdx
View File

@ -6,10 +6,10 @@ sidebar_label: Caddy
import ProxyGuideOverview from '../_proxy_guide_overview.mdx';
import ProxyGuideTLSMode from '../_proxy_guide_tls_mode.mdx';
import ProxyGuideMore from '../_proxy_guide_more.mdx';
import Compose from "!!raw-loader!./docker-compose.yaml";
import ConfigDisabled from "!!raw-loader!./disabled-tls.Caddyfile";
import ConfigExternal from "!!raw-loader!./external-tls.Caddyfile";
import ConfigEnabled from "!!raw-loader!./enabled-tls.Caddyfile";
import Compose from "raw-loader!./docker-compose.yaml";
import ConfigDisabled from "raw-loader!./disabled-tls.Caddyfile";
import ConfigExternal from "raw-loader!./external-tls.Caddyfile";
import ConfigEnabled from "raw-loader!./enabled-tls.Caddyfile";
export const providername = 'Caddy';
export const lower = "caddy";

8
docs/docs/self-hosting/manage/reverseproxy/httpd/httpd.mdx
View File

@ -6,10 +6,10 @@ sidebar_label: Apache httpd
import ProxyGuideOverview from '../_proxy_guide_overview.mdx';
import ProxyGuideTLSMode from '../_proxy_guide_tls_mode.mdx';
import ProxyGuideMore from '../_proxy_guide_more.mdx';
import Compose from "!!raw-loader!./docker-compose.yaml";
import ConfigDisabled from "!!raw-loader!./httpd-disabled-tls.conf";
import ConfigExternal from "!!raw-loader!./httpd-external-tls.conf";
import ConfigEnabled from "!!raw-loader!./httpd-enabled-tls.conf";
import Compose from "raw-loader!./docker-compose.yaml";
import ConfigDisabled from "raw-loader!./httpd-disabled-tls.conf";
import ConfigExternal from "raw-loader!./httpd-external-tls.conf";
import ConfigEnabled from "raw-loader!./httpd-enabled-tls.conf";
export const providername = "Apache httpd";
export const lower = "httpd";

8
docs/docs/self-hosting/manage/reverseproxy/nginx/nginx.mdx
View File

@ -6,10 +6,10 @@ sidebar_label: NGINX
import ProxyGuideOverview from '../_proxy_guide_overview.mdx';
import ProxyGuideTLSMode from '../_proxy_guide_tls_mode.mdx';
import ProxyGuideMore from '../_proxy_guide_more.mdx';
import Compose from "!!raw-loader!./docker-compose.yaml";
import ConfigDisabled from "!!raw-loader!./nginx-disabled-tls.conf";
import ConfigExternal from "!!raw-loader!./nginx-external-tls.conf";
import ConfigEnabled from "!!raw-loader!./nginx-enabled-tls.conf";
import Compose from "raw-loader!./docker-compose.yaml";
import ConfigDisabled from "raw-loader!./nginx-disabled-tls.conf";
import ConfigExternal from "raw-loader!./nginx-external-tls.conf";
import ConfigEnabled from "raw-loader!./nginx-enabled-tls.conf";
export const providername = 'NGINX';
export const lower = "nginx";

8
docs/docs/self-hosting/manage/reverseproxy/traefik/traefik.mdx
View File

@ -6,10 +6,10 @@ sidebar_label: Traefik
import ProxyGuideOverview from '../_proxy_guide_overview.mdx';
import ProxyGuideTLSMode from '../_proxy_guide_tls_mode.mdx';
import ProxyGuideMore from '../_proxy_guide_more.mdx';
import Compose from "!!raw-loader!./docker-compose.yaml";
import ConfigDisabled from "!!raw-loader!./traefik-disabled-tls.yaml";
import ConfigExternal from "!!raw-loader!./traefik-external-tls.yaml";
import ConfigEnabled from "!!raw-loader!./traefik-enabled-tls.yaml";
import Compose from "raw-loader!./docker-compose.yaml";
import ConfigDisabled from "raw-loader!./traefik-disabled-tls.yaml";
import ConfigExternal from "raw-loader!./traefik-external-tls.yaml";
import ConfigEnabled from "raw-loader!./traefik-enabled-tls.yaml";
export const providername = 'Traefik';
export const lower = "traefik";

40
docs/docusaurus.config.js
View File

@ -201,28 +201,6 @@ module.exports = {
runmeLinkLabel: 'Checkout via Runme'
},
},
webpack: {
jsLoader: (isServer) => ({
loader: require.resolve('swc-loader'),
options: {
jsc: {
parser: {
syntax: 'typescript',
tsx: true,
},
transform: {
react: {
runtime: 'automatic',
},
},
target: 'es2017',
},
module: {
type: isServer ? 'commonjs' : 'es6',
},
},
}),
},
presets: [
[
"classic",
@ -234,8 +212,7 @@ module.exports = {
showLastUpdateAuthor: true,
showLastUpdateTime: true,
editUrl: "https://github.com/zitadel/zitadel/edit/main/docs/",
remarkPlugins: [require("mdx-mermaid")],
remarkPlugins: [require("mdx-mermaid")],
docItemComponent: '@theme/ApiItem'
},
theme: {
@ -380,5 +357,18 @@ module.exports = {
};
},
],
themes: [ "docusaurus-theme-github-codeblock", "docusaurus-theme-openapi-docs"],
markdown: {
mermaid: true,
},
themes: [ "docusaurus-theme-github-codeblock", "docusaurus-theme-openapi-docs", "@docusaurus/theme-mermaid"],
future: {
experimental_faster: {
swcJsLoader: false,
swcJsMinimizer: false,
swcHtmlMinimizer: false,
lightningCssMinimizer: false,
rspackBundler: true,
mdxCrossCompilerCache: false,
},
},
};

50
docs/package.json
View File

@ -6,7 +6,8 @@
"docusaurus": "docusaurus",
"start": "docusaurus start",
"start:api": "yarn run generate && docusaurus start",
"build": "yarn run generate && NODE_OPTIONS=--max-old-space-size=8192 docusaurus build",
"justbuild": "NODE_OPTIONS=--max-old-space-size=8192 docusaurus build",
"build": "yarn run generate && NODE_OPTIONS=--max-old-space-size=8192 docusaurus build",
"swizzle": "docusaurus swizzle",
"deploy": "docusaurus deploy",
"clear": "docusaurus clear",
@ -21,33 +22,30 @@
"generate:clean-all": "docusaurus clean-api-docs all"
},
"dependencies": {
"@bufbuild/buf": "^1.14.0",
"@docusaurus/core": "3.4.0",
"@docusaurus/preset-classic": "3.4.0",
"@docusaurus/theme-mermaid": "3.4.0",
"@docusaurus/theme-search-algolia": "3.4.0",
"@headlessui/react": "^1.7.4",
"@bufbuild/buf": "^1.49.0",
"@docusaurus/core": "^3.7.0",
"@docusaurus/faster": "^3.7.0",
"@docusaurus/plugin-sitemap": "^3.7.0",
"@docusaurus/preset-classic": "^3.7.0",
"@docusaurus/theme-mermaid": "^3.7.0",
"@docusaurus/theme-search-algolia": "^3.7.0",
"@headlessui/react": "^2.2.0",
"@heroicons/react": "^2.0.13",
"@mdx-js/react": "^3.0.0",
"@swc/core": "^1.3.74",
"autoprefixer": "^10.4.13",
"clsx": "^1.2.1",
"docusaurus-plugin-image-zoom": "^1.0.1",
"docusaurus-plugin-openapi-docs": "3.0.1",
"autoprefixer": "^10.4.20",
"clsx": "^2.0.0",
"docusaurus-plugin-image-zoom": "^2.0.0",
"docusaurus-plugin-openapi-docs": "^4.3.5",
"docusaurus-theme-github-codeblock": "^2.0.2",
"docusaurus-theme-openapi-docs": "3.0.1",
"mdx-mermaid": "^2.0.0",
"mermaid": "^10.9.1",
"postcss": "^8.4.31",
"prism-react-renderer": "^2.1.0",
"docusaurus-theme-openapi-docs": "^4.3.5",
"mdx-mermaid": "^2.0.3",
"postcss": "^8.4.49",
"prism-react-renderer": "^2.3.0",
"raw-loader": "^4.0.2",
"react": "^18.2.0",
"react": "^18.0.0",
"react-copy-to-clipboard": "^5.1.0",
"react-dom": "^18.2.0",
"react-dom": "^18.0.0",
"react-google-charts": "^5.2.1",
"react-player": "^2.15.1",
"sitemap": "7.1.1",
"swc-loader": "^0.2.3",
"react-player": "^2.16.0",
"wait-on": "6.0.1"
},
"browserslist": {
@ -63,9 +61,9 @@
]
},
"devDependencies": {
"@docusaurus/module-type-aliases": "3.4.0",
"@docusaurus/types": "3.4.0",
"tailwindcss": "^3.2.4"
"@docusaurus/module-type-aliases": "^3.7.0",
"@docusaurus/types": "^3.7.0",
"tailwindcss": "^3.4.17"
},
"packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"
}

34
docs/src/components/benchmark_chart.jsx
View File

@ -1,45 +1,45 @@
import React from "react";
import Chart from "react-google-charts";
import { Chart } from "react-google-charts";
export function BenchmarkChart(testResults=[], height='500px') {
export function BenchmarkChart({ testResults = [], height = '500px' }) {
if (!Array.isArray(testResults)) {
console.error("Invalid testResults data:", testResults);
testResults = [];
}
const options = {
legend: { position: 'bottom' },
focusTarget: 'category',
hAxis: {
title: 'timestamp',
},
vAxis: {
title: 'latency (ms)',
},
hAxis: { title: 'timestamp' },
vAxis: { title: 'latency (ms)' },
};
const data = [
[
{type:"datetime", label: "timestamp"},
{type:"number", label: "p50"},
{type:"number", label: "p95"},
{type:"number", label: "p99"},
{ type: "datetime", label: "timestamp" },
{ type: "number", label: "p50" },
{ type: "number", label: "p95" },
{ type: "number", label: "p99" },
],
]
];
JSON.parse(testResults.testResults).forEach((result) => {
testResults.forEach((result) => {
data.push([
new Date(result.timestamp),
result.p50,
result.p95,
result.p99,
])
]);
});
return (
<Chart
chartType="LineChart"
width="100%"
height="500px"
height={height}
options={options}
data={data}
legendToggle
/>
);
);
}

5672
docs/yarn.lock
View File

File diff suppressed because it is too large Load Diff