mirror of
https://github.com/andwati/zitadel.git
synced 2026-10-31 11:32:15 +00:00
docs: introduce versioned docs and migrate to fuma (#11166)
## 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]>
This commit is contained in:
Florian Forster
co-authored by
Federico Coppede
Federico Coppede
parent
7b6395c348
commit
d8ea041c56
@@ -0,0 +1,107 @@
|
||||
---
|
||||
title: Spring Boot
|
||||
sidebar_label: Spring Boot
|
||||
framework_url: https://spring.io/projects/spring-boot
|
||||
auth_library: "Spring Security"
|
||||
auth_library_url: https://spring.io/projects/spring-security
|
||||
example_repo: https://github.com/zitadel/example-auth-spring
|
||||
auth_flow: pkce
|
||||
status: stable
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
[Spring Boot](https://spring.io/projects/spring-boot) is a powerful, production-ready framework for building Java applications. This example shows how to integrate **Zitadel** into a Spring Boot web application using **OpenID Connect (OIDC)** and the **Authorization Code Flow + PKCE**.
|
||||
|
||||
It demonstrates a common web app pattern: users start on a public landing page, authenticate with Zitadel via a login button, and are then redirected to a protected profile page that displays user information. Logout is also implemented to end both the local session and the Zitadel session.
|
||||
|
||||
#### Auth library
|
||||
|
||||
This example uses **[Spring Security](https://spring.io/projects/spring-security)**, the standard framework for authentication and access control in Spring applications. Spring Security supports OIDC natively and manages the PKCE flow for you.
|
||||
|
||||
---
|
||||
|
||||
## What this example demonstrates
|
||||
|
||||
This example shows a complete authentication implementation using Spring Security’s OAuth 2.0 / OIDC support:
|
||||
|
||||
- **Public landing page** (`/`) accessible without authentication.
|
||||
- **Sign-in with Zitadel** via Spring Security’s OAuth2 login entrypoint.
|
||||
- **Route protection** so authenticated access is required for protected routes (e.g. `/profile`).
|
||||
- **Profile page** that renders the authenticated user’s OIDC claims.
|
||||
- **Server-side session management** handled by the servlet container + Spring Security.
|
||||
- **Federated logout** that clears the local session and triggers RP-initiated logout against Zitadel, returning the user to a post-logout callback route.
|
||||
|
||||
---
|
||||
|
||||
## Getting started
|
||||
|
||||
### Prerequisites
|
||||
|
||||
Before you begin, ensure you have the following:
|
||||
|
||||
#### System Requirements
|
||||
|
||||
- Java Development Kit (JDK) 17 or later
|
||||
- Maven (or use the included `mvnw` wrapper)
|
||||
|
||||
#### Account Setup
|
||||
|
||||
You’ll need a Zitadel account and an application configured for a Web app using Authorization Code + PKCE.
|
||||
|
||||
> **Important:** Configure the following URLs in your Zitadel application settings:
|
||||
>
|
||||
> - **Redirect URIs:** `http://localhost:3000/auth/callback`
|
||||
> - **Post Logout Redirect URIs:** `http://localhost:3000/auth/logout/callback`
|
||||
>
|
||||
> These URLs must exactly match what your Spring Boot application uses. For production, add your production URLs.
|
||||
|
||||
### Run the example
|
||||
|
||||
1. Clone the repository.
|
||||
2. Copy `.env.example` to `.env` and fill in your Zitadel details.
|
||||
|
||||
```dotenv
|
||||
# Port number where your Spring Boot server will listen for incoming HTTP requests.
|
||||
PORT=3000
|
||||
|
||||
# Session timeout in seconds. Users will be automatically logged out after this
|
||||
# duration of inactivity. 3600 seconds = 1 hour.
|
||||
SESSION_DURATION=3600
|
||||
|
||||
# Your Zitadel instance domain URL. Include the full https:// URL.
|
||||
ZITADEL_DOMAIN="https://your-zitadel-domain"
|
||||
|
||||
# Application Client ID from your Zitadel application settings.
|
||||
ZITADEL_CLIENT_ID="your-client-id"
|
||||
|
||||
# Provide a randomly generated string here.
|
||||
ZITADEL_CLIENT_SECRET="your-randomly-generated-client-secret"
|
||||
```
|
||||
|
||||
3. Build and start the server:
|
||||
|
||||
```bash
|
||||
# 1. Clone the repository
|
||||
git clone [email protected]:zitadel/example-auth-spring.git
|
||||
cd example-auth-spring
|
||||
|
||||
# 2. Build the project and download dependencies
|
||||
mvn clean install
|
||||
|
||||
# 3. Start the development server
|
||||
mvn spring-boot:run
|
||||
```
|
||||
|
||||
4. Open `http://localhost:3000` and walk through login → profile → logout.
|
||||
|
||||
---
|
||||
|
||||
## Learn more and resources
|
||||
|
||||
* [PKCE concept](https://oauth.net/2/pkce/)
|
||||
* [Federated logout](https://zitadel.com/docs/guides/integrate/login/oidc/logout)
|
||||
* [OIDC integration guide](https://zitadel.com/docs/guides/integrate/login/oidc/login-users)
|
||||
* [Spring Boot documentation](https://spring.io/projects/spring-boot)
|
||||
* [Spring Security documentation](https://spring.io/projects/spring-security)
|
||||
* [Example repository](https://github.com/zitadel/example-auth-spring)
|
||||
Reference in New Issue
Block a user