Obsidian Local Backup 使用教程

1. 项目介绍

Obsidian Local Backup 是一个开源项目，旨在为使用 Obsidian（一款强大的知识库应用）的用户提供本地备份功能。该工具能够帮助你定期备份你的Obsidian库，以防止数据丢失。

2. 项目快速启动

环境准备

• 确保你的系统中安装了 Node.js（推荐版本14.x或16.x）。
• 克隆项目到本地：

git clone https://github.com/cgcel/obsidian-local-backup.git
cd obsidian-local-backup

安装依赖

在项目根目录下执行以下命令安装依赖：

npm install

配置文件

复制 .env.example 文件为 .env 并根据你的需求修改配置：

cp .env.example .env

在 .env 文件中，你需要设置以下配置项：

OBSIDIAN_PATH=你的Obsidian库路径
BACKUP_PATH=你的备份存储路径

启动脚本

运行以下命令启动备份脚本：

node backup.js

3. 应用案例和最佳实践

定期备份

你可以使用 cron 任务来定期执行备份脚本。例如，每天凌晨1点自动执行备份：

0 1 * * * /usr/bin/node /path/to/obsidian-local-backup/backup.js

备份后处理

备份完成后，你可能需要对备份文件进行额外的处理，例如上传到云存储服务。这可以通过编写额外的脚本来实现。

4. 典型生态项目

• Obsidian Publish：将你的Obsidian库发布到网上，便于分享。
• Obsidian CLI：命令行工具，用于自动化处理Obsidian库中的各种任务。
• Obsidian Statistics：为你的Obsidian库提供详细统计信息。