Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 17 additions & 10 deletions docs/account-experience/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,19 +20,26 @@ The Account Experience can be themed using the Ory Console. Head over to the
[theming settings](https://console.ory.sh/projects/current/account-experience/theming). It is also possible to set a custom logo
and favicon.

## Welcome Screen

The Account Experience comes with a welcome screen that shows information about the current user's session. As this screen is
rather meant for debugging purposes, it can be disabled in the [Ory Console](https://console.ory.sh/projects/current/ui).

## Translations (i18n) & Message Customization

Currently, the account experience is available in 83 languages. For a full list of available languages please have a look at
[the source](https://github.com/ory/elements/tree/main/packages/elements-react/src/locales). If you want to add a new language or
fix some wording, please open a pull request in [ory/elements](https://github.com/ory/elements#internalization-i18n). To determine
the language to use, the Account Experience uses the `Accept-Language` header. If the language is not available, the fallback
language (English) is used. Custom translations are not supported at the moment, but please reach out if you need this feature.
fix some wording, please open a pull request in [ory/elements](https://github.com/ory/elements#internalization-i18n).

By default, the Account Experience automatically adapts to the user's language preferences, and offers translations for all
supported languages. Each language can be enabled or disabled in the Ory Console
under&nbsp;<ConsoleLink route="project.accountExperience.locales" />.

To determine the language to use, the Account Experience uses the `Accept-Language` header. If the language is not available, the
Default Language (English) is used. To change the default language, go
to&nbsp;<ConsoleLink route="project.accountExperience.locales" /> and select your preferred default language.

To turn off automatic language detection, disable **Respect the user's system language preferences** in the Ory Console
under&nbsp;<ConsoleLink route="project.accountExperience.locales" />.

## Custom Domains
### Custom locales

The Account Experience is also available under custom domains the same way it works on the slug URL.
You can customize any of the existing translations or add your own translations in the Ory Console
under&nbsp;<ConsoleLink route="project.accountExperience.locales" />. Click on the edit icon for the language you want to
customize, and then modify the messages as needed. Custom translations will override the default translations provided by Ory
Elements.
2 changes: 1 addition & 1 deletion docs/concepts/redirects.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ The Ory Network has a total of six flows, **Login**, **Registration**, **Verific
which can be configured to redirect back to any URL. A common use case would be to redirect the user to your application home
screen after a logout or to a specific URL on a sub-domain after a settings password update.

On project creation the redirect flows are by default set to the Ory Account Experience pages.
By default, the flows always redirect to the Ory Account Experience pages.

### Login, registration, and settings

Expand Down
4 changes: 2 additions & 2 deletions docs/guides/custom-domains.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -253,8 +253,8 @@ show "Enabled/Disabled".

![Custom Domain Cors enabled](./_static/custom-domains/cname-cors-enabled.png)

Once active, the Ory Account Experience is reachable at `https://<your-custom-domain>/ui/welcome`. Learn how to configure a custom
UI: [Bring Your Own UI](../kratos/bring-your-own-ui/configure-ory-to-use-your-ui).
Once active, the Ory Account Experience is reachable at `https://<your-custom-domain>/login`. Learn how to configure a custom UI:
[Bring Your Own UI](../kratos/bring-your-own-ui/configure-ory-to-use-your-ui).

You may also remove your custom domain from the Console, but please note that **any requests to it will no longer resolve** once
you do.
Expand Down
4 changes: 3 additions & 1 deletion docs/identities/get-started/account-recovery.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,9 @@ feature_flags:
When integrating with the API directly, your applications must send and receive these fields. Refer to the
[API documentation](../../reference/api#tag/frontend/operation/updateRecoveryFlow) for more details.

When using the built-in Account Experience UI, there is nothing special to do. Otherwise, you need to do some changes.
When using the built-in Ory Account Experience, no changes are needed in your application code.

If you're using a custom UI, ensure that your recovery forms handle the new fields appropriately:

New fields have been added to the payload when getting and updating the recovery flow that are exclusively used when this feature
flag is enabled:
Expand Down
4 changes: 2 additions & 2 deletions docs/identities/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ the Ory documentation. Read [more here](../kratos/manage-identities/01_overview.
Identity is a hard problem that Ory Identities solves in a unique way. Ory values security, flexibility, and integration with
cloud technology such as Kubernetes the most:

- Ory Identities doesn't ship an HTML Rendering Engine. You use the Ory Account Experience available in Ory Network or build your
own UI in the language and framework you feel most comfortable with.
- Ory Identities doesn't ship an HTML Rendering Engine. You can use the Ory Account Experience available in Ory Network or build
your own UI in the language and framework you feel most comfortable with.
- The workflow engine allows you to fully customize your users' experience. Whether you want users to activate their accounts
after registration, or have a multi-step (progressive) registration process - it's all possible!
- One [identity schema](../kratos/manage-identities/01_overview.mdx) doesn't fit all - you may have customers that need a billing
Expand Down
9 changes: 4 additions & 5 deletions docs/identities/sign-in/identifier-first-authentication.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,11 @@ To enable it:
- 1. Log in to the [Ory Console](https://console.ory.sh).
- 2. Select your project.
- 3. Navigate to <ConsoleLink route="project.accountExperience.theming.route" />.
- 4. Enable "Enable Account Experience 2.0 (preview)".
- 5. Navigate to <ConsoleLink route="project.ui.route" />
- 6. Click "Apply new UI URLs".
- 7. Test the flow in your application by navigating to the login page.
- 4. Disable "Use legacy Hosted UI".
- 5. Test the flow in your application by navigating to the login page.

To revert, follow the same steps, disable "New Account Experience", and click "Reset to Account Experience".
To revert, follow the same steps, enable "Use legacy Hosted UI", and click "Reset to Account Experience" on
the&nbsp;<ConsoleLink route="project.ui" />.

## Self-hosted Ory Kratos

Expand Down
5 changes: 2 additions & 3 deletions docs/intro.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -110,9 +110,8 @@ Ory Console is the management UI of Ory Network.
Ory Account Experience implements screens such as login, registration, account recovery, account setting, and account verification
for fast adoption of Ory.

Contrary to other vendors, Ory allows you to implement your own (login, registration, ...) UI by offering simple, headless APIs.
Use the open-source [Ory Elements](https://github.com/ory/elements) components library for fast integration with frameworks like
ExpressJS, React, or Preact.
Ory allows you to implement your own authentication UI by offering simple, headless APIs. Use the open-source
[Ory Elements](https://github.com/ory/elements) components library for fast integration with frameworks like React and Next.js.

### Ory Actions

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ Configuration URL, go to <ConsoleLink route="project.settings" />, and copy the

:::

By default, self-service flows use [Ory Account Experience](./01_overview.mdx#why-should-i-use-ory-account-experience), which is a
part of every Ory Network project. In the default setup, the system uses relative paths to point to the appropriate UI for every
screen. The relative links that point to the Ory Account Experience follow the `/ui/{flow_name}` format.
By default, self-service flows use [Ory Account Experience](./01_overview.mdx#why-should-i-use-ory-account-experience). In the
default setup, the system uses relative paths to point to the appropriate UI for every screen. The relative links that point to
the Ory Account Experience follow the `/ui/{flow_name}` format.

## Custom domain setup

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ import TabItem from '@theme/TabItem';
<Tabs>
<TabItem value="console" label="Ory Console" default>

Go to <ConsoleLink route="project.oauthConfiguration.identityIntegration" /> and `Enable Override Return To` setting.
Go to <ConsoleLink route="project.settings.advanced" /> and enable the `OAuth2 provider override "return_to` setting.

</TabItem>

Expand Down
72 changes: 49 additions & 23 deletions src/components/ConsoleLink/console-nav-data.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ export const getStartedPaths: Path[] = [
href: routes.project.getStarted.route + "#integrations",
},
{
title: "Guides and Tutorials",
title: "Guides and concepts",
href: routes.project.getStarted.route + "#guides-tutorials",
},
{ title: "Community", href: routes.project.getStarted.route + "#community" },
Expand All @@ -31,15 +31,15 @@ export const getStartedPaths: Path[] = [
export const activityPaths: Path[] = [
{ title: "Live", href: routes.project.activity.route },
{
title: "Logs & Events",
title: "Logs & events",
href: routes.project.activity.events.route,
},
{ title: "Sessions", href: routes.project.sessions.list.route },
{ title: "Email delivery", href: routes.project.courierMessages.route },
{ title: "Message delivery", href: routes.project.courierMessages.route },
]

export const identititesPaths: Path[] = [
{ title: "Users & Identities", href: routes.project.identities.list.route },
{ title: "Users & identities", href: routes.project.identities.list.route },
{ title: "Identity schema", href: routes.project.identitySchema.route },
{
title: "Import users",
Expand All @@ -53,6 +53,10 @@ export const brandingPaths: Path[] = [
title: "Theming",
href: routes.project.accountExperience.theming.route,
},
{
title: "Localization",
href: routes.project.accountExperience.locales.route,
},
{
title: "Custom domains",
href: routes.project.cname.route,
Expand All @@ -65,6 +69,10 @@ export const brandingPaths: Path[] = [
title: "UI URLs",
href: routes.project.ui.route,
},
{
title: "Email templates",
href: routes.project.emailTemplates.route,
},
]

export const authenticationPaths: Path[] = [
Expand All @@ -81,17 +89,23 @@ export const authenticationPaths: Path[] = [
href: routes.project.mfa.route,
},
{
title: "Social Sign-In",
title: "Social Sign-In (OIDC)",
href: routes.project.socialSignIn.route,
},
{
title: "Actions & Webhooks",
href: routes.project.developers.actions.route,
title: "SAML Sign-In",
href: routes.project.saml.route,
pill: "Preview",
},
{
title: "Enterprise SSO",
href: routes.project.authentication.organizations.route,
},

{
title: "Sessions",
href: routes.project.authentication.sessionSettings.route,
},
{
title: "Account recovery",
href: routes.project.recovery.route,
Expand All @@ -101,39 +115,51 @@ export const authenticationPaths: Path[] = [
href: routes.project.verification.route,
},
{
title: "Email configuration",
title: "Email Configuration",
href: routes.project.emailConfiguration.route,
},
{
title: "Email templates",
href: routes.project.emailTemplates.route,
},
{
title: "SMS configuration",
title: "SMS Configuration",
href: routes.project.smsConfiguration.route,
},
{
title: "Sessions",
href: routes.project.authentication.sessionSettings.route,
title: "Actions & Webhooks",
href: routes.project.developers.actions.route,
},
]

export const oauthPaths: Path[] = [
{
title: "Overview",
href: routes.project.oauthConfiguration.overview.route,
title: "Clients and applications",
href: routes.project.oauthConfiguration.route,
},
{
title: "OAuth2 Clients",
href: routes.project.oauthConfiguration.route,
title: "Endpoints",
href: routes.project.oauthConfiguration.endpoints.route,
},
{
title: "Configuration",
title: "General",
href: routes.project.oauthConfiguration.configure.route,
},
{
title: "Identity integration settings",
href: routes.project.oauthConfiguration.identityIntegration.route,
title: "OpenID Connect",
href: routes.project.oauthConfiguration.openid.route,
},
{
title: "URLs",
href: routes.project.oauthConfiguration.urls.route,
},
{
title: "Lifespans",
href: routes.project.oauthConfiguration.lifespans.route,
},
{
title: "Token strategies",
href: routes.project.oauthConfiguration.strategies.route,
},
{
title: "Cookies",
href: routes.project.oauthConfiguration.cookies.route,
},
]

Expand Down Expand Up @@ -217,7 +243,7 @@ export const projectPaths: RootPath[] = [
},
{
title: "OAuth 2",
href: routes.project.oauthConfiguration.overview.route,
href: routes.project.oauthConfiguration.route,
paths: oauthPaths,
},
{
Expand Down
Loading
Loading