zitadel/docs
Tim Möhlmann 83bdaf43c3
docs(events-api): user auth example using OIDC session events (#9020)
# Which Problems Are Solved

Integration guide with event API examples used outdated
`user.token.added` events which are no longer produced by ZITADEL.

# How the Problems Are Solved

Modify the example to use events from the `oidc_session` aggregate.

# Additional Changes

- Add a TODO for related SAML events.

# Additional Context

- Related to https://github.com/zitadel/zitadel/issues/8983
2024-12-10 10:54:07 +00:00
..
apis/assets ci: improve performance (#5953) 2023-07-17 10:08:20 +02:00
docs docs(events-api): user auth example using OIDC session events (#9020) 2024-12-10 10:54:07 +00:00
src docs: init benchmarks (#8894) 2024-11-15 23:44:22 +02:00
static docs: init benchmarks (#8894) 2024-11-15 23:44:22 +02:00
.gitignore chore(docs): use gh action to build docs (#8097) 2024-06-13 08:07:39 +00:00
babel.config.js chore(docs): use gh action to build docs (#8097) 2024-06-13 08:07:39 +00:00
buf.gen.yaml chore(api): initial definition of API for user schemas (user v3 and user schema v3 service) (#7372) 2024-02-15 11:22:48 +01:00
docusaurus.config.js docs(v2): fix duplicate section of user, session, oidc and settings services (#8889) 2024-11-12 14:14:17 +00:00
frameworks.json docs: add pylon framework to examples (#8115) 2024-06-17 07:37:07 +00:00
package.json feat: action v2 signing (#8779) 2024-11-28 10:06:52 +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 caches documentation (#8902) 2024-11-19 10:56:10 +01:00
tailwind.config.js docs: add tailwindcss for styles, oidc authorize endpoint playground (#4707) 2022-12-05 18:36:12 +01:00
vercel.json docs: reorganize actions v3 docs (#8712) 2024-10-03 16:26:05 +00:00
yarn.lock chore(deps): bump cross-spawn from 7.0.3 to 7.0.6 in /docs (#8925) 2024-11-25 08:30:09 +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