obsidian-plugin/sotashimozono_obsidian-remote-ssh

mirror of https://github.com/sotashimozono/obsidian-remote-ssh.git synced 2026-07-22 17:10:32 +00:00

Souta d4f8b5e982 docs(seo): extend description frontmatter to 34 more pages

Beta.0 covered the top 15 entry pages. This beta covers another 34
medium- and high-traffic pages so SERP snippets stop falling back to
auto-extracted lead text on the rest of the doc tree:

  Cookbook (the rest beyond beta.0):
    - host-migration, hardware-key, reverse-proxy, multi-vault,
      ssh-keygen, systemd-managed-daemon, cookbook/index

  User guide:
    - host-keys, jump-host, ssh-config, conflicts, plugin-compatibility

  Operations:
    - reconnect, upgrading, uninstalling, performance-tuning

  Configuration:
    - profiles, this-device

  Server:
    - firewall, multi-user, server/overview

  API / reference / security / privacy:
    - api/overview, security/host-keys, privacy, reference/daemon-cli

  JA twins for beta.0's EN pages (parity coverage):
    - comparison, faq, getting-started/{install,quickstart,first-connect}
    - operations/troubleshooting, cookbook/raspberry-pi-vault
    - migration/from-obsidian-sync, security/model

`docs/en/user-guide/plugin-compatibility.md` previously had no
frontmatter at all — the H1 was its de-facto title. Adding minimal
frontmatter (title matches the H1 verbatim, plus tags + description).
Slug and rendered title unchanged.

The remaining ~30 EN-only pages (sub-section landings, deep API
reference, contributing guide) keep Quartz's auto-extracted
descriptions for now — they're navigational/internal pages where
SERP-snippet quality matters less. We can extend further once
Search Console data shows specific pages getting impressions but
poor click-through.

2026-05-11 00:22:51 +09:00

4 KiB

Raw Permalink Blame History

title

lang

5 分間 Quickstart

「プラグインインストール済み」から「リモート vault 上のファイルを編集している」までを 5 分で完走するページです。前提条件:

obsidian-remote-ssh がインストール済み（ja/getting-started/install 参照）
公開鍵が ~/.ssh/authorized_keys に登録された SSH 到達可能な Linux/macOS ホスト
そのホスト上の vault 用ディレクトリ（空でも OK）

これらがまだ揃っていない場合は、en/server/docker（英語）でサンドボックスをワンコマンド構築できます。

1. プラグイン設定を開く

Settings → Community plugins → Obsidian Remote SSH → ⚙️。

2. SSH プロファイルを追加

Add profile をクリックして以下を入力:

項目	例	備考
Profile name	`My Pi`	表示名のみ
Host	`192.168.1.50` または `pi.local`	`ssh` コマンドが受け付ける形式なら何でも
Port	`22`	デフォルト 22
Username	`pi`	リモートユーザ名
Authentication	`Private key`	en/configuration/profiles#authentication (英語)
Private key path	`~/.ssh/id_ed25519`	ランタイムでチルダ展開されます
Remote vault path	`/home/pi/notes` または `~/notes`	リモート上に存在している必要あり
Mode	`Daemon (deploys helper on connect)`	工場出荷時 `SFTP (direct)` から切り替え。低レイテンシ + push 通知が得られます。署名済みサーババイナリを自動デプロイ

Save をクリック。

3. 接続

以下のいずれかで:

コマンドパレット（⌘P / Ctrl+P）→ "Remote SSH: Connect" → プロファイルを選択
リボンの Remote SSH アイコン → メニューからプロファイルを選択

裏で起こること:

プラグインが既存の鍵 / agent で SSH 接続を開く
プラグインが デーモンバイナリをアップロード (~/.obsidian-remote/server、約 5 MB)、SHA256 を検証
プラグインがリモートユーザ権限で デーモンを起動。デーモンは Unix socket を listen し、プラグインがそれを SSH トンネル経由で逆方向に転送
プラグインが 新しい "shadow vault" ウィンドウを開く — リモートファイルをデーモン経由で読み書きする

初回接続は約 5–8 秒（バイナリアップロード）。2 回目以降は起動中のデーモンを再利用して約 1 秒で完了します。

4. 動作確認

新しいウィンドウで:

ファイルを作成 → リモートで ls して存在を確認
リモートでファイルを編集（echo hello >> README.md）→ Obsidian 上に約 500 ms 以内で反映されるのを確認

5. 切断

コマンドパレット → "Remote SSH: Disconnect" — または shadow vault ウィンドウを閉じるだけでも OK。デーモンは切断後も約 5 分間稼働を続ける（設定可能）ため、すぐ再接続すれば瞬時です。

動かなかった場合

認証失敗: 秘密鍵パス / SSH agent を確認。プラグインは独自の認証情報ストアではなく既存の SSH 設定を使います
デーモンが起動しない: 設定のデーモンパネル（⚙️ → Daemon）→ "View log"
ファイルが現れない: リモート vault パスが存在することを確認。デーモンは自動作成しません（保護的設計 — ja/operations/troubleshooting 参照）

続き: ja/getting-started/first-connect。

4 KiB Raw Permalink Blame History Unescape Escape