Obsidian Gitの環境を構築する（Windows）

May 27, 2023 12:10 · 1673 words · 4 minute read エディタ

WindowsにObsidian Gitの設定をしました。
久しぶりにGitの初期設定をしたのですが、「えーと、ssh key認証の疎通確認はどうやるんだっけ？」となったので、Gitのインストールと初期設定方法もメモしておきます。

目次

Obsidian Gitプラグインのインストールと有効化

Obsidianの設定からObsidian Gitのプラグインをインストールします。 Obsidian GitはCommunity pluginなので、まずはCommunity plugins を有効にします。

メニューからObsidian Gitを検索し、インストール&有効化したらインストール完了です。

  • Settings > Community plugins > Brows > 「Obsidian Git」で検索 > Install
  • Settings > Community plugins > Obsidian Git　からObsidian Gitを有効化

GitとGitHubの設定

次はWindowsにGitコマンドとGitHubのSSH Key設定をします。

Git for Windowsをインストール

今回はGit for Windowsからインストーラーをダウンロードしてインストールしました。

Git for Windows

基本はインストーラーに従ってインストールすればOKです。 こだわり設定がある人は設定を変更してください。

SSH Keyを作成してGitHubに追加

続いてGitHubにSSH Keyを登録します。 公式ドキュメントに従って、Git for WindowsのGit Bashからコマンドを実行します。

SSH Keyを生成して追加します。複数のSSH Keyを使い分けている場合は、ファイルパスやファイル名を適宜変更します。

$ ssh-keygen -t ed25519 -C "{メールアドレス}"
$ eval "$(ssh-agent -s)"
$ ssh-add ~/.ssh/id_ed25519

GitHub アカウントへの新しい SSH キーの追加 - GitHub Docs

SSH公開鍵をクリップボードにコピーし、GitHubの「SSH キーと GPG キー」に貼り付けたら設定完了。

$ clip < ~/.ssh/id_ed25519.pub

SSH 接続をテストする - GitHub Docs

疎通テストをします。

$ ssh -T git@github.com
Hi kapiecii! You've successfully authenticated, but GitHub does not provide shell access.

Git Configにユーザとメールアドレスを設定

Gitコマンドにメールアドレスとユーザー名を設定します。 GitHubではnoreplyのメールアドレスを提供してくれているので、今回はこれを使いました。

$ git config --global user.email "｛mail address｝@users.noreply.github.com" 
$ git config --global user.name "kapiecii"

GitHubにRepositoryを作成してpush

今回は既にObsidian Vaultのフォルダがローカルにあるので、このフォルダをGitHubにPushしました。

$ git init
$ git remote add origin git@github.com:kapiecii/{Repository name}.git
$ git branch -M main
$ touch .gitignore
$ git status
$ git add .
$ git commit -m "init"
$ git push -u origin main

Obsidian Gitの設定

最後にObsidian Gitの設定です。 今回は下記の設定にしました。今後継続利用する中で調整するかもしれません。

  • 10分ごとにCommit
  • 30分ごとにPush
  • 起動時にPull

手動でcommitやpushをする場合

手動でcommitやpushをしたい場合、Obsidianのコマンドパレットから操作します。
「ctrl + p」もしくは 「cmd + p」でコマンドパレットを起動し、「commit」「push」などを入力するとメニューが表示されます。

気になるところ

ObsidianのデータをGitHubに自動でバックアップできるので、安心感が増しました。しかし気になるところも。
私はObsidianをほぼ毎日利用するので、Obsidian GitによってGitHubの草が増えることになります。 ブログラムを書いていない日でも草が生えていくことに少し違和感があります。 元々それほど草を重要視しているわけでもないので、そのうち慣れるのかもしれませんが。

tweet Share