Files
zitadel/docs
e074668c6b feat(cmd): skip privileged database commands during initialization if objects already present (#11021)
This pull request addresses an issue where ZITADEL's initialization
process could fail in environments with restricted database permissions,
such as managed database services (e.g., Google Cloud SQL, Amazon RDS,
Azure PostgreSQL).

## Which problem is solved

Previously, `zitadel init` (and its sub commands) and `zitadel
start-from-init` commands would attempt to execute `CREATE DATABASE`,
`CREATE USER`, and `GRANT` statements. These commands often fail if the
provided database user lacks superuser privileges, which is a common
security practice in hosted database environments.

## How the problem is solved

With this change, Zitadel is now smarter during initialization. It
checks if the database and user specified in your configuration already
exist and are accessible. If they are, ZITADEL will skip the creation
and grant commands, allowing for a seamless setup even with a
less-privileged database user.

## Additional information

closes #10730
closes https://github.com/zitadel/zitadel/issues/8198

### How to leverage this feature (skip admin commands)

To have ZITADEL skip the database administration commands, you need to
configure it so that the initialization process can use the
already-existing database and user. This is achieved by pointing the
admin access in your ZITADEL configuration to the user and database that
ZITADEL will use for its operations.

In your ZITADEL configuration file (e.g., zitadel.yaml), configure the
Database section as follows:

```yaml
Database:
  Postgres:
    Database: existing_database
    # Admin credentials should be the same as the application user credentials
    Admin:
      User: zitadel-user
      ExistingDatabase: existing_database # this is used to connect the admin to the previously created database
    # Application user credentials
    User:
      User: zitadel-user
```

---------

Co-authored-by: Marco A. <[email protected]>
2025-11-11 10:28:06 +00:00
..
2025-10-08 10:27:02 +02:00
2025-10-08 10:27:02 +02:00
2025-10-08 10:27:02 +02:00

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 Nx for development and build processes.

Quick Start

Run the following commands from the repositorys root directory to install all dependencies needed. Using Corepack makes sure you have the pnpm version intalled that is declared in .

corepack enable
pnpm install

Start a docs server

# Start development server with live-reloading
pnpm nx run @zitadel/docs:dev

# Or serve a production build
pnpm nx run @zitadel/docs:start

The site will be available at http://localhost:3100

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:

  1. Downloads required protoc plugins - Ensures protoc-gen-connect-openapi is available
  2. Generates gRPC documentation - Creates API docs from proto files
  3. Generates API documentation - Creates OpenAPI specification docs
  4. Copies configuration files - Includes configuration examples
  5. Builds the Docusaurus site - Generates the final static site