mirror of
https://github.com/andwati/zitadel.git
synced 2026-10-25 00:32:15 +00:00
## 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]>
82 lines
4.4 KiB
Plaintext
82 lines
4.4 KiB
Plaintext
---
|
|
title: Prevent users from accessing ZITADEL Management Console
|
|
sidebar_label: Limit access to management console
|
|
---
|
|
|
|
ZITADEL includes a management console that allows Managers to configure all resources. All uses, including end-users, by default, view and manage their profile information.
|
|
In some use cases you want to prevent users from accessing the management console, this could be:
|
|
- User management is integrated into your own app
|
|
- Users login via SSO and should not be able to change their data in the Management Console
|
|
- Only managers should be able to access Management Console to manage their users
|
|
|
|
At the moment it is not possible to simply disable the Management Console, but with the configuration described in this guide, you can prevent users from accessing the Console.
|
|
|
|
## Self-hosted
|
|
|
|
If you are running ZITADEL self-hosted, we recommend restricting the access to ZITADEL Management Console via WAF/reverse-proxy for Non-Manager users
|
|
|
|
## ZITADEL Cloud (and self-hosted)
|
|
|
|
### Default redirect url
|
|
|
|
One goal is to never send the end user to the ZITADEL management console.
|
|
This does make sense if you build your own user profile page within your application.
|
|
In that case you probably want to redirect the user to your own application, instead of to the console.
|
|
|
|
Read more about how to set the default redirect URI: [Settings - Default Redirect URI](/guides/manage/console/default-settings#default-redirect-uri)
|
|
|
|
### Restricting Management Console in default-project
|
|
|
|
With this workaround, you will limit users from accessing the [default-project](/guides/manage/console/projects-overview#the-default-project) if they are not explicitly granted to use this project.
|
|
When setting the "Check for Project on Authentication" setting on a project, only users of organizations with a grant to that project can access it.
|
|
By default, this setting is disabled, so all users can access the project.
|
|
|
|

|
|
|
|
Start by granting the organization of your managers, that should be able to access the Management Console, the [default project](/guides/manage/console/projects-overview#the-default-project):
|
|
|
|
1. Click on the default-project > Grants > New +
|
|

|
|
|
|
2. On the next screen select the organization to which you want to give the grant
|
|

|
|
|
|
3. You can skip the screen with the role selection and click save
|
|
4. Make sure the grant is in now in the overview and marked as active.
|
|
|
|
To avoid accidental lock-out, the [default project](/guides/manage/console/projects-overview#the-default-project) hides the checkbox "Check Project on Authentication" in the Management Console:
|
|

|
|
|
|
You need to use the [update project API call](/reference/api/management/zitadel.management.v1.ManagementService.UpdateProject) to set the configuration on the project.
|
|
|
|
First, you need a user with manager permissions to change the project settings in that organization.
|
|
This means either you add the manager to the organization or you use a manager on the instance level with "IAM-OWNER" permissions.
|
|
After that create a Personal Access Token (PAT) for the manager.
|
|
|
|
More detailed information about creating a PAT and administrator roles you can find [here](/guides/integrate/service-users/personal-access-token)
|
|
|
|
Then you have to send the following request:
|
|
```bash
|
|
curl -L -X PUT "https://${CUSTOM_DOMAIN}/management/v1/projects/${PROJECT_ID}" \
|
|
-H 'Content-Type: application/json' \
|
|
-H 'Accept: application/json' \
|
|
-H "Authorization: Bearer ${PAT}" \
|
|
--data-raw '{
|
|
"name": "ZITADEL",
|
|
"projectRoleAssertion": false,
|
|
"projectRoleCheck": false,
|
|
"hasProjectCheck": true,
|
|
"privateLabelingSetting": "PRIVATE_LABELING_SETTING_UNSPECIFIED"
|
|
}'
|
|
```
|
|
|
|
Where
|
|
- `${CUSTOM_DOMAIN}` is your Custom Domain, f.e. mydemo.zitadel.cloud
|
|
- `${PAT}` is your service user's personal access token
|
|
- `${PROJECT_ID}` is the default-project's ID that can be found in Management Console see screenshot above
|
|
|
|
You should now be able to log in with users of the organization that have the grant (in this example users of the organization "Customer-A").
|
|
All other users should see the following error message after authentication:
|
|
|
|

|