docs: update README

2026-05-25 19:15:18 +02:00 · 2026-01-07 19:43:31 -08:00 · 2026-01-07 19:43:31 -08:00 · c9a9d29c54
commit c9a9d29c54
parent a6200ee3a2
4 changed files with 29 additions and 61 deletions
--- a/README.md
+++ b/README.md
@ -174,44 +174,29 @@ docker run -d -p 3000:3000 -p 8000:8000 `
  ghcr.io/modsetter/surfsense:latest
 ```

-**With Custom Configuration (e.g., OpenAI Embeddings):**
+**With Custom Configuration:**
+
+You can pass any environment variable using `-e` flags:

 ```bash
 docker run -d -p 3000:3000 -p 8000:8000 \
  -v surfsense-data:/data \
  -e EMBEDDING_MODEL=openai://text-embedding-ada-002 \
  -e OPENAI_API_KEY=your_openai_api_key \
-  --name surfsense \
-  --restart unless-stopped \
-  ghcr.io/modsetter/surfsense:latest
-```
-
-**With OAuth-based Connectors (Google Calendar, Gmail, Drive, Airtable):**
-
-To use OAuth-based connectors, you need to configure the respective client credentials:
-
-```bash
-docker run -d -p 3000:3000 -p 8000:8000 \
-  -v surfsense-data:/data \
-  # Google Connectors (Calendar, Gmail, Drive)
+  -e AUTH_TYPE=GOOGLE \
  -e GOOGLE_OAUTH_CLIENT_ID=your_google_client_id \
  -e GOOGLE_OAUTH_CLIENT_SECRET=your_google_client_secret \
-  -e GOOGLE_CALENDAR_REDIRECT_URI=http://localhost:8000/api/v1/auth/google/calendar/connector/callback \
-  -e GOOGLE_GMAIL_REDIRECT_URI=http://localhost:8000/api/v1/auth/google/gmail/connector/callback \
-  -e GOOGLE_DRIVE_REDIRECT_URI=http://localhost:8000/api/v1/auth/google/drive/connector/callback \
-  # Airtable Connector
-  -e AIRTABLE_CLIENT_ID=your_airtable_client_id \
-  -e AIRTABLE_CLIENT_SECRET=your_airtable_client_secret \
-  -e AIRTABLE_REDIRECT_URI=http://localhost:8000/api/v1/auth/airtable/connector/callback \
+  -e ETL_SERVICE=LLAMACLOUD \
+  -e LLAMA_CLOUD_API_KEY=your_llama_cloud_key \
  --name surfsense \
  --restart unless-stopped \
  ghcr.io/modsetter/surfsense:latest
 ```

 > [!NOTE]
-> - For Google connectors, create OAuth 2.0 credentials in the [Google Cloud Console](https://console.cloud.google.com/apis/credentials)
+> - For Google OAuth, create credentials in the [Google Cloud Console](https://console.cloud.google.com/apis/credentials)
 > - For Airtable connector, create an OAuth integration in the [Airtable Developer Hub](https://airtable.com/create/oauth)
-> - If deploying behind a reverse proxy with HTTPS, add `-e BACKEND_URL=https://api.yourdomain.com` and update the redirect URIs accordingly
+> - If deploying behind a reverse proxy with HTTPS, add `-e BACKEND_URL=https://api.yourdomain.com`

 After starting, access SurfSense at:
 - **Frontend**: [http://localhost:3000](http://localhost:3000)
--- a/README.zh-CN.md
+++ b/README.zh-CN.md
@ -181,44 +181,29 @@ docker run -d -p 3000:3000 -p 8000:8000 `
  ghcr.io/modsetter/surfsense:latest
 ```

-**使用自定义配置（例如 OpenAI 嵌入）：**
+**使用自定义配置：**
+
+您可以使用 `-e` 标志传递任何环境变量：

 ```bash
 docker run -d -p 3000:3000 -p 8000:8000 \
  -v surfsense-data:/data \
  -e EMBEDDING_MODEL=openai://text-embedding-ada-002 \
  -e OPENAI_API_KEY=your_openai_api_key \
-  --name surfsense \
-  --restart unless-stopped \
-  ghcr.io/modsetter/surfsense:latest
-```
-
-**使用 OAuth 连接器（Google 日历、Gmail、云端硬盘、Airtable）：**
-
-要使用基于 OAuth 的连接器，您需要配置相应的客户端凭据：
-
-```bash
-docker run -d -p 3000:3000 -p 8000:8000 \
-  -v surfsense-data:/data \
-  # Google 连接器（日历、Gmail、云端硬盘）
+  -e AUTH_TYPE=GOOGLE \
  -e GOOGLE_OAUTH_CLIENT_ID=your_google_client_id \
  -e GOOGLE_OAUTH_CLIENT_SECRET=your_google_client_secret \
-  -e GOOGLE_CALENDAR_REDIRECT_URI=http://localhost:8000/api/v1/auth/google/calendar/connector/callback \
-  -e GOOGLE_GMAIL_REDIRECT_URI=http://localhost:8000/api/v1/auth/google/gmail/connector/callback \
-  -e GOOGLE_DRIVE_REDIRECT_URI=http://localhost:8000/api/v1/auth/google/drive/connector/callback \
-  # Airtable 连接器
-  -e AIRTABLE_CLIENT_ID=your_airtable_client_id \
-  -e AIRTABLE_CLIENT_SECRET=your_airtable_client_secret \
-  -e AIRTABLE_REDIRECT_URI=http://localhost:8000/api/v1/auth/airtable/connector/callback \
+  -e ETL_SERVICE=LLAMACLOUD \
+  -e LLAMA_CLOUD_API_KEY=your_llama_cloud_key \
  --name surfsense \
  --restart unless-stopped \
  ghcr.io/modsetter/surfsense:latest
 ```

 > [!NOTE]
-> - 对于 Google 连接器，请在 [Google Cloud Console](https://console.cloud.google.com/apis/credentials) 中创建 OAuth 2.0 凭据
+> - 对于 Google OAuth，请在 [Google Cloud Console](https://console.cloud.google.com/apis/credentials) 中创建凭据
 > - 对于 Airtable 连接器，请在 [Airtable 开发者中心](https://airtable.com/create/oauth) 中创建 OAuth 集成
-> - 如果部署在带有 HTTPS 的反向代理后面，请添加 `-e BACKEND_URL=https://api.yourdomain.com` 并相应地更新重定向 URI
+> - 如果部署在带有 HTTPS 的反向代理后面，请添加 `-e BACKEND_URL=https://api.yourdomain.com`

 启动后，访问 SurfSense：
 - **前端**: [http://localhost:3000](http://localhost:3000)
--- a/surfsense_backend/.env.example
+++ b/surfsense_backend/.env.example
@ -56,8 +56,8 @@ DISCORD_REDIRECT_URI=http://localhost:8000/api/v1/auth/discord/connector/callbac
 DISCORD_BOT_TOKEN=your_bot_token_from_developer_portal

 # Atlassian OAuth Configuration
-ATLASSIAN_CLIENT_ID=V4Axk5VLcsAKJxffMjRGSHtlh17uVswl
-ATLASSIAN_CLIENT_SECRET=ATOAmjcoJ_wpyr98F5nF9BVZFDtXpLHs53YnK8TVQhjJh2LuRPYrnDirBwW5lV5cWRbK9B430F02
+ATLASSIAN_CLIENT_ID=your_atlassian_client_id_here
+ATLASSIAN_CLIENT_SECRET=your_atlassian_client_secret_here
 JIRA_REDIRECT_URI=http://localhost:8000/api/v1/auth/jira/connector/callback
 CONFLUENCE_REDIRECT_URI=http://localhost:8000/api/v1/auth/confluence/connector/callback

--- a/surfsense_web/content/docs/docker-installation.mdx
+++ b/surfsense_web/content/docs/docker-installation.mdx
@ -47,31 +47,29 @@ docker run -d -p 3000:3000 -p 8000:8000 `

 ### With Custom Configuration

-**Using OpenAI Embeddings:**
+You can pass any [environment variable](/docs/manual-installation#backend-environment-variables) using `-e` flags:

 ```bash
 docker run -d -p 3000:3000 -p 8000:8000 \
  -v surfsense-data:/data \
  -e EMBEDDING_MODEL=openai://text-embedding-ada-002 \
  -e OPENAI_API_KEY=your_openai_api_key \
-  --name surfsense \
-  --restart unless-stopped \
-  ghcr.io/modsetter/surfsense:latest
-```
-
-**With Google OAuth:**
-
-```bash
-docker run -d -p 3000:3000 -p 8000:8000 \
-  -v surfsense-data:/data \
  -e AUTH_TYPE=GOOGLE \
-  -e GOOGLE_OAUTH_CLIENT_ID=your_client_id \
-  -e GOOGLE_OAUTH_CLIENT_SECRET=your_client_secret \
+  -e GOOGLE_OAUTH_CLIENT_ID=your_google_client_id \
+  -e GOOGLE_OAUTH_CLIENT_SECRET=your_google_client_secret \
+  -e ETL_SERVICE=LLAMACLOUD \
+  -e LLAMA_CLOUD_API_KEY=your_llama_cloud_key \
  --name surfsense \
  --restart unless-stopped \
  ghcr.io/modsetter/surfsense:latest
 ```

+<Callout type="info">
+- For Google OAuth, create credentials in the [Google Cloud Console](https://console.cloud.google.com/apis/credentials)
+- For Airtable connector, create an OAuth integration in the [Airtable Developer Hub](https://airtable.com/create/oauth)
+- If deploying behind a reverse proxy with HTTPS, add `-e BACKEND_URL=https://api.yourdomain.com`
+</Callout>
+
 ### Quick Start with Docker Compose

 For easier management with environment files: