Skip to content

Commit 09d9634

Browse files
committed
docs(auth-js): update README
In the default example, use `basePath` as it aligns with v5 behavior where the host is inferred from request headers. Setting `AUTH_URL` is only necessary if a custom base path is needed. (e.g., `AUTH_URL=http://localhost:3000/web/auth`)
1 parent b74dfe4 commit 09d9634

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

packages/auth-js/README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@ Before starting using the middleware you must set the following environment vari
1616

1717
```plain
1818
AUTH_SECRET=#required
19-
AUTH_URL=https://example.com/api/auth
2019
```
2120

2221
## How to Use
@@ -38,6 +37,8 @@ app.use(
3837
clientSecret: c.env.GITHUB_SECRET,
3938
}),
4039
],
40+
// This is required and should match the path of the authHandler route
41+
basePath: '/api/auth',
4142
}))
4243
)
4344

@@ -117,3 +118,11 @@ For more details on how to Popup Oauth Login see [example](https://github.com/di
117118
## Author
118119

119120
Divyam <https://github.com/divyam234>
121+
122+
### Contributors
123+
124+
Catnaut <https://github.com/catnaut>
125+
126+
## Breaking Changes
127+
128+
Due to security concerns, support for `x-forward-*` has been removed starting from version 1.0.15. This change is marked as a breaking change. For more details, refer to issue [#817](https://github.com/honojs/middleware/issues/817).

0 commit comments

Comments
 (0)