什么是NoteDiscovery？Obsidian 的开源平替？

一、工具定位与核心优势：Obsidian 的开源平替之选

NoteDiscovery 是一款主打离线优先、数据自主的开源知识管理工具，如同私人专属的 "知识星球"，将所有数据存储在用户本地设备或自有服务器中，彻底摆脱云端依赖。作为 Obsidian 的高性价比开源平替，它完美平衡了 "低成本使用" 与 "高自由度定制"，核心优势集中在三大维度：

数据安全与离线可用性：所有笔记以本地文件形式存储，无云端同步带来的隐私泄露风险，断网环境下仍可自由查阅、编辑，检索速度媲美本地文件浏览；

轻量化与兼容性：采用纯 Markdown 格式记录内容，语法简洁易上手，支持无缝导出至其他 Markdown 兼容工具（如 Typora、Notion），无需担心格式丢失；

零成本与高扩展性：开源免费无订阅费用，支持插件拓展（如思维导图生成、高级检索）与主题自定义，适配个人学习、工作笔记、小团队协作等多种场景。

二、安装部署：本地与服务器双方案详解

NoteDiscovery 作为开源项目，需通过 GitHub 获取资源部署，支持本地设备直接运行与服务器搭建两种方式，满足不同使用场景需求：

从GitHub容器注册表运行（最简单且推荐）

直接使用GHCR的预建映像------无需建造！

💡 提示 ：一定要用来获取最新的功能和修复。ghcr.io/gamosoft/notediscovery:latest
📁 重要提示 - 卷映射：容器需要本地文件夹/文件才能正常工作：

**必备：**文件夹------您的个人笔记 将存储在这里（创建一个空文件夹）data

必备：包含主题文件的文件夹（至少必须有一个主题）themes``.css

**必备：**文件夹（基本功能可空）plugins

必填：文件（应用运行所需）config.yaml

可选：文件夹 - 如果你克隆了仓库，可以挂载它以查看 NoteDiscovery 中的应用文档documentation

设置选项：
极简（快速测试------只下载必需品）：
shell 复制代码
# Linux/macOS
mkdir -p data plugins themes  # data/ is for YOUR notes
curl -O https://raw.githubusercontent.com/gamosoft/notediscovery/main/config.yaml
# Download at least light and dark themes
curl -o themes/light.css https://raw.githubusercontent.com/gamosoft/notediscovery/main/themes/light.css
curl -o themes/dark.css https://raw.githubusercontent.com/gamosoft/notediscovery/main/themes/dark.css
sh 复制代码
# Windows PowerShell
mkdir data, plugins, themes -Force  # data\ is for YOUR notes
Invoke-WebRequest -Uri https://raw.githubusercontent.com/gamosoft/notediscovery/main/config.yaml -OutFile config.yaml
# Download at least light and dark themes
Invoke-WebRequest -Uri https://raw.githubusercontent.com/gamosoft/notediscovery/main/themes/light.css -OutFile themes/light.css
Invoke-WebRequest -Uri https://raw.githubusercontent.com/gamosoft/notediscovery/main/themes/dark.css -OutFile themes/dark.css
完整安装（推荐------包含所有主题、插件和文档）：
shell 复制代码
git clone https://github.com/gamosoft/notediscovery.git
cd notediscovery
# The data/ folder is empty - for your personal notes
# The documentation/ folder has app docs you can optionally mount

🔐 安全提示 ：身份验证默认禁用 ，密码为。admin

✅ 本地/测试：默认凭证没问题

⚠️ 公共网络 ：立即更改密码------详见 AUTHENTICATION.md

🎭 演示部署：使用默认的"管理员"密码

选项1：Docker Compose（推荐）

💡 多架构支持 ：Docker 镜像支持两者（树莓派、苹果硅片等）x86_64``ARM64

sh 复制代码

# Download the docker-compose file
curl -O https://raw.githubusercontent.com/gamosoft/notediscovery/main/docker-compose.ghcr.yml

# Or if you cloned the repo, just use it directly
docker-compose -f docker-compose.ghcr.yml up -d

# Access at http://localhost:8000
# Login with default password: admin

# View logs
docker-compose -f docker-compose.ghcr.yml logs -f

# Stop the application
docker-compose -f docker-compose.ghcr.yml down

选项二：Docker 运行（替代方案）

shell 复制代码

# Linux/macOS
docker run -d \
  --name notediscovery \
  -p 8000:8000 \
  -v $(pwd)/data:/app/data \
  -v $(pwd)/plugins:/app/plugins \
  -v $(pwd)/themes:/app/themes \
  -v $(pwd)/locales:/app/locales \
  -v $(pwd)/config.yaml:/app/config.yaml \
  --restart unless-stopped \
  ghcr.io/gamosoft/notediscovery:latest

powershell 复制代码

# Windows PowerShell
docker run -d `
  --name notediscovery `
  -p 8000:8000 `
  -v ${PWD}/data:/app/data `
  -v ${PWD}/plugins:/app/plugins `
  -v ${PWD}/themes:/app/themes `
  -v ${PWD}/locales:/app/locales `
  -v ${PWD}/config.yaml:/app/config.yaml `
  --restart unless-stopped `
  ghcr.io/gamosoft/notediscovery:latest

http://localhost:8000

为什么要用GHCR的图像？

✅ 无需构建时间------即时部署
✅ 始终保持最新发布
✅ 经过测试和验证的构建
✅ 下载较小且层数优化

使用 Docker Compose 运行（推荐开发）

Docker 确保环境一致和易于部署：

sh 复制代码

# Clone the repository
git clone https://github.com/gamosoft/notediscovery.git
cd notediscovery

# Start with Docker Compose
docker-compose up -d

# Access at http://localhost:8000

# View logs
docker-compose logs -f

# Stop the application
docker-compose down

要求：

Docker
Docker 组合

本地运行（无 Docker ）

无论是为了开发，还是如果你更喜欢直接运行：

复制代码

# Clone the repository
git clone https://github.com/gamosoft/notediscovery.git
cd notediscovery

# Install dependencies
pip install -r requirements.txt

# Run the application
python run.py

# Access at http://localhost:8000

要求：

Python 3.8 或更高版本
pip（Python package manager）

安装的依赖：

FastAPI - Web 框架
Uvicorn - ASGI 服务器
PyYAML - 配置处理
aiofiles - 异步文件作

三、基础使用指南：从创建笔记到知识库管理

NoteDiscovery 界面设计简洁直观，核心操作围绕 "笔记创建 - 关联 - 检索 - 导出" 展开，新手可快速上手：

（一）初始化设置

创建知识库：首次登录后，点击 "New Vault"，选择本地文件夹作为知识库存储路径（建议单独创建空文件夹，方便管理）；

基础配置：进入 "Settings" 界面，可设置默认编辑器主题（浅色 / 深色）、Markdown 语法自动补全、笔记保存间隔等基础选项。

（二）核心功能操作

笔记创建与编辑：

点击左侧 "+" 号选择 "New Note"，输入笔记标题后进入编辑界面；

支持 Markdown 标准语法：标题（#）、列表（-/*）、链接（文本）、图片等，编辑实时预览，无需切换视图；

笔记自动保存，本地文件以.md格式存储在知识库目录中，可直接用其他编辑器打开编辑。

笔记关联与检索：

关联功能：在笔记中输入[[笔记标题]]可快速链接已有笔记，形成知识图谱（需安装 "Graph View" 插件）；
检索功能：顶部搜索框输入关键词，支持标题、内容模糊检索，结果实时展示，检索速度毫秒级响应。

导出与备份：

单篇导出：打开笔记后点击右上角 "Export"，可选择导出为纯文本、PDF 或 Markdown 原文件；
批量备份：直接复制知识库文件夹至其他存储设备（如 U 盘、云盘），即可完成全量备份，恢复时替换原文件夹即可。

（三）插件与主题拓展

插件安装：进入 "Plugins" 界面，点击 "Browse" 查看可用插件（如思维导图生成、代码块高亮、表格编辑等），点击 "Install" 自动完成安装与启用；

主题更换：在 "Themes" 界面选择喜欢的主题风格（如极简、暗黑、学术风），点击应用即可实时切换，也可手动上传自定义主题文件。

四、使用场景与注意事项

（一）适配场景

个人知识管理：适合学生、职场人记录学习笔记、工作文档，离线可用性满足通勤、出差等移动场景；
小团队协作：通过服务器部署实现多人共享知识库，无订阅成本，适合初创团队、课题组文档协作；
隐私敏感场景：数据本地存储，无第三方获取风险，适合记录商业机密、个人隐私等敏感内容。

（二）注意事项

项目现状：作为新兴开源项目，目前功能迭代较快，部分高级插件（如多人协作、AI 辅助编辑）尚未完善，社区支持仍在成长中；

数据安全：服务器部署需做好防火墙配置与账号权限管理，避免未授权访问；本地使用建议定期备份知识库文件夹；

问题排查：遇到安装失败、启动报错等问题，可查看 GitHub 项目的 "Issues" 板块，或通过项目 README 中的联系方式反馈，核心开发者响应较为及时。

五、总结

NoteDiscovery 以 "离线优先、开源免费、高自由度" 为核心亮点，完美解决了传统知识管理工具 "订阅费用高、数据不安全、依赖网络" 的痛点，是 Obsidian 等付费工具的优质平替选择。无论是追求低成本个人知识库的新手，还是需要灵活定制的进阶用户，都能通过它构建专属的知识管理体系。

若想体验这款工具，可直接访问 GitHub 开源地址：https://github.com/gamo soft /No teDi scov ery ，获取最新源码与详细文档。随着项目的持续迭代，其功能完善度与社区支持度有望进一步提升，值得长期关注与使用。