mirror of
https://github.com/zitadel/zitadel.git
synced 2025-12-24 13:36:38 +00:00
473c33754f
# Which Problems Are Solved The [compose deployment example](https://zitadel.com/docs/self-hosting/deploy/compose) has improved guidance and a more robust compose configuration. It provides clear paths to a variety of target environments. # How the Problems Are Solved - The introduction sentences make clear that the setup is not intended to be used as is in production. - Info blocks are removed as they rather increased the mental overhead instead of drawing attention to important hints. - The What's next section adds links and hints that help evolving the setup towards production. - The docker-compose.yaml explains variables better, gives hints and provides configuration examples. - The root user is used to write and read the `login-client.pat` file to avoid file permission errors and failing setup steps. - The postgres data is persisted in a named volume, so it survives the PostgreSQL container lifecycle. - `curl` is used instead of `wget`, because `curl` is more likely to already be installed on hosts. # Additional Context - Closes #10432 - Closes #8910 - Implements changes proposed [here](https://github.com/zitadel/zitadel/issues/10432#issuecomment-3188569674) and [here](https://github.com/zitadel/zitadel/issues/10432#issuecomment-3191360487). To test the changes, you can't download the compose file as suggested [by the preview doc](https://docs-nuzruxtoh-zitadel.vercel.app/docs/self-hosting/deploy/compose). As the updated compose file is not merged to main yet, you have to use a different download link: ```shell curl -L https://raw.githubusercontent.com/zitadel/zitadel/improve-compose-example/docs/docs/self-hosting/deploy/docker-compose.yaml -o docker-compose.yaml ``` --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Tim Möhlmann <tim+github@zitadel.com>
ZITADEL-Docs
This website is built using Docusaurus 2, a modern static website generator.
The documentation is part of the ZITADEL monorepo and uses pnpm and Turbo for development and build processes.
Quick Start
# From the repository root
pnpm install
# Start development server (with Turbo)
pnpm turbo dev --filter=zitadel-docs
# Or start directly from docs directory
cd docs && pnpm start
The site will be available at http://localhost:3000
Available Scripts
All scripts can be run from the repository root using Turbo:
# Development server with live reload
pnpm turbo dev --filter=zitadel-docs
# Build for production
pnpm turbo build --filter=zitadel-docs
# Generate API documentation and configuration docs
pnpm turbo generate --filter=zitadel-docs
# Lint and fix code
pnpm turbo lint --filter=zitadel-docs
# Serve production build locally
cd docs && pnpm serve
Add new Sites to existing Topics
To add a new site to the already existing structure simply save the md file into the corresponding folder and append the sites id int the file sidebars.js.
If you are introducing new APIs (gRPC), you need to add a new entry to docusaurus.config.js under the plugins section.
Build Process
The documentation build process automatically:
- Downloads required protoc plugins - Ensures
protoc-gen-connect-openapiis available - Generates gRPC documentation - Creates API docs from proto files
- Generates API documentation - Creates OpenAPI specification docs
- Copies configuration files - Includes configuration examples
- Builds the Docusaurus site - Generates the final static site
Local Development
Standard Development
# Install dependencies
pnpm install
# Start development server
pnpm start
API Documentation Development
When working on the API docs, run a local development server with:
pnpm start:api
Container Image
If you just want to start docusaurus locally without installing node you can fallback to our container image. Execute the following commands from the repository root to build and start a local version of ZITADEL
docker build -f docs/Dockerfile . -t zitadel-docs
docker run -p 8080:8080 zitadel-docs