From 71e9ba4652b607ba6df63101dfe6c4d0c11402ae Mon Sep 17 00:00:00 2001 From: "DESKTOP-RTLN3BA\\$punk" Date: Mon, 9 Jun 2025 16:33:24 -0700 Subject: [PATCH] chore updated docs --- surfsense_backend/.env.example | 8 ---- .../content/docs/docker-installation.mdx | 45 +++++------------- .../content/docs/manual-installation.mdx | 46 +++++-------------- 3 files changed, 22 insertions(+), 77 deletions(-) diff --git a/surfsense_backend/.env.example b/surfsense_backend/.env.example index 0915906..9a66a43 100644 --- a/surfsense_backend/.env.example +++ b/surfsense_backend/.env.example @@ -45,11 +45,3 @@ LANGSMITH_API_KEY=lsv2_pt_..... LANGSMITH_PROJECT=surfsense - -# FAST_LLM=openai/gpt-4o-mini -# STRATEGIC_LLM=openai/gpt-4o -# LONG_CONTEXT_LLM=gemini/gemini-2.0-flash - -# FAST_LLM=ollama/gemma3:12b -# STRATEGIC_LLM=ollama/deepseek-r1:8b -# LONG_CONTEXT_LLM=ollama/deepseek-r1:8b diff --git a/surfsense_web/content/docs/docker-installation.mdx b/surfsense_web/content/docs/docker-installation.mdx index 0f27546..ca91d21 100644 --- a/surfsense_web/content/docs/docker-installation.mdx +++ b/surfsense_web/content/docs/docker-installation.mdx @@ -83,37 +83,25 @@ Before you begin, ensure you have: | -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | DATABASE_URL | PostgreSQL connection string (e.g., `postgresql+asyncpg://postgres:postgres@localhost:5432/surfsense`) | | SECRET_KEY | JWT Secret key for authentication (should be a secure random string) | -| AUTH_TYPE | Authentication method: `GOOGLE` for OAuth with Google, `LOCAL` for email/password authentication | | NEXT_FRONTEND_URL | URL where your frontend application is hosted (e.g., `http://localhost:3000`) | -| EMBEDDING_MODEL | Name of the embedding model (e.g., `openai://text-embedding-ada-002`, `anthropic://claude-v1`, `mixedbread-ai/mxbai-embed-large-v1`) | +| AUTH_TYPE | Authentication method: `GOOGLE` for OAuth with Google, `LOCAL` for email/password authentication | +| GOOGLE_OAUTH_CLIENT_ID | (Optional) Client ID from Google Cloud Console (required if AUTH_TYPE=GOOGLE) | +| GOOGLE_OAUTH_CLIENT_SECRET | (Optional) Client secret from Google Cloud Console (required if AUTH_TYPE=GOOGLE) | +| EMBEDDING_MODEL | Name of the embedding model (e.g., `mixedbread-ai/mxbai-embed-large-v1`) | | RERANKERS_MODEL_NAME | Name of the reranker model (e.g., `ms-marco-MiniLM-L-12-v2`) | | RERANKERS_MODEL_TYPE | Type of reranker model (e.g., `flashrank`) | -| FAST_LLM | LiteLLM routed smaller, faster LLM (e.g., `openai/gpt-4o-mini`, `ollama/deepseek-r1:8b`) | -| STRATEGIC_LLM | LiteLLM routed advanced LLM for complex tasks (e.g., `openai/gpt-4o`, `ollama/gemma3:12b`) | -| LONG_CONTEXT_LLM | LiteLLM routed LLM for longer context windows (e.g., `gemini/gemini-2.0-flash`, `ollama/deepseek-r1:8b`) | +| TTS_SERVICE | Text-to-Speech API provider for Podcasts (e.g., `openai/tts-1`). See [supported providers](https://docs.litellm.ai/docs/text_to_speech#supported-providers) | +| TTS_SERVICE_API_KEY | API key for the Text-to-Speech service | +| TTS_SERVICE_API_BASE | (Optional) Custom API base URL for the Text-to-Speech service | +| STT_SERVICE | Speech-to-Text API provider for Podcasts (e.g., `openai/whisper-1`). See [supported providers](https://docs.litellm.ai/docs/audio_transcription#supported-providers) | +| STT_SERVICE_API_KEY | API key for the Speech-to-Text service | +| STT_SERVICE_API_BASE | (Optional) Custom API base URL for the Speech-to-Text service | +| FIRECRAWL_API_KEY | API key for Firecrawl service for web crawling | | ETL_SERVICE | Document parsing service: `UNSTRUCTURED` (supports 34+ formats) or `LLAMACLOUD` (supports 50+ formats including legacy document types) | | UNSTRUCTURED_API_KEY | API key for Unstructured.io service for document parsing (required if ETL_SERVICE=UNSTRUCTURED) | | LLAMA_CLOUD_API_KEY | API key for LlamaCloud service for document parsing (required if ETL_SERVICE=LLAMACLOUD) | -| FIRECRAWL_API_KEY | API key for Firecrawl service for web crawling | -| TTS_SERVICE | Text-to-Speech API provider for Podcasts (e.g., `openai/tts-1`, `azure/neural`, `vertex_ai/`). See [supported providers](https://docs.litellm.ai/docs/text_to_speech#supported-providers) | -| STT_SERVICE | Speech-to-Text API provider for Podcasts (e.g., `openai/whisper-1`). See [supported providers](https://docs.litellm.ai/docs/audio_transcription#supported-providers) | -Include API keys for your chosen LLM providers: - -| ENV VARIABLE | DESCRIPTION | -|--------------------|-----------------------------------------------------------------------------| -| `OPENAI_API_KEY` | Required if using OpenAI models | -| `GEMINI_API_KEY` | Required if using Google Gemini models | -| `ANTHROPIC_API_KEY`| Required if using Anthropic models | - -### Google OAuth Configuration (if AUTH_TYPE=GOOGLE) - -| ENV VARIABLE | DESCRIPTION | -|----------------------------|-----------------------------------------------------------------------------| -| `GOOGLE_OAUTH_CLIENT_ID` | Client ID from Google Cloud Console | -| `GOOGLE_OAUTH_CLIENT_SECRET` | Client secret from Google Cloud Console | - **Optional Backend LangSmith Observability:** | ENV VARIABLE | DESCRIPTION | |--------------|-------------| @@ -122,17 +110,6 @@ Include API keys for your chosen LLM providers: | LANGSMITH_API_KEY | Your LangSmith API key | | LANGSMITH_PROJECT | LangSmith project name (e.g., `surfsense`) | -**Optional Backend LiteLLM API Base URLs:** -| ENV VARIABLE | DESCRIPTION | -|--------------|-------------| -| FAST_LLM_API_BASE | Custom API base URL for the fast LLM | -| STRATEGIC_LLM_API_BASE | Custom API base URL for the strategic LLM | -| LONG_CONTEXT_LLM_API_BASE | Custom API base URL for the long context LLM | -| TTS_SERVICE_API_BASE | Custom API base URL for the Text-to-Speech (TTS) service | -| STT_SERVICE_API_BASE | Custom API base URL for the Speech-to-Text (STT) service | - -For other LLM providers, refer to the [LiteLLM documentation](https://docs.litellm.ai/docs/providers). - ### Frontend Environment Variables | ENV VARIABLE | DESCRIPTION | diff --git a/surfsense_web/content/docs/manual-installation.mdx b/surfsense_web/content/docs/manual-installation.mdx index 9eb149e..a6a104a 100644 --- a/surfsense_web/content/docs/manual-installation.mdx +++ b/surfsense_web/content/docs/manual-installation.mdx @@ -53,38 +53,23 @@ Edit the `.env` file and set the following variables: | -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | DATABASE_URL | PostgreSQL connection string (e.g., `postgresql+asyncpg://postgres:postgres@localhost:5432/surfsense`) | | SECRET_KEY | JWT Secret key for authentication (should be a secure random string) | -| AUTH_TYPE | Authentication method: `GOOGLE` for OAuth with Google, `LOCAL` for email/password authentication | | NEXT_FRONTEND_URL | URL where your frontend application is hosted (e.g., `http://localhost:3000`) | -| EMBEDDING_MODEL | Name of the embedding model (e.g., `openai://text-embedding-ada-002`, `anthropic://claude-v1`, `mixedbread-ai/mxbai-embed-large-v1`) | +| AUTH_TYPE | Authentication method: `GOOGLE` for OAuth with Google, `LOCAL` for email/password authentication | +| GOOGLE_OAUTH_CLIENT_ID | (Optional) Client ID from Google Cloud Console (required if AUTH_TYPE=GOOGLE) | +| GOOGLE_OAUTH_CLIENT_SECRET | (Optional) Client secret from Google Cloud Console (required if AUTH_TYPE=GOOGLE) | +| EMBEDDING_MODEL | Name of the embedding model (e.g., `mixedbread-ai/mxbai-embed-large-v1`) | | RERANKERS_MODEL_NAME | Name of the reranker model (e.g., `ms-marco-MiniLM-L-12-v2`) | | RERANKERS_MODEL_TYPE | Type of reranker model (e.g., `flashrank`) | -| FAST_LLM | LiteLLM routed smaller, faster LLM (e.g., `openai/gpt-4o-mini`, `ollama/deepseek-r1:8b`) | -| STRATEGIC_LLM | LiteLLM routed advanced LLM for complex tasks (e.g., `openai/gpt-4o`, `ollama/gemma3:12b`) | -| LONG_CONTEXT_LLM | LiteLLM routed LLM for longer context windows (e.g., `gemini/gemini-2.0-flash`, `ollama/deepseek-r1:8b`) | +| TTS_SERVICE | Text-to-Speech API provider for Podcasts (e.g., `openai/tts-1`). See [supported providers](https://docs.litellm.ai/docs/text_to_speech#supported-providers) | +| TTS_SERVICE_API_KEY | API key for the Text-to-Speech service | +| TTS_SERVICE_API_BASE | (Optional) Custom API base URL for the Text-to-Speech service | +| STT_SERVICE | Speech-to-Text API provider for Podcasts (e.g., `openai/whisper-1`). See [supported providers](https://docs.litellm.ai/docs/audio_transcription#supported-providers) | +| STT_SERVICE_API_KEY | API key for the Speech-to-Text service | +| STT_SERVICE_API_BASE | (Optional) Custom API base URL for the Speech-to-Text service | +| FIRECRAWL_API_KEY | API key for Firecrawl service for web crawling | | ETL_SERVICE | Document parsing service: `UNSTRUCTURED` (supports 34+ formats) or `LLAMACLOUD` (supports 50+ formats including legacy document types) | | UNSTRUCTURED_API_KEY | API key for Unstructured.io service for document parsing (required if ETL_SERVICE=UNSTRUCTURED) | | LLAMA_CLOUD_API_KEY | API key for LlamaCloud service for document parsing (required if ETL_SERVICE=LLAMACLOUD) | -| FIRECRAWL_API_KEY | API key for Firecrawl service for web crawling | -| TTS_SERVICE | Text-to-Speech API provider for Podcasts (e.g., `openai/tts-1`, `azure/neural`, `vertex_ai/`). See [supported providers](https://docs.litellm.ai/docs/text_to_speech#supported-providers) | -| STT_SERVICE | Speech-to-Text API provider for Podcasts (e.g., `openai/whisper-1`). See [supported providers](https://docs.litellm.ai/docs/audio_transcription#supported-providers) | - - -Include API keys for your chosen LLM providers: - -| ENV VARIABLE | DESCRIPTION | -|--------------------|-----------------------------------------------------------------------------| -| `OPENAI_API_KEY` | Required if using OpenAI models | -| `GEMINI_API_KEY` | Required if using Google Gemini models | -| `ANTHROPIC_API_KEY`| Required if using Anthropic models | - -For other providers, refer to the [LiteLLM documentation](https://docs.litellm.ai/docs/providers) - -### Google OAuth Configuration (if AUTH_TYPE=GOOGLE) - -| ENV VARIABLE | DESCRIPTION | -|----------------------------|-----------------------------------------------------------------------------| -| `GOOGLE_OAUTH_CLIENT_ID` | Client ID from Google Cloud Console | -| `GOOGLE_OAUTH_CLIENT_SECRET` | Client secret from Google Cloud Console | **Optional Backend LangSmith Observability:** @@ -95,15 +80,6 @@ For other providers, refer to the [LiteLLM documentation](https://docs.litellm.a | LANGSMITH_API_KEY | Your LangSmith API key | | LANGSMITH_PROJECT | LangSmith project name (e.g., `surfsense`) | -**Optional Backend LiteLLM API Base URLs:** -| ENV VARIABLE | DESCRIPTION | -|--------------|-------------| -| FAST_LLM_API_BASE | Custom API base URL for the fast LLM | -| STRATEGIC_LLM_API_BASE | Custom API base URL for the strategic LLM | -| LONG_CONTEXT_LLM_API_BASE | Custom API base URL for the long context LLM | -| TTS_SERVICE_API_BASE | Custom API base URL for the Text-to-Speech (TTS) service | -| STT_SERVICE_API_BASE | Custom API base URL for the Speech-to-Text (STT) service | - ### 2. Install Dependencies Install the backend dependencies using `uv`: