feat: add Fast Note Sync Service with configuration, documentation, and logo

2026-06-10 00:19:38 +08:00 · 2026-05-25 14:26:34 +08:00
parent 157504bb71
commit cf5e3c016c
11 changed files with 171 additions and 1 deletions
@@ -14,4 +14,7 @@
 .trae

 # Codex
-.codex
+.codex
+
+# superpowers
+/docs
@@ -0,0 +1,14 @@
+additionalProperties:
+  formFields:
+    - default: 9000
+      edit: true
+      envKey: PANEL_APP_PORT_HTTP
+      labelEn: Web/API Port
+      labelZh: Web/API 端口
+      required: true
+      rule: paramPort
+      type: number
+      label:
+        en: Web/API Port
+        zh: Web/API 端口
+        zh-Hant: Web/API 連接埠
@@ -0,0 +1 @@
+
@@ -0,0 +1,18 @@
+services:
+  fast-note-sync-service:
+    image: haierkeys/fast-note-sync-service:3.1.0
+    container_name: ${CONTAINER_NAME}
+    restart: always
+    ports:
+      - "${PANEL_APP_PORT_HTTP}:9000"
+    networks:
+      - 1panel-network
+    volumes:
+      - ./data/storage:/fast-note-sync/storage
+      - ./data/config:/fast-note-sync/config
+    labels:
+      createdBy: "Apps"
+
+networks:
+  1panel-network:
+    external: true
@@ -0,0 +1,36 @@
+# Fast Note Sync Service
+
+Fast Note Sync Service 是一个高性能、低延迟的 Obsidian 笔记同步、在线管理与 REST API 服务平台，基于 Go、WebSocket 和 React 构建。
+
+## 功能特点
+
+- 支持 Obsidian 笔记、目录、配置和附件同步
+- 提供 Web 管理面板，可创建用户、管理仓库并查看笔记内容
+- 支持 REST API、MCP、分享、历史版本、回收站和多存储备份
+- 支持 SQLite、MySQL 和 PostgreSQL 等数据库配置
+
+## 使用说明
+
+### 默认端口
+
+- Web 管理面板 / API / WebSocket: 9000
+
+### 初始账号
+
+- 首次访问 `http://服务器IP:9000` 后注册第一个账号
+- 如需关闭公开注册，请在配置文件中设置 `user.register-is-enable: false`
+
+### 数据目录
+
+- 笔记与附件数据: `./data/storage`
+- 配置文件: `./data/config`
+
+### 客户端配置
+
+登录 Web 管理面板后，点击“复制 API 配置”，并粘贴到 Obsidian Fast Note Sync 插件设置中。
+
+## 相关链接
+
+- GitHub: https://github.com/haierkeys/fast-note-sync-service
+- Obsidian 插件: https://github.com/haierkeys/obsidian-fast-note-sync
+- REST API 文档: https://github.com/haierkeys/fast-note-sync-service/blob/master/docs/REST_API.md
@@ -0,0 +1,36 @@
+# Fast Note Sync Service
+
+Fast Note Sync Service is a high-performance, low-latency note synchronization, online management, and REST API service platform for Obsidian, built with Go, WebSocket, and React.
+
+## Features
+
+- Sync Obsidian notes, folders, configuration, and attachments
+- Web administration panel for users, vaults, and note browsing
+- REST API, MCP, sharing, history, trash, and multi-storage backup support
+- Configurable SQLite, MySQL, and PostgreSQL database support
+
+## Usage
+
+### Default Port
+
+- Web admin panel / API / WebSocket: 9000
+
+### Initial Account
+
+- Open `http://SERVER_IP:9000` and register the first account
+- To disable public registration, set `user.register-is-enable: false` in the configuration file
+
+### Data Directories
+
+- Notes and attachments: `./data/storage`
+- Configuration files: `./data/config`
+
+### Client Setup
+
+Log in to the web admin panel, click "Copy API Configuration", and paste it into the Obsidian Fast Note Sync plugin settings.
+
+## Links
+
+- GitHub: https://github.com/haierkeys/fast-note-sync-service
+- Obsidian plugin: https://github.com/haierkeys/obsidian-fast-note-sync
+- REST API docs: https://github.com/haierkeys/fast-note-sync-service/blob/master/docs/REST_API.md
@@ -0,0 +1,29 @@
+name: Fast Note Sync Service
+tags:
+  - 实用工具
+  - 云存储
+title: 高性能低延迟的 Obsidian 笔记同步服务
+description: Fast Note Sync Service 是一个基于 Go、WebSocket 和 React 的笔记同步、在线管理与 REST API 服务平台。
+additionalProperties:
+  key: fast-note-sync-service
+  name: Fast Note Sync Service
+  tags:
+    - Tool
+    - Storage
+  shortDescZh: 高性能低延迟的 Obsidian 笔记同步服务
+  shortDescEn: High-performance low-latency note synchronization service for Obsidian.
+  description:
+    zh: Fast Note Sync Service 是一个基于 Go、WebSocket 和 React 的笔记同步、在线管理与 REST API 服务平台，支持 Obsidian 客户端同步、附件同步、历史版本、分享、备份和 MCP 接入。
+    en: Fast Note Sync Service is a Go, WebSocket, and React based platform for note synchronization, online management, and REST APIs, supporting Obsidian client sync, attachments, history, sharing, backups, and MCP integration.
+    zh-Hant: Fast Note Sync Service 是一個基於 Go、WebSocket 和 React 的筆記同步、線上管理與 REST API 服務平台，支援 Obsidian 客戶端同步、附件同步、歷史版本、分享、備份和 MCP 接入。
+  type: website
+  crossVersionUpdate: true
+  limit: 0
+  recommend: 0
+  website: https://github.com/haierkeys/fast-note-sync-service
+  github: https://github.com/haierkeys/fast-note-sync-service
+  document: https://github.com/haierkeys/fast-note-sync-service/blob/master/README.md
+  architectures:
+    - amd64
+    - arm64
+    - arm/v7
@@ -0,0 +1,14 @@
+additionalProperties:
+  formFields:
+    - default: 9000
+      edit: true
+      envKey: PANEL_APP_PORT_HTTP
+      labelEn: Web/API Port
+      labelZh: Web/API 端口
+      required: true
+      rule: paramPort
+      type: number
+      label:
+        en: Web/API Port
+        zh: Web/API 端口
+        zh-Hant: Web/API 連接埠
@@ -0,0 +1 @@
+
@@ -0,0 +1,18 @@
+services:
+  fast-note-sync-service:
+    image: haierkeys/fast-note-sync-service:latest
+    container_name: ${CONTAINER_NAME}
+    restart: always
+    ports:
+      - "${PANEL_APP_PORT_HTTP}:9000"
+    networks:
+      - 1panel-network
+    volumes:
+      - ./data/storage:/fast-note-sync/storage
+      - ./data/config:/fast-note-sync/config
+    labels:
+      createdBy: "Apps"
+
+networks:
+  1panel-network:
+    external: true