Skip to content

Commit 017e1a4

Browse files
ThankRainXue
andauthored
fix(docs): correct GitHub OAuth callback URL in docs and error messages (openRin#502)
The GitHub OAuth callback URL has changed from /user/github/callback to /api/user/github/callback. Updated all documentation and error messages in both English and Chinese, as well as Japanese and Traditional Chinese translations. Fixes openRin#501 Co-authored-by: Xue <xue@example.com>
1 parent 8cd58e5 commit 017e1a4

12 files changed

Lines changed: 12 additions & 12 deletions

File tree

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ If you want to skip the hook, run `git commit` with the `--no-verify` option.
6060
> Typically, you need to fill in the `RIN_GITHUB_CLIENT_ID` and `RIN_GITHUB_CLIENT_SECRET` as well as
6161
the `JWT_SECRET` fields.
6262
> In the development environment, you need to create a separate GitHub OAuth service with a callback address
63-
of `http://localhost:11498/user/github/callback` \
63+
> of `http://localhost:11498/api/user/github/callback` \\
6464
> If you have changed the listening port of the server manually, please also change the port number in the callback
6565
address.
6666

CONTRIBUTING_zh_CN.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ cp .\cli\templates\git-commit-msg.sh .\.git\hooks\commit-msg
5757
`.dev.example.vars` 复制到 `.dev.vars` 并填写必要信息
5858
> [!TIP]
5959
> 通常情况下,您需要填写 `RIN_GITHUB_CLIENT_ID``RIN_GITHUB_CLIENT_SECRET` 以及 `JWT_SECRET` 三项 \
60-
> 开发环境下需要单独创建一个 Github OAuth 服务,回调地址为 `http://localhost:11498/user/github/callback` \
60+
> 开发环境下需要单独创建一个 Github OAuth 服务,回调地址为 `http://localhost:11498/api/user/github/callback` \\
6161
> 如果手动修改过 server 的监听端口,请同时修改回调地址中的端口号
6262

6363
8. 启动开发服务器

client/public/locales/en/translation.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@
132132
"error": {
133133
"api_url": "API_URL in Pages environment variables should be the Worker address. Please check if API_URL in Pages environment variables is correct.",
134134
"api_url_slash": "API_URL in Pages environment variables should be the Worker address. Please check if API_URL in Pages environment variables is correct and ensure API_URL does not end with a slash (/).",
135-
"github_callback": "GitHub OAuth callback URL should be `https://<Worker address>/user/github/callback`. Please check if the GitHub OAuth callback URL is correct.",
135+
"github_callback": "GitHub OAuth callback URL should be `https://<Worker address>/api/user/github/callback`. Please check if the GitHub OAuth callback URL is correct.",
136136
"not_found": "Page not found",
137137
"permission_denied": "Permission denied",
138138
"title": "Error"

client/public/locales/ja/translation.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@
132132
"error": {
133133
"api_url": "Pages 環境変数のAPI_URLはWorkerアドレスである必要があります。Pages環境変数のAPI_URLが正しいか確認してください。",
134134
"api_url_slash": "Pages 環境変数のAPI_URLはWorkerアドレスである必要があります。Pages環境変数のAPI_URLが正しいか、またAPI_URLの末尾にスラッシュ(/)がないか確認してください。",
135-
"github_callback": "GitHub OAuthコールバックURLは`https://<Workerアドレス>/user/github/callback`である必要があります。GitHub OAuthコールバックURLが正しいか確認してください。",
135+
"github_callback": "GitHub OAuthコールバックURLは`https://<Workerアドレス>/api/user/github/callback`である必要があります。GitHub OAuthコールバックURLが正しいか確認してください。",
136136
"not_found": "ページが見つかりません",
137137
"permission_denied": "権限がありません",
138138
"title": "エラー"

client/public/locales/zh-CN/translation.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@
132132
"error": {
133133
"api_url": "Pages 环境变量中 API_URL 应为 Worker 地址,请检查 Pages 环境变量中 API_URL 是否正确",
134134
"api_url_slash": "Pages 环境变量中 API_URL 应为 Worker 地址,请检查 Pages 环境变量中 API_URL 是否正确,且 API_URL 末尾不能有 /",
135-
"github_callback": "GitHub OAuth 回调地址应为 `https://<Worker 地址>/user/github/callback,请检查 GitHub OAuth 回调地址是否正确",
135+
"github_callback": "GitHub OAuth 回调地址应为 `https://<Worker 地址>/api/user/github/callback`,请检查 GitHub OAuth 回调地址是否正确",
136136
"not_found": "页面未找到",
137137
"permission_denied": "权限不足",
138138
"title": "错误"

client/public/locales/zh-TW/translation.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@
132132
"error": {
133133
"api_url": "Pages 環境變數中 API_URL 應為 Worker 地址,請檢查 Pages 環境變數中 API_URL 是否正確",
134134
"api_url_slash": "Pages 環境變數中 API_URL 應為 Worker 地址,請檢查 Pages 環境變數中 API_URL 是否正確,且 API_URL 末尾不能有 /",
135-
"github_callback": "GitHub OAuth 回調地址應為 `https://<Worker 地址>/user/github/callback,請檢查 GitHub OAuth 回調地址是否正確",
135+
"github_callback": "GitHub OAuth 回調地址應為 `https://<Worker 地址>/api/user/github/callback`,請檢查 GitHub OAuth 回調地址是否正確",
136136
"not_found": "頁面未找到",
137137
"permission_denied": "權限不足",
138138
"title": "錯誤"

docs/docs/en/guide/contribution.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ If you want to skip the hook (not recommended), run `git commit` with the `--no-
4646

4747
:::tip
4848
Typically, you only need to fill in `AVATAR`, `NAME` and `DESCRIPTION`.
49-
For GitHub OAuth, you need to create a separate OAuth App with a callback address of `http://localhost:11498/user/github/callback`
49+
For GitHub OAuth, you need to create a separate OAuth App with a callback address of `http://localhost:11498/api/user/github/callback`
5050
:::
5151

5252
5. Run the setup script to generate configuration files

docs/docs/en/guide/deploy.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ If you want to log in with your GitHub account:
151151
3. Fill in the application information:
152152
- **Application name**: Rin Blog
153153
- **Homepage URL**: Your frontend page address
154-
- **Authorization callback URL**: `https://your-worker-name.your-account-id.workers.dev/user/github/callback`
154+
- **Authorization callback URL**: `https://your-worker-name.your-account-id.workers.dev/api/user/github/callback`
155155
4. After creation, obtain the Client ID and Client Secret
156156
5. Add to GitHub Secrets:
157157
- `RIN_GITHUB_CLIENT_ID`

docs/docs/en/guide/development.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -244,7 +244,7 @@ GitHub OAuth needs to be configured for local development:
244244

245245
1. Visit https://github.com/settings/developers
246246
2. Create a new OAuth App
247-
3. Authorization callback URL: `http://localhost:11498/user/github/callback`
247+
3. Authorization callback URL: `http://localhost:11498/api/user/github/callback`
248248
4. Fill Client ID and Client Secret into `.env.local`
249249

250250
## Project Structure

docs/docs/zh/guide/contribution.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ bun run test
4646

4747
:::tip
4848
通常情况下,您只需要填写 `AVATAR``NAME``DESCRIPTION`
49-
如需配置 GitHub OAuth,需要创建一个 OAuth App,回调地址为 `http://localhost:11498/user/github/callback`
49+
如需配置 GitHub OAuth,需要创建一个 OAuth App,回调地址为 `http://localhost:11498/api/user/github/callback`
5050
:::
5151

5252
5. 运行设置脚本生成配置文件

0 commit comments

Comments
 (0)