コンテンツにスキップ

Obsidian Vault 同期セットアップガイド

MyLabリポジトリのドキュメント・ログをObsidianで閲覧・編集するためのセットアップ手順。

アーキテクチャ

MyLab (メインリポジトリ)
  ├── docs/        ──┐
  ├── logs/        ──┤  sync_to_vault.py
  ├── .obsidian/   ──┤  (GitHub Actions or ローカル実行)
  └── README.md    ──┘
KZ55230/obsidian-vault (Vault用リポジトリ)
  ├── docs/           ← MyLabから同期
  ├── logs/           ← MyLabから同期
  ├── .obsidian/      ← Obsidian設定
  └── MyLab-README.md ← MyLabのREADME
Obsidian (ローカル)
  └── Obsidian Git プラグインで自動pull

1. Vault用リポジトリの作成

GitHub上で新しいリポジトリを作成:

# GitHubで KZ55230/obsidian-vault を作成(Private推奨)
# https://github.com/new

# ローカルにクローン
git clone https://github.com/KZ55230/obsidian-vault.git
cd obsidian-vault
echo "# Obsidian Vault" > README.md
git add README.md
git commit -m "initial commit"
git push -u origin main

2. GitHub Actions の設定(自動同期)

Personal Access Token の作成

  1. GitHub → Settings → Developer settings → Personal access tokens → Fine-grained tokens
  2. 「Generate new token」をクリック
  3. 設定:
  4. Token name: vault-sync
  5. Expiration: 90 days(またはNo expiration)
  6. Repository access: KZ55230/obsidian-vault のみ
  7. Permissions:
    • Contents: Read and Write
  8. トークンを生成してコピー

Secretの登録

  1. MyLabリポジトリ → Settings → Secrets and variables → Actions
  2. 「New repository secret」をクリック
  3. 設定:
  4. Name: VAULT_SYNC_PAT
  5. Value: 上で生成したトークン

これで docs/logs/.obsidian/ に変更がpushされると自動的にvaultリポジトリに同期されます。

3. ローカルでの手動同期

# MyLabリポジトリのルートから実行
python scripts/sync_to_vault.py --vault-repo /path/to/obsidian-vault

# ドライラン(変更内容の確認のみ)
python scripts/sync_to_vault.py --vault-repo /path/to/obsidian-vault --dry-run

# コミットのみ(プッシュしない)
python scripts/sync_to_vault.py --vault-repo /path/to/obsidian-vault --no-push

Windows環境の例

python scripts/sync_to_vault.py --vault-repo "D:\Kazuma_Teramachi\obsidian-vault"

4. Obsidian側のセットアップ

Obsidian Git プラグインのインストール

  1. Obsidianを開く
  2. Settings → Community Plugins → Browse
  3. 「Obsidian Git」を検索してインストール
  4. プラグインを有効化

Vault を開く

  1. vaultリポジトリをローカルにクローン:
    git clone https://github.com/KZ55230/obsidian-vault.git "D:\Kazuma_Teramachi\obsidian-vault"
    
  2. Obsidian → 「Open folder as vault」→ クローンしたディレクトリを選択

Obsidian Git プラグイン設定

Settings → Obsidian Git:

設定項目 推奨値 説明
Auto pull interval 5 5分ごとに自動pull
Auto push interval 0 手動pushのみ(読み取り専用の場合)
Pull on startup ON 起動時にpull

5. 同期対象

ソース (MyLab) 同期先 (Vault) 内容
docs/ docs/ ドキュメント、図面、ガイド
logs/ logs/ 会話ログ
.obsidian/ .obsidian/ Obsidian設定
README.md MyLab-README.md プロジェクト概要

除外されるファイル

  • __pycache__/
  • *.pyc
  • .DS_Store
  • Thumbs.db

トラブルシューティング

GitHub Actionsが動かない

  • VAULT_SYNC_PAT シークレットが正しく設定されているか確認
  • トークンの有効期限が切れていないか確認
  • トークンにobsidian-vaultリポジトリへのContents書き込み権限があるか確認

Obsidian Gitでpullが失敗する

  • リポジトリのURLとクレデンシャルが正しいか確認
  • Gitがインストールされているか確認
  • .gitconfig にユーザー名とメールが設定されているか確認