mirror of
https://github.com/infiniflow/ragflow.git
synced 2025-12-08 20:42:30 +08:00
a8542508b7
### What problem does this PR solve? Deprecate `/github_callback` route in favor of `/oauth/callback/<channel>` for GitHub OAuth integration: - Added GitHub OAuth support in the authentication module - Introduced `GithubOAuthClient` with methods to fetch and normalize user info - Updated `CLIENT_TYPES` to include GitHub OAuth client - Deprecated `/github_callback` route and suggested using the generic `/oauth/callback/<channel>` route --- - Related pull requests: - #7379 - #7553 ### Usage - [Create a GitHub OAuth App](https://github.com/settings/applications/new) to obtain the `client_id` and `client_secret`, configure the authorization callback url: `https://your-app.com/v1/user/oauth/callback/github` - Edit `service_conf.yaml.template`: ```yaml # ... oauth: 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" # ... ``` ### Type of change - [x] Documentation Update - [x] Refactoring (non-breaking change)
111 lines
3.1 KiB
Plaintext
111 lines
3.1 KiB
Plaintext
ragflow:
|
|
host: ${RAGFLOW_HOST:-0.0.0.0}
|
|
http_port: 9380
|
|
mysql:
|
|
name: '${MYSQL_DBNAME:-rag_flow}'
|
|
user: '${MYSQL_USER:-root}'
|
|
password: '${MYSQL_PASSWORD:-infini_rag_flow}'
|
|
host: '${MYSQL_HOST:-mysql}'
|
|
port: 3306
|
|
max_connections: 900
|
|
stale_timeout: 300
|
|
minio:
|
|
user: '${MINIO_USER:-rag_flow}'
|
|
password: '${MINIO_PASSWORD:-infini_rag_flow}'
|
|
host: '${MINIO_HOST:-minio}:9000'
|
|
es:
|
|
hosts: 'http://${ES_HOST:-es01}:9200'
|
|
username: '${ES_USER:-elastic}'
|
|
password: '${ELASTIC_PASSWORD:-infini_rag_flow}'
|
|
os:
|
|
hosts: 'http://${OS_HOST:-opensearch01}:9201'
|
|
username: '${OS_USER:-admin}'
|
|
password: '${OPENSEARCHH_PASSWORD:-infini_rag_flow_OS_01}'
|
|
infinity:
|
|
uri: '${INFINITY_HOST:-infinity}:23817'
|
|
db_name: 'default_db'
|
|
redis:
|
|
db: 1
|
|
password: '${REDIS_PASSWORD:-infini_rag_flow}'
|
|
host: '${REDIS_HOST:-redis}:6379'
|
|
|
|
# postgres:
|
|
# name: '${POSTGRES_DBNAME:-rag_flow}'
|
|
# user: '${POSTGRES_USER:-rag_flow}'
|
|
# password: '${POSTGRES_PASSWORD:-infini_rag_flow}'
|
|
# host: '${POSTGRES_HOST:-postgres}'
|
|
# port: 5432
|
|
# max_connections: 100
|
|
# stale_timeout: 30
|
|
# s3:
|
|
# access_key: 'access_key'
|
|
# secret_key: 'secret_key'
|
|
# region: 'region'
|
|
# endpoint_url: 'endpoint_url'
|
|
# bucket: 'bucket'
|
|
# prefix_path: 'prefix_path'
|
|
# signature_version: 'v4'
|
|
# addressing_style: 'path'
|
|
# oss:
|
|
# access_key: '${ACCESS_KEY}'
|
|
# secret_key: '${SECRET_KEY}'
|
|
# endpoint_url: '${ENDPOINT}'
|
|
# region: '${REGION}'
|
|
# bucket: '${BUCKET}'
|
|
# prefix_path: '${OSS_PREFIX_PATH}'
|
|
# azure:
|
|
# auth_type: 'sas'
|
|
# container_url: 'container_url'
|
|
# sas_token: 'sas_token'
|
|
# azure:
|
|
# auth_type: 'spn'
|
|
# account_url: 'account_url'
|
|
# client_id: 'client_id'
|
|
# secret: 'secret'
|
|
# tenant_id: 'tenant_id'
|
|
# container_name: 'container_name'
|
|
# user_default_llm:
|
|
# factory: 'Tongyi-Qianwen'
|
|
# api_key: 'sk-xxxxxxxxxxxxx'
|
|
# base_url: ''
|
|
# default_models:
|
|
# chat_model: 'qwen-plus'
|
|
# embedding_model: 'BAAI/bge-large-zh-v1.5@BAAI'
|
|
# rerank_model: ''
|
|
# asr_model: ''
|
|
# image2text_model: ''
|
|
# oauth:
|
|
# github:
|
|
# type: github
|
|
# icon: github
|
|
# display_name: "Github"
|
|
# client_id: xxxxxxxxxxxxxxxxxxxxxxxxx
|
|
# client_secret: xxxxxxxxxxxxxxxxxxxxxxxx
|
|
# redirect_uri: https://your-app.com/v1/user/oauth/callback/github
|
|
# feishu:
|
|
# app_id: cli_xxxxxxxxxxxxxxxxxxx
|
|
# app_secret: xxxxxxxxxxxxxxxxxxxxxxxxxxxx
|
|
# app_access_token_url: https://open.feishu.cn/open-apis/auth/v3/app_access_token/internal
|
|
# user_access_token_url: https://open.feishu.cn/open-apis/authen/v1/oidc/access_token
|
|
# grant_type: 'authorization_code'
|
|
# custom_channel:
|
|
# type: oidc
|
|
# icon: sso
|
|
# display_name: "Custom Channel"
|
|
# issuer: https://provider.com/v1/oidc
|
|
# client_id: xxxxxxxxxxxxxxxxxxxxxxxxx
|
|
# client_secret: xxxxxxxxxxxxxxxxxxxxxxxx
|
|
# scope: "openid email profile"
|
|
# redirect_uri: https://your-app.com/v1/user/oauth/callback/custom_channel
|
|
# authentication:
|
|
# client:
|
|
# switch: false
|
|
# http_app_key:
|
|
# http_secret_key:
|
|
# site:
|
|
# switch: false
|
|
# permission:
|
|
# switch: false
|
|
# component: false
|
|
# dataset: false
|