diff --git a/docs/_common/api-key-needed.mdx b/docs/_common/api-key-needed.mdx new file mode 100644 index 000000000..a1ff92c89 --- /dev/null +++ b/docs/_common/api-key-needed.mdx @@ -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. diff --git a/docs/_common/need-help.mdx b/docs/_common/need-help.mdx new file mode 100644 index 000000000..2d9f0da0c --- /dev/null +++ b/docs/_common/need-help.mdx @@ -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). + +::: diff --git a/docs/_common/need-selfhosted-support.mdx b/docs/_common/need-selfhosted-support.mdx new file mode 100644 index 000000000..3bc22d150 --- /dev/null +++ b/docs/_common/need-selfhosted-support.mdx @@ -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). + +::: diff --git a/docs/ecosystem/api-design.md b/docs/ecosystem/api-design.mdx similarity index 100% rename from docs/ecosystem/api-design.md rename to docs/ecosystem/api-design.mdx diff --git a/docs/ecosystem/changelog.md b/docs/ecosystem/changelog.mdx similarity index 95% rename from docs/ecosystem/changelog.md rename to docs/ecosystem/changelog.mdx index 5319dce9d..618f80e26 100644 --- a/docs/ecosystem/changelog.md +++ b/docs/ecosystem/changelog.mdx @@ -5,19 +5,18 @@ title: Changelog and roadmap ## Ory Changelog +```mdx-code-block +import Help from '@site/docs/_common/need-selfhosted-support.mdx' + + +``` + 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/) diff --git a/docs/ecosystem/community.md b/docs/ecosystem/community.mdx similarity index 100% rename from docs/ecosystem/community.md rename to docs/ecosystem/community.mdx diff --git a/docs/ecosystem/configuring.md b/docs/ecosystem/configuring.mdx similarity index 100% rename from docs/ecosystem/configuring.md rename to docs/ecosystem/configuring.mdx diff --git a/docs/ecosystem/contributing.md b/docs/ecosystem/contributing.mdx similarity index 52% rename from docs/ecosystem/contributing.md rename to docs/ecosystem/contributing.mdx index 52abd9d86..3c8f6b416 100644 --- a/docs/ecosystem/contributing.md +++ b/docs/ecosystem/contributing.mdx @@ -3,149 +3,122 @@ id: contributing title: Contribute to Ory --- -This document explains how you can contribute to Ory. +This document explains how you can contribute to Ory. -If have have ideas to improve it, please have a look at the [template](https://github.com/ory/docs/blob/master/docs/ecosystem/contributing.md). +If have have ideas to improve it, please have a look at the +[template](https://github.com/ory/docs/blob/master/docs/ecosystem/contributing.md). ## Introduction -_Please note_: We take Ory's security and our users' trust very -seriously. If you believe you have found a security issue in Ory , +_Please note_: We take Ory's security and our users' trust very seriously. If you believe you have found a security issue in Ory , please disclose it by contacting us at security@ory.sh. -There are many ways in which you can contribute. The goal of this document is to -provide a high-level overview of how you can get involved in Ory. +There are many ways in which you can contribute. The goal of this document is to provide a high-level overview of how you can get +involved in Ory. -As a potential contributor, your changes and ideas are welcome at any hour of -the day or night, on weekdays, weekends, and holidays. Please do not ever -hesitate to ask a question or send a pull request. +As a potential contributor, your changes and ideas are welcome at any hour of the day or night, on weekdays, weekends, and +holidays. Please do not ever hesitate to ask a question or send a pull request. -If you are unsure, just ask or submit the issue or pull request anyways. You -won't be yelled at for giving it your best effort. The worst that can happen is -that you'll be politely asked to change something. We appreciate any sort of -contributions and don't want a wall of rules to get in the way of that. +If you are unsure, just ask or submit the issue or pull request anyways. You won't be yelled at for giving it your best effort. +The worst that can happen is that you'll be politely asked to change something. We appreciate any sort of contributions and don't +want a wall of rules to get in the way of that. -That said, if you want to ensure that a pull request is likely to be merged, -talk to us! You can find out our thoughts and ensure that your contribution -won't clash with Ory's direction. A great way to -do this is via -[Ory Discussions](https://github.com/discussions?discussions_q=org%3Aory+sort%3Aupdated-desc) -or the [Ory Chat](https://www.ory.sh/chat). +That said, if you want to ensure that a pull request is likely to be merged, talk to us! You can find out our thoughts and ensure +that your contribution won't clash with Ory's direction. A great way to do this is via +[Ory Discussions](https://github.com/discussions?discussions_q=org%3Aory+sort%3Aupdated-desc) or the +[Ory Chat](https://www.ory.sh/chat). ## FAQ - I am new to the community. Where can I find the [Ory Community Code of Conduct?](https://github.com/$REPOSITORY/blob/master/CODE_OF_CONDUCT.md) -- I have a question. Where can I get - [answers to questions regarding Ory?](#communication) +- I have a question. Where can I get [answers to questions regarding Ory?](#communication) -- I would like to contribute but I am not sure how. Are there - [easy ways to contribute?](#how-can-i-contribute) +- I would like to contribute but I am not sure how. Are there [easy ways to contribute?](#how-can-i-contribute) [Or good first issues?](https://github.com/search?l=&o=desc&q=label%3A%22help+wanted%22+label%3A%22good+first+issue%22+is%3Aopen+user%3Aory+user%3Aory-corp&s=updated&type=Issues) -- I want to talk to other Ory users. - [How can I become a part of the community?](#communication) +- I want to talk to other Ory users. [How can I become a part of the community?](#communication) -- I would like to know what I am agreeing to when I contribute to Ory - .Does Ory have +- I would like to know what I am agreeing to when I contribute to Ory .Does Ory have [a Contributors License Agreement?](https://cla-assistant.io/ory/kratos) -- I would like updates about new versions of Ory. - [How are new releases announced?](https://www.ory.sh/l/sign-up-newsletter) +- I would like updates about new versions of Ory. [How are new releases announced?](https://www.ory.sh/l/sign-up-newsletter) ## How can I contribute? If you want to start to contribute code right away, take a look at the [list of good first issues](https://github.com/$REPOSITORY/labels/good%20first%20issue). -There are many other ways you can contribute. Here are a few things you can do -to help out: +There are many other ways you can contribute. Here are a few things you can do to help out: -- **Give us a star.** It may not seem like much, but it really makes a - difference. This is something that everyone can do to help out Ory. - Github stars help the project gain visibility and stand out. +- **Give us a star.** It may not seem like much, but it really makes a difference. This is something that everyone can do to help + out Ory. Github stars help the project gain visibility and stand out. -- **Join the community.** Sometimes helping people can be as easy as listening - to their problems and offering a different perspective. Join our Slack, have a - look at discussions in the forum and take part in community events. More info - on this in [Communication](#communication). +- **Join the community.** Sometimes helping people can be as easy as listening to their problems and offering a different + perspective. Join our Slack, have a look at discussions in the forum and take part in community events. More info on this in + [Communication](#communication). -- **Answer discussions.** At all times, there are several unanswered discussions - on GitHub. You can see an - [overview here](https://github.com/discussions?discussions_q=is%3Aunanswered+org%3Aory+sort%3Aupdated-desc). - If you think you know an answer or can provide some information that might - help, please share it! Bonus: You get GitHub achievements for answered +- **Answer discussions.** At all times, there are several unanswered discussions on GitHub. You can see an + [overview here](https://github.com/discussions?discussions_q=is%3Aunanswered+org%3Aory+sort%3Aupdated-desc). If you think you + know an answer or can provide some information that might help, please share it! Bonus: You get GitHub achievements for answered discussions. -- **Help with open issues.** We have a lot of open issues for Ory and - some of them may lack necessary information, some are duplicates of older - issues. You can help out by guiding people through the process of filling out - the issue template, asking for clarifying information or pointing them to - existing issues that match their description of the problem. +- **Help with open issues.** We have a lot of open issues for Ory and some of them may lack necessary information, some are + duplicates of older issues. You can help out by guiding people through the process of filling out the issue template, asking for + clarifying information or pointing them to existing issues that match their description of the problem. -- **Review documentation changes.** Most documentation just needs a review for - proper spelling and grammar. If you think a document can be improved in any - way, feel free to hit the `edit` button at the top of the page. More info on - contributing to the documentation [here](#contribute-documentation). +- **Review documentation changes.** Most documentation just needs a review for proper spelling and grammar. If you think a + document can be improved in any way, feel free to hit the `edit` button at the top of the page. More info on contributing to the + documentation [here](#contribute-documentation). -- **Help with tests.** Pull requests may lack proper tests or test plans. These - are needed for the change to be implemented safely. +- **Help with tests.** Pull requests may lack proper tests or test plans. These are needed for the change to be implemented + safely. ## Communication -We use [Slack](https://www.ory.sh/chat). You are welcome to drop in and ask -questions, discuss bugs and feature requests, talk to other users of Ory, etc. +We use [Slack](https://www.ory.sh/chat). You are welcome to drop in and ask questions, discuss bugs and feature requests, talk to +other users of Ory, etc. Check out [Ory Discussions](https://github.com/discussions?discussions_q=org%3Aory+sort%3Aupdated-desc). This is a great place for in-depth discussions and lots of code examples, logs and similar data. -You can also join our community calls if you want to speak to the Ory team -directly or ask some questions. You can find more info and participate in -[Slack](https://www.ory.sh/chat) in the #community-call channel. +You can also join our community calls if you want to speak to the Ory team directly or ask some questions. You can find more info +and participate in [Slack](https://www.ory.sh/chat) in the #community-call channel. -If you want to receive regular notifications about updates to Ory, -consider joining the mailing list. We will _only_ send you vital information on -the projects that you are interested in. +If you want to receive regular notifications about updates to Ory, consider joining the mailing list. We will _only_ send you +vital information on the projects that you are interested in. Also, [follow us on Twitter](https://twitter.com/orycorp). ## Contribute examples or community projects -One of the most impactful ways to contribute is by adding code examples or other -Ory-related code. You can find an overview of community code in the -[awesome-ory](https://github.com/ory/awesome-ory) repository. +One of the most impactful ways to contribute is by adding code examples or other Ory-related code. You can find an overview of +community code in the [awesome-ory](https://github.com/ory/awesome-ory) repository. _If you would like to contribute a new example, we would love to hear from you!_ -Please [open a pull request at awesome-ory](https://github.com/ory/awesome-ory/) -to add your example or Ory-related project to the awesome-ory README. +Please [open a pull request at awesome-ory](https://github.com/ory/awesome-ory/) to add your example or Ory-related project to the +awesome-ory README. ## Contribute code -Unless you are fixing a known bug, we **strongly** recommend discussing it with -the core team via a GitHub issue or [in our chat](https://www.ory.sh/chat) -before getting started to ensure your work is consistent with Ory's -roadmap and architecture. +Unless you are fixing a known bug, we **strongly** recommend discussing it with the core team via a GitHub issue or +[in our chat](https://www.ory.sh/chat) before getting started to ensure your work is consistent with Ory's roadmap and +architecture. -All contributions are made via pull requests. To make a pull request, you will -need a GitHub account; if you are unclear on this process, see GitHub's -documentation on [forking](https://help.github.com/articles/fork-a-repo) and -[pull requests](https://help.github.com/articles/using-pull-requests). Pull -requests should be targeted at the `master` branch. Before creating a pull -request, go through this checklist: +All contributions are made via pull requests. To make a pull request, you will need a GitHub account; if you are unclear on this +process, see GitHub's documentation on [forking](https://help.github.com/articles/fork-a-repo) and +[pull requests](https://help.github.com/articles/using-pull-requests). Pull requests should be targeted at the `master` branch. +Before creating a pull request, go through this checklist: 1. Create a feature branch off of `master` so that changes do not get mixed up. -1. [Rebase](http://git-scm.com/book/en/Git-Branching-Rebasing) your local - changes against the `master` branch. -1. Run the full project test suite with the `go test -tags sqlite ./...` (or - equivalent) command and confirm that it passes. +1. [Rebase](http://git-scm.com/book/en/Git-Branching-Rebasing) your local changes against the `master` branch. +1. Run the full project test suite with the `go test -tags sqlite ./...` (or equivalent) command and confirm that it passes. 1. Run `make format` -1. Add a descriptive prefix to commits. This ensures a uniform commit history - and helps structure the changelog. Please refer to this - [Convential Commits configuration](https://github.com/$REPOSITORY/blob/master/.github/workflows/conventional_commits.yml) - for the list of accepted prefixes. You can read more about the Conventional - Commit specification +1. Add a descriptive prefix to commits. This ensures a uniform commit history and helps structure the changelog. Please refer to + this [Convential Commits configuration](https://github.com/$REPOSITORY/blob/master/.github/workflows/conventional_commits.yml) + for the list of accepted prefixes. You can read more about the Conventional Commit specification [at their site](https://www.conventionalcommits.org/en/v1.0.0/). If a pull request is not ready to be reviewed yet @@ -154,46 +127,38 @@ If a pull request is not ready to be reviewed yet Before your contributions can be reviewed you need to sign our [Contributor License Agreement](https://cla-assistant.io/$REPOSITORY). -This agreement defines the terms under which your code is contributed to Ory. -More specifically it declares that you have the right to, and actually do, grant -us the rights to use your contribution. You can see the Apache 2.0 license under -which our projects are published -[here](https://github.com/ory/meta/blob/master/LICENSE). +This agreement defines the terms under which your code is contributed to Ory. More specifically it declares that you have the +right to, and actually do, grant us the rights to use your contribution. You can see the Apache 2.0 license under which our +projects are published [here](https://github.com/ory/meta/blob/master/LICENSE). -When pull requests fail the automated testing stages (for example unit or E2E -tests), authors are expected to update their pull requests to address the -failures until the tests pass. +When pull requests fail the automated testing stages (for example unit or E2E tests), authors are expected to update their pull +requests to address the failures until the tests pass. Pull requests eligible for review 1. follow the repository's code formatting conventions; -2. include tests that prove that the change works as intended and does not add - regressions; +2. include tests that prove that the change works as intended and does not add regressions; 3. document the changes in the code and/or the project's documentation; 4. pass the CI pipeline; -5. have signed our - [Contributor License Agreement](https://cla-assistant.io/$REPOSITORY); +5. have signed our [Contributor License Agreement](https://cla-assistant.io/$REPOSITORY); 6. include a proper git commit message following the [Conventional Commit Specification](https://www.conventionalcommits.org/en/v1.0.0/). -If all of these items are checked, the pull request is ready to be reviewed and -you should change the status to "Ready for review" and +If all of these items are checked, the pull request is ready to be reviewed and you should change the status to "Ready for review" +and [request review from a maintainer](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review). Reviewers will approve the pull request once they are satisfied with the patch. ## Contribute documentation -Please provide documentation when changing, removing, or adding features. All -Ory Documentation resides in the -[Ory documentation repository](https://github.com/ory/docs/). For further -instructions please head over to the Ory Documentation +Please provide documentation when changing, removing, or adding features. All Ory Documentation resides in the +[Ory documentation repository](https://github.com/ory/docs/). For further instructions please head over to the Ory Documentation [README.md](https://github.com/ory/docs/blob/master/README.md). ## Disclosing vulnerabilities -Please disclose vulnerabilities exclusively to -[security@ory.sh](mailto:security@ory.sh). Do not use GitHub issues. +Please disclose vulnerabilities exclusively to [security@ory.sh](mailto:security@ory.sh). Do not use GitHub issues. ## Code style @@ -228,11 +193,10 @@ Now go to the project's GitHub Pull Request page and click "New pull request" ## Conduct -Whether you are a regular contributor or a newcomer, we care about making this -community a safe place for you and we've got your back. +Whether you are a regular contributor or a newcomer, we care about making this community a safe place for you and we've got your +back. [Ory Community Code of Conduct](https://github.com/$REPOSITORY/blob/master/CODE_OF_CONDUCT.md) -We welcome discussion about creating a welcoming, safe, and productive -environment for the community. If you have any questions, feedback, or concerns -[please let us know](https://www.ory.sh/chat). \ No newline at end of file +We welcome discussion about creating a welcoming, safe, and productive environment for the community. If you have any questions, +feedback, or concerns [please let us know](https://www.ory.sh/chat). diff --git a/docs/ecosystem/security.md b/docs/ecosystem/security.mdx similarity index 100% rename from docs/ecosystem/security.md rename to docs/ecosystem/security.mdx diff --git a/docs/ecosystem/software-architecture-philosophy.md b/docs/ecosystem/software-architecture-philosophy.mdx similarity index 100% rename from docs/ecosystem/software-architecture-philosophy.md rename to docs/ecosystem/software-architecture-philosophy.mdx diff --git a/docs/ecosystem/sqa.md b/docs/ecosystem/sqa.mdx similarity index 100% rename from docs/ecosystem/sqa.md rename to docs/ecosystem/sqa.mdx diff --git a/docs/ecosystem/upgrading.md b/docs/ecosystem/upgrading.mdx similarity index 100% rename from docs/ecosystem/upgrading.md rename to docs/ecosystem/upgrading.mdx diff --git a/docs/hydra/self-hosted/quickstart.mdx b/docs/hydra/self-hosted/quickstart.mdx index b4fb5c03d..6ad9c01c6 100644 --- a/docs/hydra/self-hosted/quickstart.mdx +++ b/docs/hydra/self-hosted/quickstart.mdx @@ -5,6 +5,12 @@ title: Quickstart # Ory Hydra OAuth2 Server Quickstart +```mdx-code-block +import Help from '@site/docs/_common/need-selfhosted-support.mdx' + + +``` + 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/). diff --git a/docs/identities/index.md b/docs/identities/index.md index 546eb1628..0e7ab6fca 100644 --- a/docs/identities/index.md +++ b/docs/identities/index.md @@ -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 diff --git a/docs/keto/quickstart.mdx b/docs/keto/quickstart.mdx index b0301bea6..2bdfcafa5 100644 --- a/docs/keto/quickstart.mdx +++ b/docs/keto/quickstart.mdx @@ -2,6 +2,12 @@ title: "Quickstart: Cat Videos Example" --- +```mdx-code-block +import Help from '@site/docs/_common/need-selfhosted-support.mdx' + + +``` + 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 @@ -9,13 +15,9 @@ to their objects, and this privilege can be granted to other users as well. The `*` 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). diff --git a/docs/kratos/bring-your-own-ui/20_configure-ory-to-use-your-ui.mdx b/docs/kratos/bring-your-own-ui/20_configure-ory-to-use-your-ui.mdx index 4d6a8ccad..332f7079a 100644 --- a/docs/kratos/bring-your-own-ui/20_configure-ory-to-use-your-ui.mdx +++ b/docs/kratos/bring-your-own-ui/20_configure-ory-to-use-your-ui.mdx @@ -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' + + +``` 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. diff --git a/docs/kratos/manage-identities/50_scim.mdx b/docs/kratos/manage-identities/50_scim.mdx index 6291a56ab..93dd5d390 100644 --- a/docs/kratos/manage-identities/50_scim.mdx +++ b/docs/kratos/manage-identities/50_scim.mdx @@ -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' -::: + +``` 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 diff --git a/docs/kratos/organizations/organizations.mdx b/docs/kratos/organizations/organizations.mdx index 6b90e5985..390a963e9 100644 --- a/docs/kratos/organizations/organizations.mdx +++ b/docs/kratos/organizations/organizations.mdx @@ -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' -::: + +``` ```mdx-code-block import webm from './_static/organizations-ory-network.webm' diff --git a/docs/kratos/quickstart.mdx b/docs/kratos/quickstart.mdx index f3c6d4553..0b4761a85 100644 --- a/docs/kratos/quickstart.mdx +++ b/docs/kratos/quickstart.mdx @@ -5,6 +5,12 @@ title: Quickstart # Ory Kratos Identity Server Quickstart +```mdx-code-block +import Help from '@site/docs/_common/need-selfhosted-support.mdx' + + +``` + import Mermaid from "@site/src/theme/Mermaid" import CodeFromRemote from "@site/src/theme/CodeFromRemote" diff --git a/docs/migrate-to-ory/index.mdx b/docs/migrate-to-ory/index.mdx index ac5e53cff..6ace33d04 100644 --- a/docs/migrate-to-ory/index.mdx +++ b/docs/migrate-to-ory/index.mdx @@ -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' -::: + +``` diff --git a/docs/oathkeeper/configure-deploy.mdx b/docs/oathkeeper/configure-deploy.mdx index 4f4f345ab..4598a774f 100644 --- a/docs/oathkeeper/configure-deploy.mdx +++ b/docs/oathkeeper/configure-deploy.mdx @@ -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). diff --git a/docs/oathkeeper/guides/traefik-proxy-integration.md b/docs/oathkeeper/guides/traefik-proxy-integration.md index be7a527f4..1088c9d88 100644 --- a/docs/oathkeeper/guides/traefik-proxy-integration.md +++ b/docs/oathkeeper/guides/traefik-proxy-integration.md @@ -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, diff --git a/docs/oathkeeper/index.md b/docs/oathkeeper/index.mdx similarity index 99% rename from docs/oathkeeper/index.md rename to docs/oathkeeper/index.mdx index 16073f2b3..bca94f02a 100644 --- a/docs/oathkeeper/index.md +++ b/docs/oathkeeper/index.mdx @@ -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' + + +``` + 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 diff --git a/docs/oauth2-oidc/overview/oauth2-concepts.mdx b/docs/oauth2-oidc/overview/oauth2-concepts.mdx index 333a13d6b..98ef87d29 100644 --- a/docs/oauth2-oidc/overview/oauth2-concepts.mdx +++ b/docs/oauth2-oidc/overview/oauth2-concepts.mdx @@ -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 diff --git a/docs/oauth2-oidc/resource-owner-password-grant.mdx b/docs/oauth2-oidc/resource-owner-password-grant.mdx index c65c01c83..a6ceed39a 100644 --- a/docs/oauth2-oidc/resource-owner-password-grant.mdx +++ b/docs/oauth2-oidc/resource-owner-password-grant.mdx @@ -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' -::: + +``` 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 diff --git a/docs/open-source.mdx b/docs/open-source.mdx index 5d5763380..32bc8b619 100644 --- a/docs/open-source.mdx +++ b/docs/open-source.mdx @@ -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) diff --git a/docs/polis/quickstart.mdx b/docs/polis/quickstart.mdx index 568444fd5..037e33d06 100644 --- a/docs/polis/quickstart.mdx +++ b/docs/polis/quickstart.mdx @@ -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' + + +``` + 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.