|
1 | 1 | # `@ory/nextjs` |
2 | 2 |
|
3 | | -This package contains the Next.js SDK for Ory. It is additive to the |
4 | | -`@ory/elements-react` package and provides utility functions for the app and |
5 | | -page router. |
| 3 | +This package contains the Next.js SDK for Ory. It provides a set of React |
| 4 | +components, server-side components, and hooks to interact with the Ory |
| 5 | +ecosystem. Supports both app and page routers. |
6 | 6 |
|
7 | | -This middleware expects environment variable `NEXT_PUBLIC_ORY_SDK_URL` to be set |
8 | | -to your Ory Network Project SDK URL. This is the URL that you would use to |
9 | | -access the Ory API. |
10 | | - |
11 | | -If you have a custom domain for your Ory Network Project, you should use the |
12 | | -custom domain for `NEXT_PUBLIC_ORY_SDK_URL`. |
13 | | - |
14 | | -## Installation |
15 | | - |
16 | | -Run `npm install @ory/nextjs` or `yarn add @ory/nextjs` to install the package. |
| 7 | +> [!NOTE] |
| 8 | +> This package's primary use case is for developing custom components for login, |
| 9 | +> registration, verification, settings, recovery, or consent. For integrating |
| 10 | +> authentication without changing the UI, follow our |
| 11 | +> [guide for Auth.js](https://www.ory.sh/docs/getting-started/integrate-auth/auth-js). |
17 | 12 |
|
18 | | -### Next.js middleware for local development and preview deployments |
| 13 | +## Use case |
19 | 14 |
|
20 | 15 | This package includes a middleware for the app and page router that enables |
21 | | -local development and preview environments to work with Ory's cookie security |
22 | | -model. When using the `@ory/nextjs` middleware, Ory Tunnel is not needed for |
23 | | -development. |
| 16 | +local development and preview environments to work with |
| 17 | +[Ory's cookie security model](https://www.ory.sh/docs/security-model). When |
| 18 | +using the `@ory/nextjs` middleware, Ory Tunnel is not needed for development. |
24 | 19 |
|
25 | 20 | Check the |
26 | 21 | [app router](https://github.com/ory/elements/blob/main/examples/nextjs-app-router/middleware.ts) |
27 | 22 | and |
28 | 23 | [page router](https://github.com/ory/elements/blob/main/examples/nextjs-pages-router/middleware.ts) |
29 | 24 | middleware example for more details. |
30 | 25 |
|
| 26 | +## Installation |
| 27 | + |
| 28 | +Run `npm install @ory/nextjs` or `yarn add @ory/nextjs` to install the package. |
| 29 | + |
| 30 | +## Configuration |
| 31 | + |
| 32 | +This middleware expects environment variable `NEXT_PUBLIC_ORY_SDK_URL` to be set |
| 33 | +to your Ory Network Project SDK URL. This is the URL that you would use to |
| 34 | +access the Ory API. If you have a custom domain for your Ory Network Project, |
| 35 | +you should use the custom domain for `NEXT_PUBLIC_ORY_SDK_URL`. |
| 36 | + |
31 | 37 | ## Learn by example |
32 | 38 |
|
33 | 39 | See the [examples](https://github.com/ory/elements/blob/main/examples) directory |
|
0 commit comments