From f8e0bdc4ead1bff037ae151532ab294b750a90aa Mon Sep 17 00:00:00 2001 From: pooneyy <85266337+pooneyy@users.noreply.github.com> Date: Tue, 16 Dec 2025 14:44:03 +0800 Subject: [PATCH] =?UTF-8?q?=E2=9C=A8=20feat(app):=20upgrade=20obsidian-bet?= =?UTF-8?q?ter-sync=20to=20fast-note-sync-service?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - update docker-compose files to use new image name (haierkeys/fast-note-sync-service) and version (0.11.2/latest) - update internal volume mount paths from `/better-sync/` to `/fast-note-sync/` - remove quotes from port environment variable bindings for consistency - completely rewrite README.md with new product introduction and feature list - update data.yml with new application name, key, and repository URLs - rename service from 'Obsidian BetterSync' to 'Fast Note Sync Service' across all metadata --- .../{0.6.0 => 0.11.2}/data.yml | 0 .../0.11.2/docker-compose.yml | 20 +++ .../0.6.0/docker-compose.yml | 20 --- apps/obsidian-better-sync/README.md | 146 ++---------------- apps/obsidian-better-sync/data.yml | 12 +- .../latest/docker-compose.yml | 10 +- 6 files changed, 42 insertions(+), 166 deletions(-) rename apps/obsidian-better-sync/{0.6.0 => 0.11.2}/data.yml (100%) create mode 100644 apps/obsidian-better-sync/0.11.2/docker-compose.yml delete mode 100644 apps/obsidian-better-sync/0.6.0/docker-compose.yml diff --git a/apps/obsidian-better-sync/0.6.0/data.yml b/apps/obsidian-better-sync/0.11.2/data.yml similarity index 100% rename from apps/obsidian-better-sync/0.6.0/data.yml rename to apps/obsidian-better-sync/0.11.2/data.yml diff --git a/apps/obsidian-better-sync/0.11.2/docker-compose.yml b/apps/obsidian-better-sync/0.11.2/docker-compose.yml new file mode 100644 index 000000000..afe808e15 --- /dev/null +++ b/apps/obsidian-better-sync/0.11.2/docker-compose.yml @@ -0,0 +1,20 @@ +services: + better-sync: + container_name: ${CONTAINER_NAME} + restart: always + ports: + - ${PANEL_APP_PORT_HTTP}:9000 + - ${PRIVATE_HTTP_LISTEN}:9001 + volumes: + - ${DATA_PATH}/storage:/fast-note-sync/storage + - ${DATA_PATH}/config:/fast-note-sync/config + image: haierkeys/fast-note-sync-service:0.11.2 + labels: + createdBy: "Apps" + networks: + - 1panel-network + +networks: + 1panel-network: + external: true + diff --git a/apps/obsidian-better-sync/0.6.0/docker-compose.yml b/apps/obsidian-better-sync/0.6.0/docker-compose.yml deleted file mode 100644 index f96450745..000000000 --- a/apps/obsidian-better-sync/0.6.0/docker-compose.yml +++ /dev/null @@ -1,20 +0,0 @@ -services: - better-sync: - container_name: ${CONTAINER_NAME} - restart: always - ports: - - "${PANEL_APP_PORT_HTTP}:9000" - - "${PRIVATE_HTTP_LISTEN}:9001" - volumes: - - ${DATA_PATH}/storage:/better-sync/storage/ - - ${DATA_PATH}/config:/better-sync/config/ - image: haierkeys/obsidian-better-sync-service:0.6.0 - labels: - createdBy: "Apps" - networks: - - 1panel-network - -networks: - 1panel-network: - external: true - diff --git a/apps/obsidian-better-sync/README.md b/apps/obsidian-better-sync/README.md index 786215695..7354b6c3a 100644 --- a/apps/obsidian-better-sync/README.md +++ b/apps/obsidian-better-sync/README.md @@ -1,139 +1,15 @@ -[中文文档](readme-zh.md) / [English Document](README.md) +## 产品介绍 -# Better Sync Service +高性能、低延迟的笔记同步服务解决方案 -

- version - license -

+原 Better Sync Service -[BetterSync For Obsidian](https://github.com/haierkeys/obsidian-better-sync) 服务端,基于 Golang + Websocket -构建的高性能笔记实时同步服务 +## 主要功能 -## 功能清单 - -- [x] 多端笔记实时同步 -- [ ] 笔记云存储同步备份 - s3 -- [ ] 笔记云存储同步备份 - 阿里云 -- [ ] 笔记云存储同步备份 - CF R2 -- [ ] 笔记云存储同步备份 - minio -- [ ] 笔记云存储同步备份 - webdav -- [ ] 笔记云存储同步备份 - 增加备份策略 -- [x] Web页面管理 -- [x] 目前仅支持 Sqlite 存储 -- [ ] 增加git维护版本 -- [ ] 基于 google-diff-match-patch 算法优化 - -## BUGLIST (已知问题) - -- webgui 除了登录/注册/复制配置之外的 界面无实际功能或点击异常 -- 部分用户连接ws后, 认证成功,但是不显示nickname - -## 更新日志 - -查看完整的更新内容，请访问 [Changelog](https://github.com/haierkeys/obsidian-better-sync-service/releases)。 - -## 价格 - -本软件是开源且免费的。如果您想表示感谢或帮助支持继续开发，可以通过以下方式为我提供支持： - -[BuyMeACoffee](https://ko-fi.com/haierkeys) - -## 私有部署 - -- 目录设置 - - ```bash - # 创建项目所需的目录 - mkdir -p /data/better-sync - cd /data/better-sync - - mkdir -p ./config && mkdir -p ./storage/logs && mkdir -p ./storage/uploads - ``` - - 首次启动如果不下载配置文件,程序会自动生成一个默认配置到 **config/config.yaml** - - 如果你想从网络下载一个默认配置 使用以下命令来下载 - - ```bash - # 从开源库下载默认配置文件到配置目录 - wget -P ./config/ https://raw.githubusercontent.com/haierkeys/obsidian-better-sync-service/main/config/config.yaml - ``` - -- 二进制安装 - - 从 [Releases](https://github.com/haierkeys/obsidian-better-sync-service/releases) 下载最新版本，解压后执行： - - ```bash - ./better-sync-service run -c config/config.yaml - ``` - - -- 容器化安装（Docker 方式） - - Docker 命令: - - ```bash - # 拉取最新的容器镜像 - docker pull haierkeys/obsidian-better-sync-service:latest - - # 创建并启动容器 - docker run -tid --name better-sync-service \ - -p 9000:9000 -p 9001:9001 \ - -v /data/better-sync/storage/:/better-sync/storage/ \ - -v /data/better-sync/config/:/better-sync/config/ \ - haierkeys/obsidian-better-sync-service:latest - ``` - - Docker Compose - 使用 *containrrr/watchtower* 来监听镜像实现自动更新项目 - **docker-compose.yaml** 内容如下 - - ```yaml - # docker-compose.yaml - services: - better-sync: - image: haierkeys/obsidian-better-sync-service:latest # 你的应用镜像 - container_name: better-sync - ports: - - "9000:9000" # 映射端口 9000 - - "9001:9001" # 映射端口 9001 - volumes: - - /data/better-sync/storage/:/better-sync/storage/ # 映射存储目录 - - /data/better-sync/config/:/better-sync/config/ # 映射配置目录 - - ``` - - 执行 **docker compose** - - 以服务方式注册 docker 容器 - - ```bash - docker compose up -d - ``` - - 注销并销毁 docker 容器 - - ```bash - docker compose down - ``` - -### 使用 - -访问 `WebGUI` 地址 `http://{IP:PORT}` - -点击在 复制 API 配置 获取配置信息, 到 `BetterSync For Obsidian` 插件中粘贴即可 - -首次访问需要进行用户注册,如需关闭注册, 请修改 `user.register-is-enable` 为 `false` - -### 配置说明 - -默认的配置文件名为 **config.yaml**，请将其放置在 **根目录** 或 **config** 目录下。 - -更多配置详情请参考： - -- [config/config.yaml](config/config.yaml) - -## 其他资源 - -- [Better Sync For Obsidian](https://github.com/haierkeys/obsidian-better-sync) \ No newline at end of file +- Web 管理面板: 内置现代化管理界面，轻松创建用户、生成插件配置、管理仓库及笔记内容。 +- 多端实时同步: + - 支持 Vault (仓库) 自动创建。 + - 支持笔记管理（增、删、改、查），变更毫秒级实时分发至所有在线设备。 +- 附件同步支持: + - 完美支持图片等非笔记文件同步。 + - (注: 需服务端 v0.9+ 及 Obsidian 插件端 v1.0+ , 不支持 Obsidian 设置文件) \ No newline at end of file diff --git a/apps/obsidian-better-sync/data.yml b/apps/obsidian-better-sync/data.yml index 0bb92e5e5..07dfd1ce5 100644 --- a/apps/obsidian-better-sync/data.yml +++ b/apps/obsidian-better-sync/data.yml @@ -1,11 +1,11 @@ -name: Obsidian BetterSync +name: Fast Note Sync Service tags: - 实用工具 title: Obsidian 在线同步插件 description: Obsidian 在线同步插件 additionalProperties: - key: better-sync-service - name: Obsidian BetterSync + key: fast-note-sync-service + name: Fast Note Sync Service tags: - Tool shortDescZh: Obsidian 在线同步插件 @@ -17,6 +17,6 @@ additionalProperties: crossVersionUpdate: true limit: 0 recommend: 0 - website: https://github.com/haierkeys/obsidian-better-sync-service - github: https://github.com/haierkeys/obsidian-better-sync-service - document: https://github.com/haierkeys/obsidian-better-sync-service/blob/master/readme-zh.md + 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/docs/README.zh-CN.md diff --git a/apps/obsidian-better-sync/latest/docker-compose.yml b/apps/obsidian-better-sync/latest/docker-compose.yml index 306f24f38..39a153123 100644 --- a/apps/obsidian-better-sync/latest/docker-compose.yml +++ b/apps/obsidian-better-sync/latest/docker-compose.yml @@ -3,12 +3,12 @@ services: container_name: ${CONTAINER_NAME} restart: always ports: - - "${PANEL_APP_PORT_HTTP}:9000" - - "${PRIVATE_HTTP_LISTEN}:9001" + - ${PANEL_APP_PORT_HTTP}:9000 + - ${PRIVATE_HTTP_LISTEN}:9001 volumes: - - ${DATA_PATH}/storage:/better-sync/storage/ - - ${DATA_PATH}/config:/better-sync/config/ - image: haierkeys/obsidian-better-sync-service:latest + - ${DATA_PATH}/storage:/fast-note-sync/storage + - ${DATA_PATH}/config:/fast-note-sync/config + image: haierkeys/fast-note-sync-service:latest pull_policy: always labels: createdBy: "Apps"