zitadel/docs
Silvan d3bb9c9b3b
fix(setup): init projections (#7194)
Even though this is a feature it's released as fix so that we can back port to earlier revisions.

As reported by multiple users startup of ZITADEL after leaded to downtime and worst case rollbacks to the previously deployed version.

The problem starts rising when there are too many events to process after the start of ZITADEL. The root cause are changes on projections (database tables) which must be recomputed. This PR solves this problem by adding a new step to the setup phase which prefills the projections. The step can be enabled by adding the `--init-projections`-flag to `setup`, `start-from-init` and `start-from-setup`. Setting this flag results in potentially longer duration of the setup phase but reduces the risk of the problems mentioned in the paragraph above.

(cherry picked from commit 17953e9040)
2024-01-26 07:41:11 +01:00
..
apis/assets ci: improve performance (#5953) 2023-07-17 10:08:20 +02:00
docs fix(setup): init projections (#7194) 2024-01-26 07:41:11 +01:00
src docs(legal): update legal framework and policies (November 2023) (#6611) 2023-11-16 09:26:25 +00:00
static docs: add guide for Vue (#7215) 2024-01-16 14:21:32 +00:00
.gitignore docs: copy config options to docs (#6143) 2023-08-07 22:32:10 +02:00
babel.config.js docs: improve api docs (#5158) 2023-02-23 18:08:06 +07:00
buf.gen.yaml docs: improve api docs (#5158) 2023-02-23 18:08:06 +07:00
Dockerfile docs: improve api docs (#5158) 2023-02-23 18:08:06 +07:00
docusaurus.config.js docs(examples): adds java spring boot examples (#7226) 2024-01-16 11:02:58 +00:00
nginx.conf docs(nginx): fix nginx directory, system api proto description (#5809) 2023-05-15 07:23:56 +00:00
package.json chore(npm): dependencies (#7141) 2024-01-08 10:25:21 +00:00
README.md docs: Add reference to Actions for custom claims and custom attributes (#7204) 2024-01-11 15:27:37 +01:00
sidebars.js docs: add guide for Vue (#7215) 2024-01-16 14:21:32 +00:00
tailwind.config.js docs: add tailwindcss for styles, oidc authorize endpoint playground (#4707) 2022-12-05 18:36:12 +01:00
vercel.json chore: redirect api path (#6232) 2023-07-19 00:15:41 +02:00
yarn.lock chore(npm): dependencies (#7141) 2024-01-08 10:25:21 +00:00

ZITADEL-Docs

This website is built using Docusaurus 2, a modern static website generator.

Add new Sites to existing Topics

To add a new site to the already existing structure simply save the md file into the corresponding folder and append the sites id int the file sidebars.js.

Installation

Install dependencies with

yarn install

then run

yarn generate

Local Development

Start a local development server with

yarn start

When working on the API docs, run a local development server with

yarn start:api

Container Image

If you just want to start docusaurus locally without installing node you can fallback to our container image. Execute the following commands from the repository root to build and start a local version of ZITADEL

docker build -f docs/Dockerfile . -t zitadel-docs
docker run -p 8080:8080 zitadel-docs