mirror of
https://github.com/andwati/zitadel.git
synced 2026-10-18 05:52:51 +00:00
d8ea041c56
## Todos for release - [x] Configure Env in docs project on vercel - [x] Configure Root Path in the docs project on vercel - [ ] Remove old CSP https://github.com/zitadel/website/pull/1592 ## What we did This pull request migrates the project documentation from the old `docs/` directory to the new `apps/docs/` directory, introduces a new documentation system built with Next.js and Fumadocs, and updates all relevant references, configuration files, and documentation to reflect this change. It also adds new configuration and ignore files for the new documentation app, updates CI and linting to exclude the new docs from certain checks, and revises the contributing guidelines accordingly. **Documentation System Migration and New Docs App** * Migrated all documentation from `docs/` to `apps/docs/`, and updated all references in `README.md`, `CONTRIBUTING.md`, and other files to point to the new location. [[1]](diffhunk://#diff-eca12c0a30e25b4b46522ebf89465a03ba72a03f540796c979137931d8f92055L585-L640) [[2]](diffhunk://#diff-eca12c0a30e25b4b46522ebf89465a03ba72a03f540796c979137931d8f92055L660-R607) [[3]](diffhunk://#diff-eca12c0a30e25b4b46522ebf89465a03ba72a03f540796c979137931d8f92055L740-R687) [[4]](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L2-R3) [[5]](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L30-R30) * Added a new Next.js/Fumadocs-based documentation app under `apps/docs/`, including core app files, layouts, routing, search API, and a comprehensive `README.md` with development and contribution instructions. [[1]](diffhunk://#diff-5a1b07344a2c1b4d3f37b23ff1388b62cd9f57dea3c1cd23d8a0412b7602b132R1-R74) [[2]](diffhunk://#diff-462b9ad1eabbb7d1c29bb9c36e4931eb180fd7190900e6d2babf8f4d66ad1c28R1-R39) [[3]](diffhunk://#diff-e16ae25660ded787b10ac35dea96d5ecaacf895dae0afc8a9bd4382dc79a8c87R1-R7) [apps/docs/app/[[...slug]]/layout.tsxR1-R81](diffhunk://#diff-59e08acde4e805b7aeccef1dcf98f1d71dfc550777e6b9402085cee0e9fa4e0aR1-R81), [apps/docs/app/[[...slug]]/page.tsxR1-R79](diffhunk://#diff-e5df3f80d0fa01e12d63d81f29c57a9d14e846c78fd3beabb2ef768e38fd9580R1-R79), [[4]](diffhunk://#diff-389b34918e040cacaa87cd7201ffa462cc2b0b716736f537e3d3c660ac69353bR1-R7) [[5]](diffhunk://#diff-d3b03416d1c457b19f1c27b26f2db741412df841b875c26ccadc36e4522247f4R1-R29) [[6]](diffhunk://#diff-c8fb8339570a5305809be7c618e14705fd86390dc278e6ce8ba224a7bc8b0c3cR1-R25) **Configuration and Tooling Updates** * Updated `.github/workflows/codeql.yml`, `.golangci.yaml`, and `.github/dependabot.yml` to properly handle the new docs app: excluded `apps/docs` from certain checks, added npm dependency updates for the docs app, and excluded generated content. [[1]](diffhunk://#diff-12783128521e452af0cfac94b99b8d250413c516ec71fe6d97dbea666ff7ba27L8-R14) [[2]](diffhunk://#diff-9917ddc9f1c3304218f7269265b746d997c5c0615478177b5fceecd33ef47cb5R5-R6) [[3]](diffhunk://#diff-9917ddc9f1c3304218f7269265b746d997c5c0615478177b5fceecd33ef47cb5R126-R129) [[4]](diffhunk://#diff-dd4fbda47e51f1e35defb9275a9cd9c212ecde0b870cba89ddaaae65c5f3cd28R89-R106) * Updated `.devcontainer/devcontainer.json` to use the latest Go 1.25.3 version for consistency. **Licensing and Miscellaneous** * Added `apps/docs/` to the list of licensed directories in `LICENSING.md`. These changes ensure the documentation is now maintained in a modern, scalable system and all project tooling is updated to support the new structure. --------- Co-authored-by: Federico Coppede <[email protected]>
65 lines
3.9 KiB
Plaintext
65 lines
3.9 KiB
Plaintext
---
|
|
title: ZITADEL Actions v2
|
|
sidebar_label: Actions v2
|
|
---
|
|
|
|
By using ZITADEL Actions v2, you can modify ZITADEL's behavior on specific API calls, events, or functions. This is useful when you have special business requirements that ZITADEL does not support out-of-the-box.
|
|
|
|
<Callout>
|
|
We're working on Actions continuously. In the [roadmap](https://zitadel.com/roadmap), you can see how we plan to expand and improve this feature. Please tell us about your needs to help us prioritize further improvements and features.
|
|
</Callout>
|
|
|
|
<Callout>
|
|
To use Actions v2, activate the "Actions" [feature flag](/reference/api/feature/zitadel.feature.v2.FeatureService.SetInstanceFeatures) in order to manage the related resources.
|
|
|
|
Actions v2 will always be executed if available, even if the feature flag is switched off. To remove any Actions v2, the related Execution must be removed.
|
|
</Callout>
|
|
|
|
## Why Actions?
|
|
ZITADEL can't anticipate or solve every possible business rule and integration requirement for all users. Here are some examples:
|
|
- A business requires domain-specific data validation before a user can be created or authenticated.
|
|
- A business needs to automate tasks, such as assigning roles to users based on their ADFS 2016+ groups.
|
|
- A business needs to store metadata on a user, which is used for integrating applications.
|
|
- A business needs to restrict which users are allowed to register to a certain organization by their email domains.
|
|
|
|
With Actions, ZITADEL provides a way to address such scenarios.
|
|
|
|
## How it works
|
|
There are three necessary components:
|
|
- **Endpoint:** An external endpoint with the desired logic. It can be anything, as long as it can receive an HTTP POST request.
|
|
- **Target:** A resource in ZITADEL containing all the necessary information about how to trigger an endpoint.
|
|
- **Execution:** A resource in ZITADEL specifying when to trigger which targets.
|
|
|
|
The process is that, at certain points, ZITADEL executes a defined Execution, which then calls the defined Target(s). This allows everyone to implement custom behavior for as many processes as needed.
|
|
|
|
Possible conditions for the Execution:
|
|
- **Request:** Reacts to or manipulates requests to ZITADEL, for example, by adding information to newly created users.
|
|
- **Response:** Reacts to or manipulates responses from ZITADEL, for example, provisioning newly created users to other systems.
|
|
- **Function:** Reacts to various functions in ZITADEL, replacing [Actions](/concepts/features/actions).
|
|
- **Event:** Reacts to different events created in ZITADEL, for example, to inform someone if a user gets locked.
|
|
|
|
<Callout>
|
|
Currently, defined Actions v2 will be executed in addition to [Actions](/concepts/features/actions).
|
|
</Callout>
|
|
|
|
## Migration
|
|
|
|
- [Migrate Actions v1 to Actions v2](/guides/integrate/actions/migrate-from-v1)
|
|
|
|
## Further reading
|
|
|
|
- [Actions v2 reference](/guides/integrate/actions/usage)
|
|
- [Actions v2 example execution for request](/guides/integrate/actions/testing-request)
|
|
- [Actions v2 example execution for request manipulation](/guides/integrate/actions/testing-request-manipulation)
|
|
- [Actions v2 example execution for request signature check](/guides/integrate/actions/testing-request-signature)
|
|
- [Actions v2 example execution for response](/guides/integrate/actions/testing-response)
|
|
- [Actions v2 example execution for response manipulation](/guides/integrate/actions/testing-response-manipulation)
|
|
- [Actions v2 example execution for function](/guides/integrate/actions/testing-function)
|
|
- [Actions v2 example execution for function manipulation](/guides/integrate/actions/testing-function-manipulation)
|
|
- [Actions v2 example execution for event](/guides/integrate/actions/testing-event)
|
|
|
|
## Example use cases:
|
|
The following repository contains various examples demonstrating how to use Actions v2 in different scenarios. It also includes a deployment script for testing the examples with Cloudflare Workers:
|
|
|
|
- [Actions v2 examples](https://github.com/zitadel/actions/tree/main/actions-v2-cloudflare-workers)
|