mirror of
https://github.com/andwati/zitadel.git
synced 2026-10-19 14:12:52 +00:00
7e34f04361
# Which Problems Are Solved Several links in the docs point at repository paths that no longer exist, so they 404 on GitHub: - The `load-test` directory was renamed to `benchmark`. The benchmarks page still links to `load-test`, `load-test/Makefile` and `load-test/README.md` (5 occurrences). - `apps/docs/content/index.mdx` links to `CONTRIBUTING.mdx`, but the file is `CONTRIBUTING.md`. - The login-app guide links to `apps/login/src/middleware.ts`, which was renamed to `apps/login/src/proxy.ts` in the Next.js 16 upgrade (#11629). # How the Problems Are Solved - Point the benchmarks page at `benchmark/`, `benchmark/Makefile` and `benchmark/README.md`. The `#test` anchor still resolves — `benchmark/README.md` has a `### Test` heading. - Fix the `CONTRIBUTING.md` extension. - Point the middleware example at `apps/login/src/proxy.ts`. Verified by extracting every `github.com/zitadel/zitadel/{blob,tree}/main/...` link from `apps/docs/content` and resolving each one against the working tree — all 14 distinct paths now exist. # Additional Changes - Prose in the benchmarks page that names the directory ("the load-test Makefile", "the load-test readme") now says "benchmark". Generic uses of "load-test"/"load-testing" as an activity are left as they are. # Additional Context - The versioned docs under `apps/docs/content/v4.13`–`v4.16` contain the same stale links, but those directories are generated at build time from release tags by `apps/docs/scripts/fetch-remote-content.mjs` and are gitignored, so they cannot be fixed from `main`. The published pages for those versions will keep the old links. - `apps/docs/scripts/check-links.ts` skips anything starting with `http`, which is why these went unnoticed. Teaching it to resolve `github.com/zitadel/zitadel/blob/main/<path>` links against the working tree would catch this class of breakage in CI — not done here to keep the PR focused. Co-authored-by: Claude Opus 5 <[email protected]>
134 lines
4.1 KiB
Plaintext
134 lines
4.1 KiB
Plaintext
---
|
|
title: ZITADEL Documentation
|
|
description: ZITADEL is the "Identity Infrastructure for developers". We provide a hardened and extensible turnkey solution to address all your authentication and authorization needs.
|
|
---
|
|
|
|
import { Card, Cards } from 'fumadocs-ui/components/card';
|
|
import { Rocket, Laptop, BookOpen, Book, Server, ShieldCheck, Terminal, MessageCircle, Calendar, Heart, HelpCircle } from 'lucide-react';
|
|
|
|
**ZITADEL is the Identity Infrastructure for Developers.**
|
|
|
|
We provide a hardened, extensible turnkey solution for all your authentication and authorization needs. Instead of building your own login system, use ZITADEL to accelerate your project with features that work out of the box:
|
|
|
|
* **Secure Login**: Multi-factor authentication (OTP, U2F, Passkeys) and single sign-on (OIDC, SAML, OAuth2).
|
|
* **B2B Ready**: First-class multi-tenancy with branding customization and self-service.
|
|
* **Auditable**: Exhaustive audit trail of all events.
|
|
* **Extensible**: Execute custom code on events (Actions) to fit your unique workflows.
|
|
|
|
## Get Started
|
|
|
|
Explore our guides to get up and running with ZITADEL quickly.
|
|
|
|
<Cards>
|
|
<Card
|
|
title="Quick Start Guide"
|
|
href="/guides/start/quickstart"
|
|
icon={<Rocket />}
|
|
description="Learn how to set up ZITADEL in minutes."
|
|
/>
|
|
<Card
|
|
title="SDKs"
|
|
href="/sdk-examples/introduction"
|
|
icon={<Terminal />}
|
|
description="Explore our libraries for your favorite languages."
|
|
/>
|
|
<Card
|
|
title="Example Apps"
|
|
href="/examples/introduction"
|
|
icon={<Laptop />}
|
|
description="Sample applications to help you get started."
|
|
/>
|
|
<Card
|
|
title="Knowledge Base"
|
|
href="https://help.zitadel.com"
|
|
icon={<HelpCircle />}
|
|
description="Find answers to common ZITADEL questions and issues."
|
|
/>
|
|
</Cards>
|
|
|
|
## Deployment Options
|
|
|
|
You can use ZITADEL in two ways:
|
|
|
|
- **ZITADEL Cloud**: This is our public cloud service. Use the free tier to start in minutes.
|
|
- **Self-hosted ZITADEL**: For full control, deploy ZITADEL wherever you prefer.
|
|
|
|
If you're unsure, consider the generous free tier of [ZITADEL Cloud](https://help.zitadel.com/customer-portal-getting-started).
|
|
|
|
<Cards>
|
|
<Card title="ZITADEL Cloud" href="https://help.zitadel.com/customer-portal-getting-started" icon={<Server />} external >
|
|
Choose if you want:
|
|
- A turnkey solution that's ready to go
|
|
- Global scalability without the hassle
|
|
- Data-residency compliance
|
|
</Card>
|
|
<Card title="Self-hosted" href="/self-hosting/deploy/overview" icon={<Server />}>
|
|
Choose if you want:
|
|
- Total control over all components
|
|
- Air-gapped or regulated environments
|
|
- Flexibility when deploying updates
|
|
</Card>
|
|
</Cards>
|
|
|
|
## Explore Components
|
|
|
|
Deep dive into the architecture and capabilities of ZITADEL.
|
|
|
|
<Cards>
|
|
<Card
|
|
title="Concepts"
|
|
href="/concepts"
|
|
icon={<BookOpen />}
|
|
description="Understand the core principles of ZITADEL."
|
|
/>
|
|
<Card
|
|
title="APIs"
|
|
href="/apis/introduction"
|
|
icon={<Laptop />}
|
|
description="Reference documentation for our REST and gRPC APIs."
|
|
/>
|
|
<Card
|
|
title="Self-hosting"
|
|
href="/self-hosting/deploy/overview"
|
|
icon={<Server />}
|
|
description="Learn how to deploy and manage ZITADEL yourself."
|
|
/>
|
|
<Card
|
|
title="Legal"
|
|
href="/legal"
|
|
icon={<ShieldCheck />}
|
|
description="Terms of service, privacy policy, and more."
|
|
/>
|
|
</Cards>
|
|
|
|
## Community & Support
|
|
|
|
Join the community and get help.
|
|
|
|
<Cards>
|
|
<Card
|
|
title="Discord"
|
|
href="https://zitadel.com/chat"
|
|
icon={<MessageCircle />}
|
|
description="Join our Discord chat to get help from the community and the ZITADEL team."
|
|
/>
|
|
<Card
|
|
title="Github Discussions"
|
|
href="https://github.com/zitadel/zitadel/discussions"
|
|
icon={<MessageCircle />}
|
|
description="Open a discussion on Github."
|
|
/>
|
|
<Card
|
|
title="Office Hours"
|
|
href="https://zitadel.com/office-hours"
|
|
icon={<Calendar />}
|
|
description="Join our bi-weekly community calls."
|
|
/>
|
|
<Card
|
|
title="Contribute"
|
|
href="https://github.com/zitadel/zitadel/blob/main/CONTRIBUTING.md"
|
|
icon={<Heart />}
|
|
description="Help us improve ZITADEL and its documentation."
|
|
/>
|
|
</Cards>
|