+ 
+
+
](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
diff --git a/obsidian-better-sync/data.yml b/obsidian-better-sync/data.yml
new file mode 100644
index 000000000..c5ec31daa
--- /dev/null
+++ b/obsidian-better-sync/data.yml
@@ -0,0 +1,19 @@
+name: Obsidian BetterSync
+tags:
+ - 实用工具
+title: Obsidian 在线同步插件
+description: Obsidian 在线同步插件
+additionalProperties:
+ key: better-sync-service
+ name: Obsidian BetterSync
+ tags:
+ - Tool
+ shortDescZh: Obsidian 在线同步插件
+ shortDescEn: Obsidian BetterSync
+ type: website
+ 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
diff --git a/obsidian-better-sync/latest/data.yml b/obsidian-better-sync/latest/data.yml
new file mode 100644
index 000000000..e55a6a8dd
--- /dev/null
+++ b/obsidian-better-sync/latest/data.yml
@@ -0,0 +1,26 @@
+additionalProperties:
+ formFields:
+ - default: 40166
+ edit: true
+ envKey: PANEL_APP_PORT_HTTP
+ labelEn: HTTP Port
+ labelZh: HTTP端口
+ required: true
+ rule: paramPort
+ type: number
+ - default: 40167
+ edit: true
+ envKey: PRIVATE_HTTP_LISTEN
+ labelEn: private-http-listen
+ labelZh: 性能监控接口
+ required: true
+ rule: paramPort
+ type: number
+ - default: ./data
+ edit: true
+ envKey: DATA_PATH
+ labelEn: Data folder path
+ labelZh: 数据文件夹路径
+ required: true
+ type: text
+
diff --git a/obsidian-better-sync/latest/docker-compose.yml b/obsidian-better-sync/latest/docker-compose.yml
new file mode 100644
index 000000000..b3dc07481
--- /dev/null
+++ b/obsidian-better-sync/latest/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:/better-sync/storage/
+ - ${DATA_PATH}/config:/better-sync/config/
+ image: haierkeys/obsidian-better-sync-service:latest
+ labels:
+ createdBy: "Apps"
+ networks:
+ - 1panel-network
+
+networks:
+ 1panel-network:
+ external: true
+
diff --git a/obsidian-better-sync/logo.png b/obsidian-better-sync/logo.png
new file mode 100644
index 000000000..affa745c4
Binary files /dev/null and b/obsidian-better-sync/logo.png differ