zitadel/docs
Elio Bischof cff4fe5dfd
Some checks are pending
ZITADEL CI/CD / core (push) Waiting to run
ZITADEL CI/CD / console (push) Waiting to run
ZITADEL CI/CD / version (push) Waiting to run
ZITADEL CI/CD / compile (push) Blocked by required conditions
ZITADEL CI/CD / core-unit-test (push) Blocked by required conditions
ZITADEL CI/CD / core-integration-test (push) Blocked by required conditions
ZITADEL CI/CD / lint (push) Blocked by required conditions
ZITADEL CI/CD / container (push) Blocked by required conditions
ZITADEL CI/CD / e2e (push) Blocked by required conditions
ZITADEL CI/CD / release (push) Blocked by required conditions
Code Scanning / CodeQL-Build (go) (push) Waiting to run
Code Scanning / CodeQL-Build (javascript) (push) Waiting to run
docs: fix and harmonize docker compose files (#8839)
# Which Problems Are Solved

1. Postgres spams FATAL: role "root" does not exist as mentioned in
https://github.com/zitadel/zitadel/discussions/7832 (even with -U)

2. The compose commands for a ZITADEL deployment with initial service
account key don't work out-of-the box with a non-root user, because
docker creates non-existing directories to bind-mount with root
ownership.


![image](https://github.com/user-attachments/assets/f2fc92d5-2ff4-47a4-bf4d-e9657aa2bb94)

```
time="2024-10-29T09:37:13Z" level=error msg="migration failed" caller="/home/runner/work/zitadel/zitadel/internal/migration/migration.go:68" error="open /machinekey/zitadel-admin-sa.json: permission denied" name=03_default_instance
time="2024-10-29T09:37:13Z" level=fatal msg="migration failed" caller="/home/runner/work/zitadel/zitadel/cmd/setup/setup.go:248" error="open /machinekey/zitadel-admin-sa.json: permission denied" name=03_default_instance
```

# How the Problems Are Solved

1. The branch bases on https://github.com/zitadel/zitadel/pull/8826. The
env vars are cleaned up and prettified across compose files.

2. A command is added to the docs that creates the directory with the
current users permission. The ZITADEL container runs with the current
users ID.

# Additional Context

- Replaces https://github.com/zitadel/zitadel/pull/8826
- Discussion https://github.com/zitadel/zitadel/discussions/7832
- Closes https://github.com/zitadel/zitadel/issues/7725

---------

Co-authored-by: m4tu4g <71326926+m4tu4g@users.noreply.github.com>
2024-10-29 20:02:04 +01:00
..
apis/assets ci: improve performance (#5953) 2023-07-17 10:08:20 +02:00
docs docs: fix and harmonize docker compose files (#8839) 2024-10-29 20:02:04 +01:00
src docs: optimized examples and sdk for search (#8657) 2024-09-25 08:14:58 +00:00
static feat: Add Twilio Verification Service (#8678) 2024-09-26 09:14:33 +02:00
.gitignore chore(docs): use gh action to build docs (#8097) 2024-06-13 08:07:39 +00:00
babel.config.js chore(docs): use gh action to build docs (#8097) 2024-06-13 08:07:39 +00:00
buf.gen.yaml chore(api): initial definition of API for user schemas (user v3 and user schema v3 service) (#7372) 2024-02-15 11:22:48 +01:00
docusaurus.config.js docs: Improve http notification doc (#8642) 2024-09-18 15:38:55 +02:00
frameworks.json docs: add pylon framework to examples (#8115) 2024-06-17 07:37:07 +00:00
package.json chore(docs): increase heap size (#8547) 2024-09-04 12:38:41 +00:00
README.md docs: Add reference to Actions for custom claims and custom attributes (#7204) 2024-01-11 15:27:37 +01:00
sidebars.js docs: reorganize actions v3 docs (#8712) 2024-10-03 16:26:05 +00:00
tailwind.config.js docs: add tailwindcss for styles, oidc authorize endpoint playground (#4707) 2022-12-05 18:36:12 +01:00
vercel.json docs: reorganize actions v3 docs (#8712) 2024-10-03 16:26:05 +00:00
yarn.lock chore(deps): bump http-proxy-middleware from 2.0.6 to 2.0.7 in /docs (#8821) 2024-10-25 20:12:27 +00:00

ZITADEL-Docs

This website is built using Docusaurus 2, a modern static website generator.

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.

Installation

Install dependencies with

yarn install

then run

yarn generate

Local Development

Start a local development server with

yarn start

When working on the API docs, run a local development server with

yarn 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