Commit Graph
26 Commits
Author SHA1 Message Date
1728297d3c docs(oidc-playground): update scopes and default instance domain (#9995)
# Which Problems Are Solved

This PR resolves #4845 by enhancing the OIDC Playground:
* set default instance domain to `http://localhost:8080`
* openid checkbox is now disabled
* add explanation texts for custom zitadel scopes

# How the Problems Are Solved

* The checkbox for the `openid` scope is set to `disabled`
* The default value for the instance domain is update by using
`setInstance`
* A new map with explanation texts for the custom scopes is introduced.
During the rendering process of the scope checkboxes the value from this
map is displayed, if the scope exists as key.

# Additional Changes

During the local setup of the documentation webapp I got some react
errors on the authrequest page. This issue has ben solved by refactoring
the usage of an `useEffect` block.

# Additional Context

- Closes #4845

PS. 
I did not found any scripts for linting/formatting (e.g. eslint,
prettier) for the docs project. This is a bit annoying because when I
use my local configurations of eslint/prettier the whole file get's
refactored with unnecessary changes (change of import order, indention
etc.). It would be great to add some custom configurations to to make
the development process easier and enforce a consistent coding style :)

Co-authored-by: Markus Heinemann <[email protected]>
Co-authored-by: Tim Möhlmann <[email protected]>
2025-08-04 11:24:54 +00:00
a065ddc706 docs: Make Examples and SDK Pages easier to understand (#7291)
* docs: first attempt to restructure the sdks and examples to make it better understandable

* docs: first attempt to restructure the sdks and examples to make it better understandable

* docs: first attempt to restructure the sdks and examples to make it better understandable

* docs: first attempt to restructure the sdks and examples to make it better understandable

* docs: first attempt to restructure the sdks and examples to make it better understandable

* docs: first attempt to restructure the sdks and examples to make it better understandable

* docs: adding more example pages

* docs: adding more example pages

* docs: add all sdk/examples

* docs: add tile component

* docs: introduction page

* docs: introduction page

* docs: add react

* docs: remove old sdk and example pages

* docs: fix broken links

* docs: fix broken links

* styles

* Update docs/docs/sdk-examples/introduction.mdx

Co-authored-by: Livio Spring <[email protected]>

* Update docs/docs/sdk-examples/java.mdx

Co-authored-by: Livio Spring <[email protected]>

* Update docs/docs/sdk-examples/python.mdx

Co-authored-by: Livio Spring <[email protected]>

* Update docs/docs/sdk-examples/python.mdx

Co-authored-by: Livio Spring <[email protected]>

* docs: review changes

* docs: smaller tiles

* docs: changes from go and java review

* docs: correct python description

* Update docs/docs/sdk-examples/python.mdx

Co-authored-by: Livio Spring <[email protected]>

* Update docs/docs/sdk-examples/introduction.mdx

Co-authored-by: Tim Möhlmann <[email protected]>

* Update docs/docs/sdk-examples/python.mdx

Co-authored-by: Tim Möhlmann <[email protected]>

* docs: flask logo

* flask, rust imgs

* docs: flask logo

* Update go.mdx

* Update java.mdx

* Update docs/docs/sdk-examples/flutter.mdx

Co-authored-by: Livio Spring <[email protected]>

* Update docs/src/css/tile.module.css

Co-authored-by: Livio Spring <[email protected]>

* docs: sidebar alphabetic

* docs: sidebar alphabetic

* docs: django logo

---------

Co-authored-by: peintnermax <[email protected]>
Co-authored-by: Livio Spring <[email protected]>
Co-authored-by: Tim Möhlmann <[email protected]>
Co-authored-by: Stefan Benz <[email protected]>
2024-02-07 12:44:20 +01:00
mffapandGitHub c7e0d979d4 docs: fix broken links (#5959)
* openid connect

* main

* cockroach links
2023-06-01 06:58:14 +02:00
mffapandGitHub bae6e20a91 docs(api): update api path (#5876) 2023-05-17 12:47:55 +00:00
Max PeintnerandGitHub 63c3d05ffd docs: fix urls on homepage (#5501)
fix: add urls on homepage
2023-03-20 09:11:15 +01:00
mffapandGitHub 6da27ef471 docs: links in readme and banner (#5390) 2023-03-07 15:31:05 +01:00
8d4d182c20 docs: proposal restructure (#5318)
* docs: docs structure

* docs: remove sdk from main nav

* docs: fix broken links

* docs: texts

* docs: texts

* docs: react example

* docs: proposal restructure

* remove manual, move troubleshooting

* revmove duplicate item

* identity providers

* broken links and rel paths

* examples wip

* examples

* navigation

* support

* solution scenarios

* concepts

* overview

* Actions caution to info

* suggestions from code review

* remove start command again

* proposed start command (with and without api)

* wip startpage

* startpage

* broken link integrate

* remove get started from nav

* Apply suggestions from code review

Co-authored-by: Elio Bischof <[email protected]>

---------

Co-authored-by: Fabienne <[email protected]>
Co-authored-by: Florian Forster <[email protected]>
Co-authored-by: Elio Bischof <[email protected]>
2023-03-07 09:33:13 +02:00
Florian ForsterandGitHub 77e3d08f22 docs: split out self-hosting into new section (#4903)
* docs: split out self-hosting into section

* check for broken links

* fix netlify proxy forward

* use full path
2022-12-20 11:17:27 +01:00
Florian ForsterandGitHub 5c6971a6a4 chore: replace docs links (#4843)
* chore: replace docs links

* Update index.js

* prettier
2022-12-06 23:09:50 +00:00
Florian ForsterandGitHub 065250a108 chore(docs): fix links for domain migration (#4831)
* chore(docs): fix links for domain migration

* try trailing slash for netlify

* trial

* fix typo

* test path

* try preview proxied

* test local proxy

* try to define the domain with redirect to /docs

* remove build commands

* debug netlify router and fix image link

* working config

* fix analytics
2022-12-06 20:33:13 +01:00
97fe041a86 docs: add tailwindcss for styles, oidc authorize endpoint playground (#4707)
* variable parser

* rm plugin

* set fcn

* env

* EnvCode component

* cleanup env demo

* env

* rm remark plugin

* auth request context

* auth req component

* authorize endpoint construction

* rev react page

* fix endpoint

* styling

* query params with anchor

* desc

* tailwind coexistence

* fix styles

* add login_hint, organizationId scope

* auth request without prompt

* show login_hint

* sync displayed url with actual href

* fix fcn

* coloring

* Update docs/src/components/authrequest.jsx

Co-authored-by: mffap <[email protected]>

* Update docs/src/components/authrequest.jsx

Co-authored-by: mffap <[email protected]>

* Update docs/src/components/authrequest.jsx

Co-authored-by: mffap <[email protected]>

* Update docs/src/components/authrequest.jsx

Co-authored-by: mffap <[email protected]>

* Update docs/src/components/authrequest.jsx

Co-authored-by: mffap <[email protected]>

* Update docs/src/components/authrequest.jsx

Co-authored-by: mffap <[email protected]>

* add plausible, header

* add pkce

* move

* adds pkce code challenge

* replace cboa

* reaname and move to required

* fall back to cboa due to webpack error

* trailing slash

* reorder org_id

* remove resourceowner

* texts

* update references

* buffer, fix some react dom components

* Apply suggestions from code review

Co-authored-by: Florian Forster <[email protected]>

* standard scopes

Co-authored-by: mffap <[email protected]>
Co-authored-by: Florian Forster <[email protected]>
2022-12-05 18:36:12 +01:00
mffapandGitHub f8e0cde0e9 docs: metadata (#4677)
* update description and add metadata

* home de-duplicate
2022-11-08 16:15:12 +01:00
a4bbc756d8 docs: console guide (#4468)
* console guide

* org

* orgs, projects

* applications

* project, roles, authz

* users, roles

* app config, imgs

* policy imgs

* users, metadata, imgs

* actions, projects, structure

* css

* rm overview component

* rm manager from sidebar

* fix some broken links, update 🦖

* fix broken links

* fix img shadow

* Update docs/docs/concepts/structure/applications.md

Co-authored-by: Fabi <[email protected]>

* policy link

* link to projects guide

* Update docs/docs/guides/integrate/application/review-config.mdx

Co-authored-by: Fabi <[email protected]>

* add external org authz guide

* Update docs/docs/guides/manage/console/users.mdx

Co-authored-by: Fabi <[email protected]>

* link to example

* readd manager structure

* punto

* docs: domain settings email as username

* docs: links

* project, application settings, screenshots

* Update docs/docs/guides/manage/console/instance-settings.mdx

Co-authored-by: Fabi <[email protected]>

* Update docs/docs/guides/manage/console/instance-settings.mdx

Co-authored-by: Fabi <[email protected]>

* Update docs/docs/guides/manage/console/instance-settings.mdx

Co-authored-by: Fabi <[email protected]>

* Update docs/docs/guides/manage/console/instance-settings.mdx

Co-authored-by: Fabi <[email protected]>

* Update docs/docs/guides/manage/console/instance-settings.mdx

Co-authored-by: Fabi <[email protected]>

* Update docs/docs/guides/manage/console/instance-settings.mdx

Co-authored-by: Fabi <[email protected]>

* Update docs/docs/guides/manage/console/instance-settings.mdx

Co-authored-by: Fabi <[email protected]>

* Update docs/docs/guides/manage/console/instance-settings.mdx

Co-authored-by: Fabi <[email protected]>

* Update docs/docs/guides/manage/console/instance-settings.mdx

Co-authored-by: Fabi <[email protected]>

* Update docs/docs/guides/manage/console/organizations.mdx

Co-authored-by: Fabi <[email protected]>

* iam role

* Update docs/docs/guides/manage/console/managers.mdx

Co-authored-by: Fabi <[email protected]>

* Update docs/docs/guides/manage/console/managers.mdx

Co-authored-by: Fabi <[email protected]>

* change username text

* Update docs/docs/guides/manage/console/roles.mdx

Co-authored-by: Fabi <[email protected]>

* link example

* branding changes

* Update docs/docs/guides/manage/console/organizations.mdx

good point 👍

Co-authored-by: Fabi <[email protected]>

* docs: loginnames

Co-authored-by: Fabi <[email protected]>
Co-authored-by: Fabienne <[email protected]>
2022-10-06 16:22:46 +02:00
33b8eecba4 chore(docs): update readme and docs for producthunt (#4168)
* readme

* wip

* zitadel.com

* remove pointer events none

Co-authored-by: Max Peintner <[email protected]>
2022-08-12 11:02:18 +02:00
7c49f03d19 docs: welcome gigi (#4159)
* docs: welcome gigi

* light theme

* foreground

* banner on readme

Co-authored-by: mffap <[email protected]>
Co-authored-by: Fabi <[email protected]>
2022-08-11 07:32:50 +00:00
FabiandGitHub b4d948cc75 docs: remove work in progress from token exchange (#4099)
* docs: remove work in progress from token exchange

* docs: broken links

* docs: broken links
2022-08-03 09:11:27 +02:00
9ed972f308 docs: fix broken links on startpage (#4073)
Co-authored-by: Florian Forster <[email protected]>
2022-07-29 09:08:38 +00:00
3c3bce1a6b docs: improve documentation for v2 release (#4046)
* WIP: docs(proxy): describe proxy settings

* fix nginx

* refactor (docs): deploy and operate sections

* chore: ignore package-lock since we use yarn

* chore: update to rc1

* chore: broken links

* chore: update yarn

* docs: move disclaimer to bottom

* chore: fix broken links

* Update docs/docs/guides/operate/tls_modes.mdx

Co-authored-by: Fabi <[email protected]>

* test caddy files

* syntax highlight

* traefik example

* refactor: docs

* refactor

* working state

* got a working state

* remove bar

* mark rate limits for update

* remove zitadel.ch

* fix cases

* docs: zitadel quickstart

* docs: zitadel quickstart

* docs: create app and project

* docs: move customer portal docs to guides manage cloud

* docs: move customer portal docs to guides manage cloud

* docs: move customer portal docs to guides manage cloud

* docs: add help me choose in the quickstart

* docs: broken links

* fix broken links

* Update knative guide

* styling

* docs: support customer portal

* update to main instead v2-alpha

* use version 2 tag

* docs: images

* docs: move authentication and authorization guides to integrate

* docs: quickstart use examples

* docs: lb example

* fix broken link

* docs: update userinfo endpoints

* docs: update userinfo endpoints

* fix oidc endpoint

* docs: remove unused endpoints in app.module

Co-authored-by: Fabi <[email protected]>
Co-authored-by: Fabienne <[email protected]>
Co-authored-by: Livio Amstutz <[email protected]>
2022-07-29 10:13:45 +02:00
Elio BischofandGitHub f3d9c45174 docs(installation): fix overview items (#3880)
* docs(installation): fix overview items

* installation after getting started

* fix broken links

* fix broken links

* fix broken link
2022-06-30 16:06:01 +02:00
Florian ForsterandGitHub 166d07e971 docs: improve small details (#3687)
* docs: improve docs

* fix broken link
2022-05-21 10:35:45 +00:00
68827dfdcd docs: styling, concepts cleanup (#2643)
* Architecture Scenarios B2B B2C

* b2b b2c

* cleanup concepts

* homepage links, b2c docs

* b2c, new homepage, custom components

* more content

* fix rxjs

* temp remove architecture scenarios

* temp remove architecture scenarios

* Update docs/src/pages/index.js

Co-authored-by: Florian Forster <[email protected]>

* update docusaurus & review scenarios

* refactor user login guide (#2921)

* Update docs/docs/guides/architecture-scenarios/b2b.mdx

Co-authored-by: Fabi <[email protected]>

* Update docs/docs/guides/architecture-scenarios/b2b.mdx

Co-authored-by: Fabi <[email protected]>

* Update docs/docs/guides/architecture-scenarios/b2b.mdx

Co-authored-by: Fabi <[email protected]>

* Update docs/docs/guides/architecture-scenarios/b2b.mdx

Co-authored-by: Fabi <[email protected]>

* Update docs/docs/guides/architecture-scenarios/b2c.mdx

Co-authored-by: Fabi <[email protected]>

* Update docs/docs/guides/architecture-scenarios/b2c.mdx

Co-authored-by: Fabi <[email protected]>

* Update docs/docs/guides/architecture-scenarios/b2b.mdx

Co-authored-by: mffap <[email protected]>

* Update docs/docs/guides/architecture-scenarios/b2b.mdx

Co-authored-by: mffap <[email protected]>

* Update docs/docs/guides/architecture-scenarios/b2b.mdx

Co-authored-by: mffap <[email protected]>

* Update docs/docs/guides/architecture-scenarios/b2c.mdx

Co-authored-by: mffap <[email protected]>

* Update docs/docs/guides/architecture-scenarios/b2c.mdx

Co-authored-by: mffap <[email protected]>

* Update docs/docs/guides/architecture-scenarios/b2c.mdx

Co-authored-by: Fabi <[email protected]>

* user-login splitup

* files

* organize files

* cleanup authmethods

* solution scenarios

* add link to authz

* Update docs/docs/guides/authentication/authmethods/implicit.mdx

Co-authored-by: Livio Amstutz <[email protected]>

* Update docs/docs/guides/authentication/authmethods/implicit.mdx

Co-authored-by: Livio Amstutz <[email protected]>

* fix broken links

* Update docs/docs/guides/solution-scenarios/b2c.mdx

Co-authored-by: Florian Forster <[email protected]>

* c for consumer

Co-authored-by: Florian Forster <[email protected]>
Co-authored-by: Fabi <[email protected]>
Co-authored-by: mffap <[email protected]>
Co-authored-by: Livio Amstutz <[email protected]>
2022-01-11 20:48:13 +01:00
Max PeintnerandGitHub 13d0a9754c docs: quickstart, guides overview (#2524)
* fix: components, styles

* col component

* list components, change contents

* fix link
2021-10-18 19:37:29 +00:00
c8d59ee488 docs: restructure and add more content (#2232)
* docs: restructure quickstarts

* docs: quickstart libs

* docs: add exlixir lib

* docs: restructure

* docs: restructure

* docs: customization

* use tabs in oauth/oidc endpoints.md

* improve authorize_endpoint

* improve token_endpoint and introspection_endpoint

* docs: saas use case

* styling

* styling

* begin login users

* login users

* login users

* fix table

* fix: links

* fix: links

* start go api

* fix: policy structure

* fix: saas description

* fix: saas description

* fix: saas description

* Update docs/docs/concepts/policies.md

Co-authored-by: mffap <[email protected]>

* Update docs/docs/concepts/usecases/saas.md

Co-authored-by: mffap <[email protected]>

* Update docs/docs/concepts/usecases/saas.md

Co-authored-by: mffap <[email protected]>

* Update docs/docs/concepts/usecases/saas.md

Co-authored-by: mffap <[email protected]>

* Update docs/docs/concepts/usecases/saas.md

Co-authored-by: mffap <[email protected]>

* Update docs/docs/concepts/usecases/saas.md

Co-authored-by: mffap <[email protected]>

* Update docs/docs/concepts/usecases/saas.md

Co-authored-by: mffap <[email protected]>

* Update docs/docs/concepts/usecases/saas.md

Co-authored-by: mffap <[email protected]>

* Update docs/docs/concepts/usecases/saas.md

Co-authored-by: mffap <[email protected]>

* Update docs/docs/concepts/usecases/saas.md

Co-authored-by: mffap <[email protected]>

* docs: organisation --> organization

* docs: fixes

* docs: fixes

* Update docs/docs/apis/openidoauth/endpoints.md

Co-authored-by: Florian Forster <[email protected]>

* Update docs/docs/concepts/policies.md

Co-authored-by: Florian Forster <[email protected]>

* Update docs/docs/concepts/policies.md

Co-authored-by: Florian Forster <[email protected]>

* Update docs/docs/concepts/policies.md

Co-authored-by: Florian Forster <[email protected]>

* Update docs/docs/apis/openidoauth/endpoints.md

Co-authored-by: Florian Forster <[email protected]>

* Apply suggestions from code review

Co-authored-by: Florian Forster <[email protected]>

* docs: intro

* Update docs/docs/guides/customization/branding.md

Co-authored-by: Florian Forster <[email protected]>

* fix: typo

* add mermaid

Co-authored-by: Livio Amstutz <[email protected]>
Co-authored-by: mffap <[email protected]>
Co-authored-by: Florian Forster <[email protected]>
2021-09-23 10:34:06 +02:00
c0878e4509 feat(operator): make running ZITADEL easy (#1562)
* docs: describe crd mode

* docs: fix links

* docs: fix commands and crdb resources

* feat: add configure command

* chore: use latest ORBOS

* chore: use latest ORBOS

* docs: start gitops docs

* fix: compile

* chore: fix build script path

* chore: remove redundant prebuild

* chore: add configure.go

* docs: describe gitops mode

* docs: point template links to main branch

* docs: fix versions

* feat: initialize empty keys

* feat: reconfigure running ZITADEL

* docs: describe crd mode

* docs: fix links

* docs: fix commands and crdb resources

* feat: add configure command

* chore: use latest ORBOS

* chore: use latest ORBOS

* docs: start gitops docs

* fix: compile

* chore: fix build script path

* chore: remove redundant prebuild

* chore: add configure.go

* docs: describe gitops mode

* docs: point template links to main branch

* docs: fix versions

* feat: initialize empty keys

* feat: reconfigure running ZITADEL

* test: fix

* docs: keys are generated with configure

* docs: remove keys from template

* chore: pass compile time data

* chore: use latest ORBOS

* fix: when in-cluster, use in-cluster k8s client

* fix: try in-cluster config if kubeconfig is empty

* fix: reduce unneeded side effects for configure command

* docs: boom version

* chore: use latest ORBOS

* chore: use latest ORBOS

* initial commit

* inital changes

* commit WIP Information Architecture

* commit a working state

* add static assets and project

* add org and fix img names

* add plausible

* remove img

* change sidebar to easier mgmt

* add openid oauth and domains

* lint md

* quickstarts

* add auth flow

* identity brokering

* remove site

* fix broken links

* extend footer

* extend readme

* fix: styling

* fix: zitadel logo on index

* styling

* border

* fix: nav

* fix: nav

* fix: index

* fix: corrected zitadelctl examples

* fix: rename architecture to concepts

* fix: introductions

* fix: introductions

* fix: introductions

* docs: cli r/w secrets examples

* docs: finish ZITADEL Enterprise Cloud

* docs: mention ZITADEL Enterprise Cloud tier

* docs: comment configuration options

* docs: fix broken links

* docs: move some introduction texts around

* docs: twilio and email are mandatory

* docs: download latest binaries

Co-authored-by: Florian Forster <[email protected]>
Co-authored-by: fabi <[email protected]>
Co-authored-by: Livio Amstutz <[email protected]>
Co-authored-by: Stefan Benz <[email protected]>
2021-04-22 16:43:34 +00:00
12f128e3c5 docs: api request descriptions (#1637)
* doc: api descriptions

* doc: management description

* doc: message validation

* doc: api descriptions

* doc: api descriptions

* doc: description

* doc: index images

* doc: design

* colors, colors and more colors

* margin

* fix comment

* doc: api descriptions

* doc: empty response

* doc: api descriptions

* fix comment

Co-authored-by: Livio Amstutz <[email protected]>
2021-04-22 12:59:17 +00:00
dfc9488bb5 docs: rework documentation site (#1589)
* initial commit

* inital changes

* commit WIP Information Architecture

* commit a working state

* add static assets and project

* add org and fix img names

* add plausible

* remove img

* change sidebar to easier mgmt

* add openid oauth and domains

* lint md

* quickstarts

* add auth flow

* identity brokering

* remove site

* fix broken links

* extend footer

* extend readme

* fix: styling

* fix: zitadel logo on index

* styling

* border

* fix: nav

* fix: nav

* fix: index

* fix: rename architecture to concepts

* fix: introductions

* fix: introductions

* fix: introductions

* fix: get started

* fix: user manual

* fix: zitadel architecture

* fix: dead links

* add favicon

Co-authored-by: fabi <[email protected]>
Co-authored-by: Livio Amstutz <[email protected]>
2021-04-15 13:22:37 +02:00