Skip to content

Commit 17cb801

Browse files
committed
docs: clarify use cases and document nextjs
1 parent aa5a5ed commit 17cb801

2 files changed

Lines changed: 36 additions & 0 deletions

File tree

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,11 @@ Ory Elements comes with several packages:
2222
> before, we recommend migrating to @ory/elements-react. The legacy code base is
2323
> in https://github.com/ory/elements-legacy.
2424
25+
If you're not looking to implement custom UI components for login, registration,
26+
settings, verification, recovery, or consent, but rather want to integrate
27+
authentication without changing the UI, follow our
28+
[guide for Auth.js](https://www.ory.sh/docs/getting-started/integrate-auth/auth-js).
29+
2530
## Getting Started
2631

2732
### React

packages/nextjs/README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,47 @@ This package contains the Next.js SDK for Ory. It provides a set of React
44
components, server-side components, and hooks to interact with the Ory
55
ecosystem.
66

7+
<<<<<<< Updated upstream
78
Supports both app and page routers.
9+
=======
10+
> [!NOTE]
11+
> This package's primary use case is for developing custom components for login,
12+
> registration, verification, settings, recovery, or consent. For integrating
13+
> authentication without changing the UI, follow our
14+
> [guide for Auth.js](https://www.ory.sh/docs/getting-started/integrate-auth/auth-js).
15+
16+
This middleware expects environment variable `NEXT_PUBLIC_ORY_SDK_URL` to be set
17+
to your Ory Network Project SDK URL. This is the URL that you would use to
18+
access the Ory API. If you have a custom domain for your Ory Network Project,
19+
you should use the custom domain for `NEXT_PUBLIC_ORY_SDK_URL`.
20+
>>>>>>> Stashed changes
821
922
## Installation
1023

1124
Run `npm install @ory/nextjs` or `yarn add @ory/nextjs` to install the package.
1225

1326
## Examples
1427

28+
<<<<<<< Updated upstream
1529
See the [examples](../../examples) directory for examples on how to use the
1630
package.
31+
=======
32+
This package includes a middleware for the app and page router that enables
33+
local development and preview environments to work with
34+
[Ory's cookie security model](https://www.ory.sh/docs/security-model). When
35+
using the `@ory/nextjs` middleware, Ory Tunnel is not needed for development.
36+
37+
Check the
38+
[app router](https://github.com/ory/elements/blob/main/examples/nextjs-app-router/middleware.ts)
39+
and
40+
[page router](https://github.com/ory/elements/blob/main/examples/nextjs-pages-router/middleware.ts)
41+
middleware example for more details.
42+
43+
## Learn by example
44+
45+
See the [examples](https://github.com/ory/elements/blob/main/examples) directory
46+
for examples on how to use the package.
47+
>>>>>>> Stashed changes
1748
1849
## Development
1950

0 commit comments

Comments
 (0)