mirror of
https://github.com/andwati/zitadel.git
synced 2026-10-18 13:52:51 +00:00
## 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]>
137 lines
5.5 KiB
YAML
137 lines
5.5 KiB
YAML
services:
|
|
zitadel:
|
|
restart: unless-stopped
|
|
image: ghcr.io/zitadel/zitadel:latest
|
|
command: start-from-init --masterkey "MasterkeyNeedsToHave32Characters"
|
|
environment:
|
|
# See "What's next" to learn about how to serve Zitadel on a different domain or IP.
|
|
ZITADEL_EXTERNALDOMAIN: localhost
|
|
|
|
# See "What's next" to learn about how to enable TLS.
|
|
ZITADEL_EXTERNALSECURE: false
|
|
ZITADEL_TLS_ENABLED: false
|
|
|
|
# Database connection settings.
|
|
ZITADEL_DATABASE_POSTGRES_HOST: db
|
|
ZITADEL_DATABASE_POSTGRES_PORT: 5432
|
|
# The database is created by the init job if it does not exist.
|
|
ZITADEL_DATABASE_POSTGRES_DATABASE: zitadel
|
|
# The admin user must already exist in the database.
|
|
ZITADEL_DATABASE_POSTGRES_ADMIN_USERNAME: postgres
|
|
ZITADEL_DATABASE_POSTGRES_ADMIN_PASSWORD: postgres
|
|
ZITADEL_DATABASE_POSTGRES_ADMIN_SSL_MODE: disable
|
|
# The zitadel user is created by the init job if it does not exist.
|
|
ZITADEL_DATABASE_POSTGRES_USER_USERNAME: zitadel
|
|
ZITADEL_DATABASE_POSTGRES_USER_PASSWORD: zitadel
|
|
ZITADEL_DATABASE_POSTGRES_USER_SSL_MODE: disable
|
|
|
|
# By configuring a login client, the setup job creates a user of type machine with the role IAM_LOGIN_CLIENT.
|
|
# It writes a PAT to the path specified in ZITADEL_FIRSTINSTANCE_LOGINCLIENTPATPATH.
|
|
# The PAT is passed to the login container via the environment variable ZITADEL_SERVICE_USER_TOKEN_FILE.
|
|
ZITADEL_FIRSTINSTANCE_LOGINCLIENTPATPATH: /current-dir/login-client.pat
|
|
ZITADEL_FIRSTINSTANCE_ORG_HUMAN_PASSWORDCHANGEREQUIRED: false
|
|
ZITADEL_FIRSTINSTANCE_ORG_LOGINCLIENT_MACHINE_USERNAME: login-client
|
|
ZITADEL_FIRSTINSTANCE_ORG_LOGINCLIENT_MACHINE_NAME: Automatically Initialized IAM_LOGIN_CLIENT
|
|
ZITADEL_FIRSTINSTANCE_ORG_LOGINCLIENT_PAT_EXPIRATIONDATE: '2029-01-01T00:00:00Z'
|
|
# Activate the login v2 on an installation from scratch.
|
|
# To activate the login v2 on an existing installation, read the "What's next" section.
|
|
ZITADEL_DEFAULTINSTANCE_FEATURES_LOGINV2_REQUIRED: true # To use the login v1, set this to false.
|
|
ZITADEL_DEFAULTINSTANCE_FEATURES_LOGINV2_BASEURI: http://localhost:3000/ui/v2/login
|
|
# Configure the redirection paths to the login v2.
|
|
ZITADEL_OIDC_DEFAULTLOGINURLV2: http://localhost:3000/ui/v2/login/login?authRequest=
|
|
ZITADEL_OIDC_DEFAULTLOGOUTURLV2: http://localhost:3000/ui/v2/login/logout?post_logout_redirect=
|
|
ZITADEL_SAML_DEFAULTLOGINURLV2: http://localhost:3000/ui/v2/login/login?samlRequest=
|
|
|
|
# By configuring a machine, the setup job creates a user of type machine with the role IAM_OWNER.
|
|
# It writes a personal access token (PAT) to the path specified in ZITADEL_FIRSTINSTANCE_PATPATH.
|
|
# The PAT can be used to provision resources with [Terraform](/guides/manage/terraform-provider), for example.
|
|
# ZITADEL_FIRSTINSTANCE_PATPATH: /current-dir/admin.pat
|
|
# ZITADEL_FIRSTINSTANCE_ORG_MACHINE_MACHINE_USERNAME: admin
|
|
# ZITADEL_FIRSTINSTANCE_ORG_MACHINE_MACHINE_NAME: Automatically Initialized IAM_OWNER
|
|
# ZITADEL_FIRSTINSTANCE_ORG_MACHINE_PAT_EXPIRATIONDATE: '2029-01-01T00:00:00Z'
|
|
|
|
# To change the initial human admin users username and password, uncomment the following lines.
|
|
# The first login name is formatted like this: <username>@<org_name>.<external_domain>
|
|
# With the following incommented configuration, this would be [email protected]
|
|
# Visit http://localhost:8080/ui/console to check if the login name works.
|
|
# If you can't log in, check the available login names:
|
|
# echo "select * from projections.login_names3;" | psql -h localhost -U postgres -d zitadel
|
|
# The postgres users password is postgres.
|
|
# ZITADEL_FIRSTINSTANCE_ORG_NAME: My Organization
|
|
# ZITADEL_FIRSTINSTANCE_ORG_HUMAN_USERNAME: root
|
|
# ZITADEL_FIRSTINSTANCE_ORG_HUMAN_PASSWORD: RootPassword1!
|
|
|
|
# Enable debug logs
|
|
# ZITADEL_LOG_LEVEL: debug
|
|
# Write Access Logs to stdout.
|
|
# ZITADEL_LOGSTORE_ACCESS_STDOUT_ENABLED: true
|
|
|
|
healthcheck:
|
|
test:
|
|
- CMD
|
|
- /app/zitadel
|
|
- ready
|
|
interval: 10s
|
|
timeout: 60s
|
|
retries: 5
|
|
start_period: 10s
|
|
user: "0"
|
|
volumes:
|
|
- .:/current-dir:delegated
|
|
ports:
|
|
- 8080:8080
|
|
- 3000:3000
|
|
networks:
|
|
- zitadel
|
|
depends_on:
|
|
db:
|
|
condition: service_healthy
|
|
|
|
login:
|
|
restart: unless-stopped
|
|
image: ghcr.io/zitadel/zitadel-login:latest
|
|
# If you can't use the network_mode service:zitadel, you can pass the environment variables ZITADEL_API_URL=http://zitadel:8080 and CUSTOM_REQUEST_HEADERS=Host:localhost instead.
|
|
environment:
|
|
- ZITADEL_API_URL=http://localhost:8080
|
|
- NEXT_PUBLIC_BASE_PATH=/ui/v2/login
|
|
- ZITADEL_SERVICE_USER_TOKEN_FILE=/current-dir/login-client.pat
|
|
network_mode: service:zitadel
|
|
user: "0"
|
|
volumes:
|
|
- .:/current-dir:ro
|
|
depends_on:
|
|
zitadel:
|
|
condition: service_healthy
|
|
restart: false
|
|
|
|
db:
|
|
restart: unless-stopped
|
|
image: postgres:17
|
|
environment:
|
|
PGUSER: postgres
|
|
POSTGRES_PASSWORD: postgres
|
|
healthcheck:
|
|
test:
|
|
- CMD-SHELL
|
|
- pg_isready
|
|
- -d
|
|
- zitadel
|
|
- -U
|
|
- postgres
|
|
interval: 10s
|
|
timeout: 30s
|
|
retries: 5
|
|
start_period: 20s
|
|
networks:
|
|
- zitadel
|
|
ports:
|
|
- 5432:5432
|
|
volumes:
|
|
- 'data:/var/lib/postgresql/data:rw'
|
|
|
|
networks:
|
|
zitadel:
|
|
|
|
volumes:
|
|
data:
|