andwati/zitadel
1
0
Fork 0
mirror of https://github.com/andwati/zitadel.git synced 2026-10-18 05:52:51 +00:00
Code Issues Packages Projects Releases Wiki Activity
4,382 Commits 2 Branches 0 Tags
f138082b64513955466e8dddc8de2a5a1e4e6c8e
Commit Graph
38 Commits
This Branch
This Branch
All Branches
Author SHA1 Message Date
Federico CoppedeGitHubCopilot Autofix powered by AI
 		34e6a792d2 docs: text customization on Login V2 (#11849) 
This PR updates the "Hosted Login UI" documentation to clarify how text
customization works for the new Hosted Login V2.

**Changes:**

1. Adds a warning callout to the "Customization options" section.
2. Clarifies that Login V2 interface texts currently cannot be modified
via the ZITADEL Console UI.
3. Provides the required workaround, directing users to use the Settings
V2 API to patch translation keys using the en.json locale file as a
reference.

---------

Co-authored-by: Copilot Autofix powered by AI <[email protected]>
 2026-03-16 17:12:10 +01:00
Federico CoppedeandGitHub 7db9af486f docs: add guest user auth use case (#11715) 
this PR adds a guest user auth doc to the use cases sidebar section
 2026-02-27 15:57:09 +00:00
Federico CoppedeandGitHub 8d09630a0d docs: update feedback form (#11717) 
This PR forces the user to enter a reason/explanation before submitting
a negative feedback. Negative feedback without an explanation is not
actionable.
 2026-02-27 07:50:26 -08:00
Federico CoppedeGitHubCopilot
 		ed48fbfbcd docs: update custom domain guide for customer portal (#11691) 
This PR fixes some issues on the custom domain guide for the customer
portal

---------

Co-authored-by: Copilot <[email protected]>
 2026-02-25 21:59:22 +00:00
Federico CoppedeandGitHub 23c31ab2cb docs: remove user-schema page reference from the docs (#11394) 
This PR removes the user-schema page from the sidebar menu
 2026-01-20 15:10:27 -03:00
Federico CoppedeGitHubCopilotFlorian Forster
 		32877972e8 docs: created egress IPs page for Zitadel Cloud (#11376) 
Added the list of egress IPs per region for Zitadel Cloud outgoing
requests from Actions/IDP connections/SMTP/SMS/etc.

---------

Co-authored-by: Copilot <[email protected]>
Co-authored-by: Florian Forster <[email protected]>
 2026-01-20 12:10:57 -03:00
Federico CoppedeandGitHub 4e5c31f0e7 docs: fix broken references to apis pages (#11391) 
This PR fixes multiple broken references to different API pages. Also,
unused redirects are removed from the vercel.json file.
 2026-01-20 09:00:43 -03:00
Federico CoppedeandGitHub be57a08aaa docs: feedback form does not render correctly on mobile screens (#11377) 
fixed rendering of the feedback form (what this useful? yes - no) on
mobile screens
 2026-01-16 13:50:18 -03:00
Federico CoppedeGitHubCopilot
 		7f81b866a5 docs: update text and code blocks theme (#11361) 
Changes made to the docs UI:

**Code Blocks:** Implemented "Mac Terminal" style blocks with traffic
light dots, rounded corners, and deep shadows. Enforced high-contrast
dark theme for code in all modes.

**Typography**: Updated weights and tighter letter spacing for headings.

**Admonitions**: Updated alerts to use cleaner borders and softer
shadows.

---------

Co-authored-by: Copilot <[email protected]>
 2026-01-16 10:14:38 +00:00
Federico CoppedeandGitHub 13be5dc46d docs: organization context clarification (#11368) 
Added some clarification based on user's feedback.
 2026-01-15 15:07:23 +00:00
Federico CoppedeandGitHub 2797a0bb03 docs: add clarification for user roles membership (#11359) 
This PR add some clarification to determine which roles are assigned to
a user using either introspection or claims added to the token
 2026-01-14 16:15:28 +01:00
Federico CoppedeandGitHub dc01a0abff docs: fixed broken references docs homepage (#11357) 
Fixed broken references in the Zitadel docs homepage
 2026-01-14 17:26:01 +05:30
Federico CoppedeandGitHub 7276c40261 docs: fixed broken references (#11341) 
This PR resolves some broken references found in the documentation.
 2026-01-12 21:09:40 +00:00
Federico CoppedeGitHubTim Möhlmann
 		670c1c49a3 docs: clarifications for private key jwt with service users (#11228) 
This PR fixes wording, and adds clarification to the private key JWT
flow for service users with feedback gathered in this discussion:
- https://github.com/zitadel/zitadel/discussions/8406
Fixes #8562

Co-authored-by: Tim Möhlmann <[email protected]>
 2026-01-12 12:24:53 +00:00
Federico CoppedeandGitHub d7a9e9d48b docs: fix PKCE broken reference (#11324) 
This PR fixes the broken reference to the PKCE reference
 2026-01-10 19:42:37 -03:00
Federico CoppedeGitHubFlorian Forster
 		96f9bbc044 docs: structure update (#11275) 
### **Restructure Docs Navigation & Consolidate Core Concepts**

**Summary**
This PR refactors the documentation navigation to follow a clearer
**User Journey** and consolidates fragmented pages to reduce redundancy.

**Key Changes**

* **Sidebar:**
* Replaced the legacy resource-based structure with user-journey-focused
categories.

**Proposed Structure:**

```
Get Started
├─ Overview
│   └─ Guides Overview (Brief intro to docs, persona-aligned: "Get auth working in minutes for your B2B app.")
├─ Quickstart Guide
│   └─ Quickstart (Step-by-step: Sign up, spin up instance, connect app, log in – mirrors brand's 4-step guide.)
├─ Authenticate Users
│   ├─ Login with ZITADEL (OIDC)
│   ├─ Get ID / Access Token
│   └─ Logout
├─ Examples & SDKs
│   ├─ SPA / Frontend
│   ├─ Web Applications
│   ├─ APIs / Backend Services
│   ├─ Hybrid / Full-Stack
│   └─ Sample Applications (Include community-contributed examples for openness.)
├─ Key Concepts
│   ├─ Instances, Orgs, Projects, Apps
│   ├─ Policies (Intro)
│   └─ Users & Roles
└─ Use Cases
    ├─ B2B Integration (Tailored to multi-tenant enterprise needs.)
    ├─ B2C Login
    ├─ Multi-Tenant / SaaS
    ├─ Branded Login & White-Label
    └─ Machine-to-Machine (M2M)

Configure Identity & Policies
├─ Identity Providers
│   ├─ External IDPs (e.g., Google, Azure)
│   └─ Custom Providers
├─ Policies
│   ├─ Password Policies
│   ├─ Lockout Policies
│   └─ Privacy Policies
├─ Roles & Permissions
│   ├─ RBAC Setup
│   └─ Custom Roles
└─ Compliance & Security
    ├─ Audits & Logs
    └─ Certifications (Highlight trust through openness.)

Integrate & Authenticate
├─ OIDC & OAuth Flows
├─ API Access
│   ├─ gRPC APIs
│   └─ REST APIs
├─ SDKs
│   ├─ Go
│   ├─ JavaScript/TypeScript
│   ├─ Python
│   └─ Others (Link to community SDKs.)
└─ External Integrations
    ├─ SAML
    ├─ LDAP
    └─ Webhooks

Test & Debug
├─ Testing Tools
│   ├─ Console Testing
│   └─ API Playground
├─ Common Issues
│   ├─ Token Errors
│   └─ Integration Failures
└─ Debugging Guides
    ├─ Logs & Monitoring
    └─ Error Codes Reference

Deploy & Operate
├─ Deployment Options
│   ├─ Cloud (ZITADEL Cloud)
│   ├─ Self-Hosted (Linux, MacOS)
│   ├─ Docker Compose
│   └─ Kubernetes
├─ Configuration
│   ├─ Environment Variables
│   └─ Advanced Settings
├─ Scaling & Performance
│   ├─ High Availability
│   └─ Backup & Restore
└─ Monitoring & Maintenance
    ├─ Metrics
    └─ Upgrades

Architecture & Concepts
├─ System Architecture
│   ├─ Core Components
│   └─ Data Flow Diagrams (Expressive visuals per brand.)
├─ Principles
│   ├─ Multi-Tenancy
│   └─ Open Standards (OIDC, SAML)
└─ Advanced Topics
    ├─ Customization
    └─ Extensibility (Open-source contributions.)

Product, Releases & Support
├─ Product Features
│   ├─ Roadmap (Public, for transparency.)
│   └─ Pricing & Tiers
├─ Releases
│   ├─ Changelog
│   └─ Upgrade Guides
└─ Support Resources
    ├─ Community (Discord, GitHub – for community-led growth.)
    ├─ FAQ
    ├─ Contact Support
    └─ Contribute (Encourage feedback/shaping the product.)
```

**Content Consolidation:**
* Merged separate "Concept" and "Console Guide" files into single,
comprehensive **Overview** pages for core resources:
* `Organizations`, `Projects`, `Applications`, `Users`, `Console`, and
`Actions`.

```
concepts/structure/organizations + guides/manage/console/organizations -> guides/manage/console/organizations-overview

concepts/structure/projects + guides/manage/console/projects -> guides/manage/console/projects-overview

concepts/structure/applications + guides/manage/console/applications -> guides/manage/console/applications-overview

concepts/structure/users + guides/manage/console/users -> guides/manage/console/users-overview

guides/manage/console/actions + apis/actions/introduction -> guides/manage/console/actions-overview

concepts/features/console + guides/manage/console/overview -> guides/manage/console/console-overview
```


**Redirects (`vercel.json`):**
* Added permanent redirects for all the 6 legacy files mentioned above



**No files were deleted**

---------

Co-authored-by: Florian Forster <[email protected]>
 2026-01-09 15:07:02 -03:00
Federico CoppedeandGitHub 8a0580b358 docs: fix deprecated label for actions v2 (#11242) 
Removed deprecated label for Action V2 endpoints and removed Beta label
also. Fixed actions V2 domain endpoint (v2 instead of v2beta)
 2025-12-29 17:26:49 +01:00
Federico CoppedeandGitHub 941c446443 docs: remove typos (#11240) 
removed typos from the doc pages
Fixes: #11234
 2025-12-29 13:51:03 +00:00
Federico CoppedeandGitHub 03916cd0f2 docs: create guide for generic OIDC IDP (#11233) 
Fixes #7191
 2025-12-26 15:40:21 -03:00
Federico CoppedeandGitHub 15e89078da docs: update private key jwt for token instrospection (#11227) 
The current document for private key JWT is misleading, as it currently
looks like a mechanism to secure an API, and it's not, this section only
shows how to use private key JWT to call the introspect endpoint
 2025-12-24 20:41:48 +00:00
Federico CoppedeandGitHub e93ff33167 docs: update JWT IDP doc (#11230) 
This PR provides additional clarification to the steps needed to
configure a JWT IDP in Zitadel
Fixes #7646
 2025-12-24 20:38:15 +00:00
Federico CoppedeandGitHub 3a2eb96e82 docs: update account linking misleading doc (#11223) 
According to this
[doc](https://zitadel.com/docs/concepts/features/account-linking), I
should be able to select if I want to authenticate with the local or
external account.

<img width="720" height="119" alt="image"
src="https://github.com/user-attachments/assets/163d44e0-39a0-462c-8beb-fd3de8b543d5"
/>

This is not accurate.

Fixes #10161
 2025-12-23 15:32:40 +00:00
Federico CoppedeandGitHub faefeaa53c docs: update actions V2 landing page (#11220) 
Updated wording on the Actions V2 landing page and added a reference to
the sample scripts repository we have to deploy Actions for various use
cases to Cloudflare Workers.

Fixes #11028
 2025-12-23 12:28:54 +00:00
Federico CoppedeandGitHub 3106dcfc67 docs: update database configuration page (#11219) 2025-12-22 17:08:12 +01:00
Federico CoppedeandGitHub 11cf2c252a chore(ux): Fix wording for application ID token settings (#11210) 
When this checkbox is enabled, the user profile information (not the
roles assigned) will be returned as claims in the ID token. The current
wording is not accurate.
 2025-12-18 18:13:18 +00:00
Federico CoppedeandGitHub 44b7f1013f docs: built in smtp provider warning (#10958) 
Added a warning to mention that the built in SMTP provider is for
testing only, not production.

**Context:** Customers often complain about email delivery delays while
using the built in SMTP provider, and they should configure their own.
 2025-10-25 10:03:56 +00:00
Federico CoppedeandGitHub 74fc58cb36 docs: add clarification for error forwarding in actions v2 (#10960) 
When forwarding an error from a target to Zitadel, the target
**interruptOnError** must be **true** - this clarification is missing in
the document.
 2025-10-24 20:29:52 +02:00
Federico CoppedeandGitHub 6c98559ec0 docs: update react app screenshot to match new quickstart UI (#10936) 
Updated react quickstart app screenshot to match new UI
 2025-10-20 17:04:52 +00:00
Federico CoppedeGitHubMax Peintner
 		3ed3b5ee59 docs: added feedback component to all docs pages (#10856) 
This PR adds a feedback box at the bottom of all the docs pages to help
us track which pages need to be updated or improved. The feedback box is
connected to plausible for event tracking.

---------

Co-authored-by: Max Peintner <[email protected]>
 2025-10-08 08:45:53 -03:00
Federico CoppedeandGitHub 096eb4fd91 docs: update api intro and postman collection (#10786) 
This PR removes the outdated swagger section and add a reference to the
Postman collection we recently published.
 2025-09-26 19:04:02 -03:00
Federico CoppedeandGitHub de0667bb24 docs: added zitadel-vanilla-js link and reference (#10807) 
Added a link to the new vanilla-js SPA example on the sidebar, and the
card + image on the resources here:
- https://zitadel.com/docs/sdk-examples/introduction 

New sample app:
- https://github.com/zitadel/zitadel-vanilla-js
 2025-09-26 16:53:33 -03:00
Federico CoppedeandGitHub 44902e11b7 docs: update release cycle and support states URL to point to KBAs (#10602) 
The page located here was split into 2 different KBAs:
- https://zitadel.com/docs/support/software-release-cycles-support

**Software release cycles:** 
- https://help.zitadel.com/zitadel-software-release-cycle

**Support states KBA:** 
- https://help.zitadel.com/zitadel-support-states

And the corresponding URLs were updated in the docs site
 2025-09-22 11:29:34 +00:00
Federico CoppedeandGitHub 41d04ffa65 docs: fix typo in default settings domain discovery description (#10743) 
fixed typo:
If this setting is enabled, the user **does't not** mandatory -> If this
setting is enabled, the user doesn't have to...
 2025-09-16 15:33:40 +00:00
Federico CoppedeGitHubFlorian Forster
 		756f81534a docs: update status page URL (#10528) 
old status page URL: status.zitadel.com
new status page URL: zitadelstatus.com

Co-authored-by: Florian Forster <[email protected]>
 2025-08-22 11:36:23 +00:00
Federico CoppedeGitHubMaximilian
 		763825cd2c docs(guides): updated support instructions and screenshots (#10521) 
Since the support form is deployed in the customer portal I updated the
instructions and screenshots.

---------

Co-authored-by: Maximilian <[email protected]>
 2025-08-20 10:15:11 +00:00
Federico CoppedeGitHubMaximilian
 		c83a85dee9 docs(legal): remove billing page to redirect to the HubSpot KBA URL (#10488) 
Removed the billing md document and updated the links to the HubSpot KBA
-> https://help.zitadel.com/pricing-and-billing-of-zitadel-services

Co-authored-by: Maximilian <[email protected]>
 2025-08-18 11:21:00 -03:00
Federico CoppedeGitHubMaximilian
 		ea71da0d3f docs (legal): Update urgent support phone number specified in support-services.mdx (#10486) 
Updated urgent support phone number to **+41 71 560 28 06**

Co-authored-by: Maximilian <[email protected]>
 2025-08-14 17:32:30 +00:00
Federico CoppedeGitHubMaximilian
 		b7d447e313 docs(legal): Update account-lockout-policy.md (#10124) 
Review finished for the account lockout policy.

Main changes:

- Revised wording
- Removed free account from the policy scope
- Fixed broken link to the support form in the customer portal

---------

Co-authored-by: Maximilian <[email protected]>
 2025-06-30 12:21:08 +00:00