Skip to content

RAGFlow is an agent-native database: a Retrieval-Augmented Generation (RAG) engine that grew into context infrastructure.

Fix OAuth redirect URI examples (#15683)

表面68cdb795f5e5
diff --git a/api/apps/auth/README.md b/api/apps/auth/README.md
index 8edab999f8..37df4e8391 100644
--- a/api/apps/auth/README.md
+++ b/api/apps/auth/README.md
@@ -37,7 +37,7 @@ github_config = {
"type": "github"
"client_id": "your_client_id",
"client_secret": "your_client_secret",
- "redirect_uri": "https://your-app.com/v1/user/oauth/callback/<channel>"
+ "redirect_uri": "https://your-app.com/api/v1/auth/oauth/<channel>/callback"
}
# Get client instance
diff --git a/conf/service_conf.yaml b/conf/service_conf.yaml
index dc1c20a789..73d3b7243b 100644
--- a/conf/service_conf.yaml
+++ b/conf/service_conf.yaml
@@ -146,21 +146,21 @@ gcs:
# authorization_url: "https://your-oauth-provider.com/oauth/authorize"
# token_url: "https://your-oauth-provider.com/oauth/token"
# userinfo_url: "https://your-oauth-provider.com/oauth/userinfo"
-# redirect_uri: "https://your-app.com/v1/user/oauth/callback/oauth2"
+# redirect_uri: "https://your-app.com/api/v1/auth/oauth/oauth2/callback"
# oidc:
# display_name: "OIDC"
# client_id: "your_client_id"
# client_secret: "your_client_secret"
# issuer: "https://your-oauth-provider.com/oidc"
# scope: "openid email profile"
-# redirect_uri: "https://your-app.com/v1/user/oauth/callback/oidc"
+# redirect_uri: "https://your-app.com/api/v1/auth/oauth/oidc/callback"
# github:
# type: "github"
# icon: "github"
# display_name: "Github"
# client_id: "your_client_id"
# client_secret: "your_client_secret"
-# redirect_uri: "https://your-app.com/v1/user/oauth/callback/github"
+# redirect_uri: "https://your-app.com/api/v1/auth/oauth/github/callback"
# authentication:
# client:
# switch: false
diff --git a/docker/README.md b/docker/README.md
index 682c4550e3..41f1ce9bf1 100644
--- a/docker/README.md
+++ b/docker/README.md
@@ -250,7 +250,7 @@ Before setting `DOC_ENGINE=oceanbase`, make sure the host OS allows the file des
- `userinfo_url`: URL for obtaining user information (username, email, etc.).
- `issuer`: Base URL of the identity provider. OIDC clients can dynamically obtain the identity provider's metadata (`authorization_url`, `token_url`, `userinfo_url`) through `issuer`.
- `scope`: Requested permission scope, a space-separated string. For example, `openid profile email`.
- - `redirect_uri`: Required, URI to which the authorization server redirects during the authentication flow to return results. Must match the callback URI registered with the authentication server. Format: `https://your-app.com/v1/user/oauth/callback/<channel>`. For local configuration, you can directly use `http://127.0.0.1:80/v1/user/oauth/callback/<channel>`.
+ - `redirect_uri`: Required, URI to which the authorization server redirects during the authentication flow to return results. Must match the callback URI registered with the authentication server. Format: `https://your-app.com/api/v1/auth/oauth/<channel>/callback`. For local configuration, you can directly use `http://127.0.0.1:80/api/v1/auth/oauth/<channel>/callback`.
- `user_default_llm`
The default LLM to use for a new RAGFlow user. It is disabled by default. To enable this feature, uncomment the corresponding lines in **service_conf.yaml.template**.
diff --git a/docker/service_conf.yaml.template b/docker/service_conf.yaml.template
index 1499a9755b..37f2c8b6e8 100644
--- a/docker/service_conf.yaml.template
+++ b/docker/service_conf.yaml.template
@@ -175,21 +175,21 @@ user_default_llm:
# authorization_url: "https://your-oauth-provider.com/oauth/authorize"
# token_url: "https://your-oauth-provider.com/oauth/token"
# userinfo_url: "https://your-oauth-provider.com/oauth/userinfo"
-# redirect_uri: "https://your-app.com/v1/user/oauth/callback/oauth2"
+# redirect_uri: "https://your-app.com/api/v1/auth/oauth/oauth2/callback"
# oidc:
# display_name: "OIDC"
# client_id: "your_client_id"
# client_secret: "your_client_secret"
# issuer: "https://your-oauth-provider.com/oidc"
# scope: "openid email profile"
-# redirect_uri: "https://your-app.com/v1/user/oauth/callback/oidc"
+# redirect_uri: "https://your-app.com/api/v1/auth/oauth/oidc/callback"
# github:
# type: "github"
# icon: "github"
# display_name: "Github"
# client_id: "your_client_id"
# client_secret: "your_client_secret"
-# redirect_uri: "https://your-app.com/v1/user/oauth/callback/github"
+# redirect_uri: "https://your-app.com/api/v1/auth/oauth/github/callback"
# authentication:
# client:
# switch: false
diff --git a/docs/administrator/configurations/configurations.md b/docs/administrator/configurations/configurations.md
index 0786bfade2..881f05d0bc 100644
--- a/docs/administrator/configurations/configurations.md
+++ b/docs/administrator/configurations/configurations.md
@@ -214,7 +214,7 @@ The OAuth configuration for signing up or signing in to RAGFlow using a third-pa
- `userinfo_url`: URL for obtaining user information (username, email, etc.).
- `issuer`: Base URL of the identity provider. OIDC clients can dynamically obtain the identity provider's metadata (`authorization_url`, `token_url`, `userinfo_url`) through `issuer`.
- `scope`: Requested permission scope, a space-separated string. For example, `openid profile email`.
- - `redirect_uri`: Required, URI to which the authorization server redirects during the authentication flow to return results. Must match the callback URI registered with the authentication server. Format: `https://your-app.com/v1/user/oauth/callback/<channel>`. For local configuration, you can directly use `http://127.0.0.1:80/v1/user/oauth/callback/<channel>`.
+ - `redirect_uri`: Required, URI to which the authorization server redirects during the authentication flow to return results. Must match the callback URI registered with the authentication server. Format: `https://your-app.com/api/v1/auth/oauth/<channel>/callback`. For local configuration, you can directly use `http://127.0.0.1:80/api/v1/auth/oauth/<channel>/callback`.
:::tip NOTE
The following are best practices for configuring various third-party authentication methods. You can configure one or multiple third-party authentication methods for Ragflow:
@@ -227,7 +227,7 @@ oauth:
authorization_url: "https://your-oauth-provider.com/oauth/authorize"
token_url: "https://your-oauth-provider.com/oauth/token"
userinfo_url: "https://your-oauth-provider.com/oauth/userinfo"
- redirect_uri: "https://your-app.com/v1/user/oauth/callback/oauth2"
+ redirect_uri: "https://your-app.com/api/v1/auth/oauth/oauth2/callback"
oidc:
display_name: "OIDC"
@@ -235,7 +235,7 @@ oauth:
client_secret: "your_client_secret"
issuer: "https://your-oauth-provider.com/oidc"
scope: "openid email profile"
- redirect_uri: "https://your-app.com/v1/user/oauth/callback/oidc"
+ redirect_uri: "https://your-app.com/api/v1/auth/oauth/oidc/callback"
github:
# https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app
@@ -244,7 +244,7 @@ oauth:
display_name: "Github"
client_id: "your_client_id"
client_secret: "your_client_secret"
- redirect_uri: "https://your-app.com/v1/user/oauth/callback/github"
+ redirect_uri: "https://your-app.com/api/v1/auth/oauth/github/callback"
```
:::