From 91fd278d1a6720576998b115dedb882b90915561 Mon Sep 17 00:00:00 2001 From: aeneasr <3372410+aeneasr@users.noreply.github.com> Date: Mon, 5 Oct 2020 10:39:31 +0200 Subject: [PATCH] docs: add guide for cors --- docs/docs/guides/setting-up-cors.mdx | 31 ++++ docs/sidebar.json | 259 ++++++++++++++------------- 2 files changed, 168 insertions(+), 122 deletions(-) create mode 100644 docs/docs/guides/setting-up-cors.mdx diff --git a/docs/docs/guides/setting-up-cors.mdx b/docs/docs/guides/setting-up-cors.mdx new file mode 100644 index 00000000000..10afa6a70ca --- /dev/null +++ b/docs/docs/guides/setting-up-cors.mdx @@ -0,0 +1,31 @@ +--- +id: setting-up-cors +title: Setting up Cross-origin resource sharing (CORS) +--- + +ORY Kratos' Public API supports CORS out of the box. A reference for this configuration +can be found in the [Configuration Reference](../reference/configuration.md). + +For CORS to work properly, we encourage to set the following values: + +```yaml +serve: + public: + cors: + enabled: true + allowed_origins: + - https://example.org + - https://*.example.org + allowed_methods: + - POST + - GET + - PUT + - PATCH + - DELETE + allowed_headers: + - Authorization + - Cookie + exposed_headers: + - Content-Type + - Set-Cookie +``` diff --git a/docs/sidebar.json b/docs/sidebar.json index 9ddfb8c7800..9488bee8f53 100644 --- a/docs/sidebar.json +++ b/docs/sidebar.json @@ -1,160 +1,169 @@ { - "Introduction": ["index", "quickstart", "install", "configuring"], + "Introduction": [ + "index", + "quickstart", + "install", + "configuring" + ], "Concepts": [ - "concepts/index", - "concepts/terminology", - "concepts/ui-user-interface", - "concepts/identity-user-model", + "concepts/index", + "concepts/terminology", + "concepts/ui-user-interface", + "concepts/identity-user-model", { "label": "Identity Credentials", "type": "category", "items": [ - "concepts/credentials", - "concepts/credentials/username-email-password", + "concepts/credentials", + "concepts/credentials/username-email-password", "concepts/credentials/openid-connect-oidc-oauth2" ] - }, - "concepts/browser-redirect-flow-completion", - "concepts/email-sms", - "concepts/rest-api", - "concepts/federation", + }, + "concepts/browser-redirect-flow-completion", + "concepts/email-sms", + "concepts/rest-api", + "concepts/federation", "concepts/security" ], "Self Service (End-User)": [ - "self-service", - "self-service/flows/user-registration", - "self-service/flows/user-login", - "self-service/flows/user-settings", - "self-service/flows/account-recovery", - "self-service/flows/verify-email-account-activation", - "self-service/flows/user-logout", - "self-service/flows/user-facing-errors", - "self-service/flows/2fa-mfa-multi-factor-authentication", + "self-service", + "self-service/flows/user-registration", + "self-service/flows/user-login", + "self-service/flows/user-settings", + "self-service/flows/account-recovery", + "self-service/flows/verify-email-account-activation", + "self-service/flows/user-logout", + "self-service/flows/user-facing-errors", + "self-service/flows/2fa-mfa-multi-factor-authentication", "self-service/hooks" ], - "Administration": ["admin/managing-users-identities"], + "Administration": [ + "admin/managing-users-identities" + ], "Guides": [ - "guides/sign-in-with-github-google-facebook-linkedin", - "guides/zero-trust-iap-proxy-identity-access-proxy", - "guides/account-recovery-password-reset", - "guides/account-activation-email-verification", - "guides/multi-tenancy-multitenant", - "guides/configuring-cookies", - "guides/login-session", - "guides/secret-key-rotation", - "guides/high-availability-ha", + "guides/sign-in-with-github-google-facebook-linkedin", + "guides/react-native-login-registration", + "guides/login-session", + "guides/configuring-cookies", + "guides/setting-up-cors", + "guides/account-recovery-password-reset", + "guides/account-activation-email-verification", + "guides/zero-trust-iap-proxy-identity-access-proxy", + "guides/multi-tenancy-multitenant", + "guides/secret-key-rotation", + "guides/high-availability-ha", "guides/docker" ], "Reference": [ - "reference/configuration", - "reference/json-schema-json-paths", - "reference/html-forms", - "reference/api", + "reference/configuration", + "reference/json-schema-json-paths", + "reference/html-forms", + "reference/api", { "items": [ - "cli/kratos", - "cli/kratos-identities", - "cli/kratos-identities-delete", - "cli/kratos-identities-get", - "cli/kratos-identities-import", - "cli/kratos-identities-list", - "cli/kratos-identities-patch", - "cli/kratos-identities-validate", - "cli/kratos-jsonnet", - "cli/kratos-jsonnet-format", - "cli/kratos-jsonnet-lint", - "cli/kratos-remote", - "cli/kratos-remote-status", + "cli/kratos", + "cli/kratos-identities", + "cli/kratos-identities-delete", + "cli/kratos-identities-get", + "cli/kratos-identities-import", + "cli/kratos-identities-list", + "cli/kratos-identities-patch", + "cli/kratos-identities-validate", + "cli/kratos-jsonnet", + "cli/kratos-jsonnet-format", + "cli/kratos-jsonnet-lint", + "cli/kratos-remote", + "cli/kratos-remote-status", "cli/kratos-remote-version" ] - }, + }, { "items": [ - "cli/kratos", - "cli/kratos-identities", - "cli/kratos-identities-delete", - "cli/kratos-identities-get", - "cli/kratos-identities-list", - "cli/kratos-identities-patch", - "cli/kratos-identities-put", - "cli/kratos-identities-validate", - "cli/kratos-jsonnet", - "cli/kratos-jsonnet-format", - "cli/kratos-jsonnet-lint", - "cli/kratos-remote", - "cli/kratos-remote-status", + "cli/kratos", + "cli/kratos-identities", + "cli/kratos-identities-delete", + "cli/kratos-identities-get", + "cli/kratos-identities-list", + "cli/kratos-identities-patch", + "cli/kratos-identities-put", + "cli/kratos-identities-validate", + "cli/kratos-jsonnet", + "cli/kratos-jsonnet-format", + "cli/kratos-jsonnet-lint", + "cli/kratos-remote", + "cli/kratos-remote-status", "cli/kratos-remote-version" ] - }, + }, { "items": [ - "cli/kratos", - "cli/kratos-identities", - "cli/kratos-identities-delete", - "cli/kratos-identities-get", - "cli/kratos-identities-import", - "cli/kratos-identities-list", - "cli/kratos-identities-patch", - "cli/kratos-identities-validate", - "cli/kratos-jsonnet", - "cli/kratos-jsonnet-format", - "cli/kratos-jsonnet-lint", - "cli/kratos-remote", - "cli/kratos-remote-status", + "cli/kratos", + "cli/kratos-identities", + "cli/kratos-identities-delete", + "cli/kratos-identities-get", + "cli/kratos-identities-import", + "cli/kratos-identities-list", + "cli/kratos-identities-patch", + "cli/kratos-identities-validate", + "cli/kratos-jsonnet", + "cli/kratos-jsonnet-format", + "cli/kratos-jsonnet-lint", + "cli/kratos-remote", + "cli/kratos-remote-status", "cli/kratos-remote-version" ] - }, + }, { "items": [ - "cli/kratos", - "cli/kratos-identities", - "cli/kratos-identities-delete", - "cli/kratos-identities-get", - "cli/kratos-identities-import", - "cli/kratos-identities-list", - "cli/kratos-identities-patch", - "cli/kratos-identities-validate", - "cli/kratos-jsonnet", - "cli/kratos-jsonnet-format", - "cli/kratos-jsonnet-lint", - "cli/kratos-remote", - "cli/kratos-remote-status", + "cli/kratos", + "cli/kratos-identities", + "cli/kratos-identities-delete", + "cli/kratos-identities-get", + "cli/kratos-identities-import", + "cli/kratos-identities-list", + "cli/kratos-identities-patch", + "cli/kratos-identities-validate", + "cli/kratos-jsonnet", + "cli/kratos-jsonnet-format", + "cli/kratos-jsonnet-lint", + "cli/kratos-remote", + "cli/kratos-remote-status", "cli/kratos-remote-version" ] - }, + }, { "items": [ - "cli/kratos", - "cli/kratos-identities", - "cli/kratos-identities-delete", - "cli/kratos-identities-get", - "cli/kratos-identities-import", - "cli/kratos-identities-list", - "cli/kratos-identities-patch", - "cli/kratos-identities-validate", - "cli/kratos-jsonnet", - "cli/kratos-jsonnet-format", - "cli/kratos-jsonnet-lint", - "cli/kratos-remote", - "cli/kratos-remote-status", + "cli/kratos", + "cli/kratos-identities", + "cli/kratos-identities-delete", + "cli/kratos-identities-get", + "cli/kratos-identities-import", + "cli/kratos-identities-list", + "cli/kratos-identities-patch", + "cli/kratos-identities-validate", + "cli/kratos-jsonnet", + "cli/kratos-jsonnet-format", + "cli/kratos-jsonnet-lint", + "cli/kratos-remote", + "cli/kratos-remote-status", "cli/kratos-remote-version" ] - }, + }, { "items": [ - "cli/kratos", - "cli/kratos-identities", - "cli/kratos-identities-delete", - "cli/kratos-identities-get", - "cli/kratos-identities-import", - "cli/kratos-identities-list", - "cli/kratos-identities-patch", - "cli/kratos-identities-validate", - "cli/kratos-jsonnet", - "cli/kratos-jsonnet-format", - "cli/kratos-jsonnet-lint", - "cli/kratos-remote", - "cli/kratos-remote-status", + "cli/kratos", + "cli/kratos-identities", + "cli/kratos-identities-delete", + "cli/kratos-identities-get", + "cli/kratos-identities-import", + "cli/kratos-identities-list", + "cli/kratos-identities-patch", + "cli/kratos-identities-validate", + "cli/kratos-jsonnet", + "cli/kratos-jsonnet-format", + "cli/kratos-jsonnet-lint", + "cli/kratos-remote", + "cli/kratos-remote-status", "cli/kratos-remote-version" ] }, @@ -177,11 +186,17 @@ ] } ], - "Debug & Help": ["debug/csrf"], - "SDKs": ["sdk"], - "Development": ["milestones"], + "Debug & Help": [ + "debug/csrf" + ], + "SDKs": [ + "sdk" + ], + "Development": [ + "milestones" + ], "Further Reading": [ - "further-reading/comparison", + "further-reading/comparison", "further-reading/kratos-video-tutorials" ] }