mirror of
https://github.com/MODSetter/SurfSense.git
synced 2026-05-02 12:22:40 +02:00
chore: update links in documentation and metadata to use the correct domain
This commit is contained in:
parent
b8478f2ec0
commit
50edeadcaa
5 changed files with 78 additions and 22 deletions
|
|
@ -57,14 +57,14 @@ Want to fix it? Go for it! Just link the issue in your PR.
|
|||
|
||||
2. **Choose your setup method**:
|
||||
- **Docker Setup**: Follow the [Docker Setup Guide](./DOCKER_SETUP.md)
|
||||
- **Manual Setup**: Follow the [Installation Guide](https://www.surfsense.net/docs/)
|
||||
- **Manual Setup**: Follow the [Installation Guide](https://www.surfsense.com/docs/)
|
||||
|
||||
3. **Configure services**:
|
||||
- Set up PGVector & PostgreSQL
|
||||
- Configure a file ETL service: `Unstructured.io` or `LlamaIndex`
|
||||
- Add API keys for external services
|
||||
|
||||
For detailed setup instructions, refer to our [Installation Guide](https://www.surfsense.net/docs/).
|
||||
For detailed setup instructions, refer to our [Installation Guide](https://www.surfsense.com/docs/).
|
||||
|
||||
## 🏗️ Project Structure
|
||||
|
||||
|
|
@ -146,7 +146,7 @@ When contributing, please:
|
|||
Stuck? Need clarification? Here's how to get help:
|
||||
|
||||
1. **Check existing issues** - your question might already be answered
|
||||
2. **Search the docs** - [https://www.surfsense.net/docs/](https://www.surfsense.net/docs/)
|
||||
2. **Search the docs** - [https://www.surfsense.com/docs/](https://www.surfsense.com/docs/)
|
||||
3. **Ask in Discord** - [https://discord.gg/ejRNvftDp9](https://discord.gg/ejRNvftDp9)
|
||||
4. **Create an issue** - if it's a bug or feature request
|
||||
|
||||
|
|
|
|||
|
|
@ -153,7 +153,7 @@ Check out our public roadmap and contribute your ideas or feedback:
|
|||
### Quick Start with Docker 🐳
|
||||
|
||||
> [!TIP]
|
||||
> For production deployments, use the full [Docker Compose setup](https://www.surfsense.net/docs/docker-installation) which offers more control and scalability.
|
||||
> For production deployments, use the full [Docker Compose setup](https://www.surfsense.com/docs/docker-installation) which offers more control and scalability.
|
||||
|
||||
**Linux/macOS:**
|
||||
|
||||
|
|
@ -215,17 +215,17 @@ SurfSense provides multiple options to get started:
|
|||
- Perfect for evaluation, development, and small deployments
|
||||
- Data persisted via Docker volume
|
||||
|
||||
3. **[Docker Compose (Production)](https://www.surfsense.net/docs/docker-installation)** - Full stack deployment with separate services.
|
||||
3. **[Docker Compose (Production)](https://www.surfsense.com/docs/docker-installation)** - Full stack deployment with separate services.
|
||||
- Includes pgAdmin for database management through a web UI
|
||||
- Supports environment variable customization via `.env` file
|
||||
- Flexible deployment options (full stack or core services only)
|
||||
- Better for production with separate scaling of services
|
||||
|
||||
4. **[Manual Installation](https://www.surfsense.net/docs/manual-installation)** - For users who prefer more control over their setup or need to customize their deployment.
|
||||
4. **[Manual Installation](https://www.surfsense.com/docs/manual-installation)** - For users who prefer more control over their setup or need to customize their deployment.
|
||||
|
||||
Docker and manual installation guides include detailed OS-specific instructions for Windows, macOS, and Linux.
|
||||
|
||||
Before self-hosting installation, make sure to complete the [prerequisite setup steps](https://www.surfsense.net/docs/) including:
|
||||
Before self-hosting installation, make sure to complete the [prerequisite setup steps](https://www.surfsense.com/docs/) including:
|
||||
- Auth setup (optional - defaults to LOCAL auth)
|
||||
- **File Processing ETL Service** (optional - defaults to Docling):
|
||||
- Docling (default, local processing, no API key required, supports PDF, Office docs, images, HTML, CSV)
|
||||
|
|
|
|||
|
|
@ -157,32 +157,88 @@ https://github.com/user-attachments/assets/a0a16566-6967-4374-ac51-9b3e07fbecd7
|
|||
|
||||
## 如何开始?
|
||||
|
||||
### 使用 Docker 快速开始 🐳
|
||||
|
||||
> [!TIP]
|
||||
> 对于生产部署,请使用完整的 [Docker Compose 设置](https://www.surfsense.com/docs/docker-installation),它提供更多控制和可扩展性。
|
||||
|
||||
**Linux/macOS:**
|
||||
|
||||
```bash
|
||||
docker run -d -p 3000:3000 -p 8000:8000 \
|
||||
-v surfsense-data:/data \
|
||||
--name surfsense \
|
||||
--restart unless-stopped \
|
||||
ghcr.io/modsetter/surfsense:latest
|
||||
```
|
||||
|
||||
**Windows (PowerShell):**
|
||||
|
||||
```powershell
|
||||
docker run -d -p 3000:3000 -p 8000:8000 `
|
||||
-v surfsense-data:/data `
|
||||
--name surfsense `
|
||||
--restart unless-stopped `
|
||||
ghcr.io/modsetter/surfsense:latest
|
||||
```
|
||||
|
||||
**使用自定义配置(例如 OpenAI 嵌入):**
|
||||
|
||||
```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
|
||||
```
|
||||
|
||||
启动后,访问 SurfSense:
|
||||
- **前端**: [http://localhost:3000](http://localhost:3000)
|
||||
- **后端 API**: [http://localhost:8000](http://localhost:8000)
|
||||
- **API 文档**: [http://localhost:8000/docs](http://localhost:8000/docs)
|
||||
|
||||
**常用命令:**
|
||||
|
||||
```bash
|
||||
docker logs -f surfsense # 查看日志
|
||||
docker stop surfsense # 停止
|
||||
docker start surfsense # 启动
|
||||
docker rm surfsense # 删除(数据保留在卷中)
|
||||
```
|
||||
|
||||
### 安装选项
|
||||
|
||||
SurfSense 提供三种入门方式:
|
||||
SurfSense 提供多种入门方式:
|
||||
|
||||
1. **[SurfSense Cloud](https://www.surfsense.com/login)** - 无需任何设置即可试用 SurfSense 的最简单方法。
|
||||
- 无需安装
|
||||
- 即时访问所有功能
|
||||
- 非常适合快速上手
|
||||
|
||||
2. **[Docker 安装(推荐用于自托管)](https://www.surfsense.net/docs/docker-installation)** - 通过容器化所有依赖项,轻松启动和运行 SurfSense。
|
||||
2. **快速启动 Docker(上述方法)** - 一条命令即可在本地运行 SurfSense。
|
||||
- 一体化镜像,捆绑 PostgreSQL、Redis 和所有服务
|
||||
- 非常适合评估、开发和小型部署
|
||||
- 数据通过 Docker 卷持久化
|
||||
|
||||
3. **[Docker Compose(生产环境)](https://www.surfsense.com/docs/docker-installation)** - 使用独立服务进行完整堆栈部署。
|
||||
- 包含 pgAdmin,通过 Web UI 进行数据库管理
|
||||
- 支持通过 `.env` 文件自定义环境变量
|
||||
- 灵活的部署选项(完整堆栈或仅核心服务)
|
||||
- 无需在环境之间手动编辑配置文件
|
||||
- 更适合生产环境,支持独立扩展服务
|
||||
|
||||
3. **[手动安装](https://www.surfsense.net/docs/manual-installation)** - 适合希望对设置有更多控制或需要自定义部署的用户。
|
||||
4. **[手动安装](https://www.surfsense.com/docs/manual-installation)** - 适合希望对设置有更多控制或需要自定义部署的用户。
|
||||
|
||||
Docker 和手动安装指南都包含适用于 Windows、macOS 和 Linux 的详细操作系统特定说明。
|
||||
|
||||
在自托管安装之前,请确保完成[先决条件设置步骤](https://www.surfsense.net/docs/),包括:
|
||||
- 身份验证设置
|
||||
- **文件处理 ETL 服务**(选择其一):
|
||||
在自托管安装之前,请确保完成[先决条件设置步骤](https://www.surfsense.com/docs/),包括:
|
||||
- 身份验证设置(可选 - 默认为 LOCAL 身份验证)
|
||||
- **文件处理 ETL 服务**(可选 - 默认为 Docling):
|
||||
- Docling(默认,本地处理,无需 API 密钥,支持 PDF、Office 文档、图像、HTML、CSV)
|
||||
- Unstructured.io API 密钥(支持 34+ 种格式)
|
||||
- LlamaIndex API 密钥(增强解析,支持 50+ 种格式)
|
||||
- Docling(本地处理,无需 API 密钥,支持 PDF、Office 文档、图像、HTML、CSV)
|
||||
- 其他所需的 API 密钥
|
||||
- 其他根据用例需要的 API 密钥
|
||||
|
||||
## 截图
|
||||
|
||||
|
|
|
|||
|
|
@ -103,7 +103,7 @@ const ApiKeyForm = () => {
|
|||
<p className="text-sm text-gray-400">
|
||||
Need an API key?{" "}
|
||||
<a
|
||||
href="https://www.surfsense.net"
|
||||
href="https://www.surfsense.com"
|
||||
target="_blank"
|
||||
className="text-teal-400 hover:text-teal-300 hover:underline"
|
||||
rel="noopener"
|
||||
|
|
|
|||
|
|
@ -50,12 +50,12 @@ export const metadata: Metadata = {
|
|||
title: "SurfSense – AI Research & Knowledge Management Assistant",
|
||||
description:
|
||||
"Connect your documents and tools like Notion, Slack, GitHub, and more to your private AI assistant. SurfSense offers powerful search, document chat, podcast generation, and RAG APIs to enhance your workflow.",
|
||||
url: "https://surfsense.net",
|
||||
url: "https://surfsense.com",
|
||||
siteName: "SurfSense",
|
||||
type: "website",
|
||||
images: [
|
||||
{
|
||||
url: "https://surfsense.net/og-image.png",
|
||||
url: "https://surfsense.com/og-image.png",
|
||||
width: 1200,
|
||||
height: 630,
|
||||
alt: "SurfSense AI Research Assistant",
|
||||
|
|
@ -68,11 +68,11 @@ export const metadata: Metadata = {
|
|||
title: "SurfSense – AI Assistant for Research & Knowledge Management",
|
||||
description:
|
||||
"Have your own NotebookLM or Perplexity, but better. SurfSense connects external tools, allows chat with your documents, and generates fast, high-quality podcasts.",
|
||||
creator: "https://surfsense.net",
|
||||
site: "https://surfsense.net",
|
||||
creator: "https://surfsense.com",
|
||||
site: "https://surfsense.com",
|
||||
images: [
|
||||
{
|
||||
url: "https://surfsense.net/og-image-twitter.png",
|
||||
url: "https://surfsense.com/og-image-twitter.png",
|
||||
width: 1200,
|
||||
height: 630,
|
||||
alt: "SurfSense AI Assistant Preview",
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue