Skip to content

chore: common admonitions for support #2215

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open
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
2 changes: 2 additions & 0 deletions docs/_common/api-key-needed.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
An API Key is required for all administrative operations. Read
[Authorization with API Keys](https://www.ory.sh/docs/concepts/personal-access-token) to learn more.
6 changes: 6 additions & 0 deletions docs/_common/need-help.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
:::info Need help?

- New to Ory? [Talk to the team](https://www.ory.sh/contact) about features and plans.
- Already a customer? [Open a support ticket](https://console.ory.sh/support).

:::
6 changes: 6 additions & 0 deletions docs/_common/need-selfhosted-support.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
:::info Professional support?

Ory offers support for self-hosted Ory software through the Ory Enterprise License (OEL). Read more about the OEL
[here](https://www.ory.sh/docs/self-hosted/oel).

:::
File renamed without changes.
13 changes: 6 additions & 7 deletions docs/ecosystem/changelog.md → docs/ecosystem/changelog.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,18 @@ title: Changelog and roadmap

## Ory Changelog

```mdx-code-block
import Help from '@site/docs/_common/need-selfhosted-support.mdx'

<Help/>
```

Read the changelog for Ory Network at [changelog.ory.sh](https://changelog.ory.sh/) !

> Running security-critical open source technology in a self-service format requires vigilance. We make your life easier by
> announcing important software updates via the [Ory Security Newsletter](https://www.ory.sh/l/sign-up-newsletter). Never miss an
> update and **[sign up now to important release updates!](https://www.ory.sh/l/sign-up-newsletter)**

:::tip

Looking for support? Please contact us at support@ory.sh!
Ory offers support agreements for self-hosted Ory software.

:::

## Changelogs

- [Ory Network Changelog](https://changelog.ory.sh/)
Expand Down
File renamed without changes.
File renamed without changes.
186 changes: 75 additions & 111 deletions docs/ecosystem/contributing.md → docs/ecosystem/contributing.mdx

Large diffs are not rendered by default.

File renamed without changes.
File renamed without changes.
File renamed without changes.
6 changes: 6 additions & 0 deletions docs/hydra/self-hosted/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ title: Quickstart

# Ory Hydra OAuth2 Server Quickstart

```mdx-code-block
import Help from '@site/docs/_common/need-selfhosted-support.mdx'

<Help/>
```

In this quickstart, you will set up Ory Hydra OAuth2 & OpenID Connect Server and an exemplary User Login & Consent App using
Docker Compose. You need to have the latest [Docker](https://www.docker.com) and [Docker Compose](https://docs.docker.com/compose)
version and Git installed, as well as [`jq`](https://stedolan.github.io/jq/download/).
Expand Down
2 changes: 1 addition & 1 deletion docs/identities/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_label: Introduction

Ory Kratos Identities is an API-first identity and user management system built on top of the widely deployed open-source
[Ory Kratos](https://github.com/ory/kratos) following
[cloud architecture best practices](ecosystem/software-architecture-philosophy.md). It implements mechanisms that allow handling
[cloud architecture best practices](ecosystem/software-architecture-philosophy.mdx). It implements mechanisms that allow handling
core use cases that the majority of modern software applications have to deal with:

- **Self-service login and registration**: Allow end-users to create and sign in to accounts using username/email and password
Expand Down
10 changes: 6 additions & 4 deletions docs/keto/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,22 @@
title: "Quickstart: Cat Videos Example"
---

```mdx-code-block
import Help from '@site/docs/_common/need-selfhosted-support.mdx'

<Help/>
```

This example describes a video sharing service. The individual videos are organized in directories. Every directory has an owner
and every video has the same owner as it's parent directory. The owner has elevated privileges about the video files that aren't
modeled individually in Ory Keto. The only other privilege modeled in this example is "view access." Every owner has view access
to their objects, and this privilege can be granted to other users as well. The video sharing application interprets the special
`*` user ID as any user, including anonymous users. Note that Ory Keto doesn't interpret this subject any differently from other
subjects. It also doesn't know anything about directory structures or induced ownership.

:::info Terminology

The "Keto client" is the application interacting with Keto. In this case we refer to the video sharing service backend as the Keto
client.

:::

## Starting the example

First, [install Keto](./install.mdx).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,15 @@ for end-users.

## Multiple custom domains

With the _Multibrand_ feature enabled for your workspace, you can add multiple custom domains to each Ory Network project. You can
With the Multibrand feature enabled for your workspace, you can add multiple custom domains to each Ory Network project. You can
add a different custom UI base URL of each of the custom domains registered in the project. This allows for a high degree of
flexibility, where each of the domains serves its own set of UI views that have a common path makeup but different base URL.

Are you interested in the Multibrand feature ? [Ory is here to help!](https://www.ory.sh/contact)
```mdx-code-block
import Help from '@site/docs/_common/need-help.mdx'

<Help/>
```

In practical terms, this means that you can serve different UI views to customers that interact with different parts of your
business, while still allowing them to conveniently use one account that's managed by your Ory Network project.
Expand Down
9 changes: 4 additions & 5 deletions docs/kratos/manage-identities/50_scim.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,11 @@ title: SCIM

# System for Cross-domain Identity Management

:::info

SCIM provisioning is only available in Ory Network and via the Ory Enterprise License (OEL). If you have any questions, please
[reach out](https://www.ory.sh/contact/).
```mdx-code-block
import Help from '@site/docs/_common/need-help.mdx'

:::
<Help/>
```

SCIM (System for Cross-domain Identity Management) is a standard for automating the exchange of user identity information between
identity domains or IT systems. It is designed to simplify the management of user identities in cloud-based applications and
Expand Down
10 changes: 4 additions & 6 deletions docs/kratos/organizations/organizations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,11 @@ title: B2B SSO & SAML

# B2B Single Sign-On & SAML

:::info

Organizations are only available in Ory Network and are not supported in self-hosted Ory Kratos. If you have any questions, or if
you would like more information about transitioning to Ory Network, please don't hesitate to
[reach out](https://www.ory.sh/contact/).
```mdx-code-block
import Help from '@site/docs/_common/need-help.mdx'

:::
<Help/>
```

```mdx-code-block
import webm from './_static/organizations-ory-network.webm'
Expand Down
6 changes: 6 additions & 0 deletions docs/kratos/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ title: Quickstart

# Ory Kratos Identity Server Quickstart

```mdx-code-block
import Help from '@site/docs/_common/need-selfhosted-support.mdx'

<Help/>
```

import Mermaid from "@site/src/theme/Mermaid"
import CodeFromRemote from "@site/src/theme/CodeFromRemote"

Expand Down
10 changes: 4 additions & 6 deletions docs/migrate-to-ory/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -270,10 +270,8 @@ live with Ory in your production environment.

Once your Ory integration is stable and users are successfully authenticating with the new system, your migration is complete.

:::info

Ory is here to help! To get support in your migration beyond this guide join the [Ory Community Slack](https://slack.ory.sh/) and
get support from the community. Or contact us for a [free consultation](https://ory.sh/contact) and get expert help from the Ory
Team.
```mdx-code-block
import Help from '@site/docs/_common/need-help.mdx'

:::
<Help/>
```
4 changes: 2 additions & 2 deletions docs/oathkeeper/configure-deploy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ title: Configure and deploy

The Ory Oathkeeper HTTP serve process `oathkeeper serve` opens two ports exposing the

- [reverse proxy](index.md#reverse-proxy)
- REST API which serves the [Access Control Decision API](index.md#access-control-decision-api) as well as other API endpoints
- [reverse proxy](index.mdx#reverse-proxy)
- REST API which serves the [Access Control Decision API](index.mdx#access-control-decision-api) as well as other API endpoints
such as health checks, JSON Web Key Sets, and a list of available rules.

For this guide we're using Docker. Ory Oathkeeper however can be [installed in a variety of ways](install.mdx).
Expand Down
2 changes: 1 addition & 1 deletion docs/oathkeeper/guides/traefik-proxy-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: Traefik proxy integration

[Traefik](https://doc.traefik.io/traefik/) is modern HTTP proxy and load balancer for microservices, oathkeeper can be integrated
with via the [ForwardAuth Middleware](https://doc.traefik.io/traefik/middlewares/http/forwardauth/) by making use of the available
[Access Control Decision API](../index.md#access-control-decision-api).
[Access Control Decision API](../index.mdx#access-control-decision-api).

To achieve this,

Expand Down
6 changes: 6 additions & 0 deletions docs/oathkeeper/index.md → docs/oathkeeper/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,12 @@ id: index
title: Introduction to Ory Oathkeeper Zero Trust Proxy
---

```mdx-code-block
import Help from '@site/docs/_common/need-selfhosted-support.mdx'

<Help/>
```

Ory Oathkeeper authorizes incoming HTTP requests. It can be the Policy Enforcement Point in your cloud architecture, i.e. a
reverse proxy in front of your upstream API or web server that rejects unauthorized requests and forwards authorized ones to your
server. If you want to use another API Gateway (Kong, Nginx, Envoy, AWS API Gateway, ...), Oathkeeper can also plug into that and
Expand Down
4 changes: 2 additions & 2 deletions docs/oauth2-oidc/overview/oauth2-concepts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -260,8 +260,8 @@ access to protected resources. To achieve this, the resource server uses the OAu

## Resource Owner Password Credentials flow

Ory doesn't support the resource owner Password Credentials Grant Type as we prepare for [OAuth 2.1](https://oauth.net/2.1/) which
removed this grant type.
Ory supports the resource owner Password Credentials Grant Type only in special cases as we prepare for
[OAuth 2.1](https://oauth.net/2.1/) which removed this grant type.

## Implicit flow

Expand Down
9 changes: 4 additions & 5 deletions docs/oauth2-oidc/resource-owner-password-grant.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,11 @@ title: OAuth2 resource owner password credentials grant
sidebar_label: Resource owner password flow
---

:::info

The resource owner password credentials grant is a legacy grant that Ory Network only supports for enterprise customers. Please
contact [sales@ory.sh](mailto:sales@ory.sh) for support.
```mdx-code-block
import Help from '@site/docs/_common/need-help.mdx'

:::
<Help/>
```

The OAuth 2.0 Resource Owner Password Credentials Grant is an OAuth 2.0 grant where the application exchanges the user's username
and password for an access token. This grant type suits clients highly trusted by the user, such as their computer operating
Expand Down
6 changes: 3 additions & 3 deletions docs/open-source.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,10 @@ For many more visit [Ory on GitHub](https://github.com/ory).

## Open source resources

- [Contribute to Ory](./ecosystem/contributing.md)
- [Contribute to Ory](./ecosystem/contributing.mdx)
- [Ory is committed to open source](./open-source/commitment.mdx)
- [Ory architecture principles](./ecosystem/software-architecture-philosophy.md)
- [Community resources in the Ory documentation](./ecosystem/community.md)
- [Ory architecture principles](./ecosystem/software-architecture-philosophy.mdx)
- [Community resources in the Ory documentation](./ecosystem/community.mdx)
- [Ory Community Chat](https://slack.ory.sh/)
- [GitHub discussions](https://github.com/discussions?discussions_q=org%3Aory)
- [Ory Community Examples](https://github.com/ory/examples)
Expand Down
6 changes: 6 additions & 0 deletions docs/polis/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ title: Quickstart

# Get started with SAML Single Sign-On authentication

```mdx-code-block
import Help from '@site/docs/_common/need-selfhosted-support.mdx'

<Help/>
```

Ory Polis can be used with any web application to integrate Single Sign-On (SSO) authentication.

There are two ways to integrate Ory Polis with an application. Depending on your use case, you can choose either one of them.
Expand Down
Loading