Zenn
🔥

新しいssh接続先を追加する際のセットアップ(Windows)

2023/08/30に公開
SSH
Windows Terminal
tech

新しいssh接続先を追加する際のセットアップ方法についてまとめる(ほぼ自分用)
設定するのは以下

  • ssh設定ファイルへの追記
  • Windows Terminalの設定ファイルへの追記
  • Windows Terminalでのssh接続先起動用のbatファイルの作成

ssh設定ファイルへの追記

~/.ssh/configに新しい接続先の情報を記載する。
Windowsの場合は%USERPROFILE%\.ssh\configを編集する。
なお、設定ファイルは以下の手順でvs codeからでも開くことが可能。

  1. 拡張機能のリモートエクスプローラーを開く
  2. SSHと記載の行の右側の設定アイコン(歯車アイコン)をクリック
  3. 更新するSSH構成ファイルを選択する画面で対象の設定ファイルをクリック
    ※デフォルトでフォーカスしているC:\Users\[ユーザー名]\.ssh\configを選択すればよい
~/.ssh/config
Host [リモートホスト名のエイリアス]
    User [リモートホストのユーザー名]
    HostName [リモートホストのIPアドレス or ホスト名(名前解決可能な場合)]
    IdentityFile ~/.ssh/[秘密鍵ファイル名]
    IdentitiesOnly yes
    Port [ssh用のポート番号]
  • Hostは適当な文字列を記述、呼び出しやすいように短い文字列を推奨。
  • IdentityFile, IdentitiesOnlyは鍵認証を設定している場合は追加
    Windowsでも~/.ssh/の形式パスを記述しても読み取る仕様
  • Portは設定していない場合デフォルトの22が使用される。

Windows Terminalの設定ファイルへの追記

次にWindows Terminalの設定ファイルに新しい接続先の情報を記載する。
Windows Terminalの設定ファイル(settings.json)は以下の手順で開くことができる。

  1. Windows Terminalを起動
  2. ctrl + ,で設定を開く
  3. 画面右下のJSON設定ファイルを開くをクリック

settings.jsonのprofilesに接続情報を追加

settings.json
{
    "name": "[プロファイル名として表示したい文字列]",
    "colorScheme": "Campbell",
    "commandline": "C:\\Windows\\System32\\OpenSSH\\ssh.exe [~/.ssh/configに記載のホスト名]",
    "font": {
        "face": "Cascadia Code PL",
        "size": 9.0
    },
    "guid": "[PowershellやDevToysで作成したUUIDをコピペ]",
    "icon": "ms-appx:///ProfileIcons/{9acb9455-ca41-5af7-950f-6bca1bc9722f}.png"
}
  • name: プロファイル名として表示したい文字列
    ssh設定ファイルに記載のホスト名と同じにすることを推奨。
    参照しているわけではないので別名でも問題ない。
  • colorScheme: 設定ファイルのschemesに記載されているテーマ名を記述
  • commandline: sshのコマンドを記述。
    前項で追記したsshファイルのホスト名を記述。
  • font: デフォルトではインストールされていないのでこちらからフォントをダウンロードし、ttfフォルダ配下のCascadiaCodePL.ttfをダブルクリックで実行しインストール。
  • guid: PowershellではNew-GuidコマンドでDevToysではUUID生成ツールを使って生成することができる。
  • icon: Tuxアイコンを参照
    以下を参考に他のアイコンも指定することも可能。

colorShemeについて

デフォルトで所謂Monokaiテーマがないので以下を新たに追加。
※といってもCampbellテーマのbackgroundを#272822に変更しただけ。

{
    "background": "#272822",
    "black": "#0C0C0C",
    "blue": "#0037DA",
    "brightBlack": "#767676",
    "brightBlue": "#3B78FF",
    "brightCyan": "#61D6D6",
    "brightGreen": "#16C60C",
    "brightPurple": "#B4009E",
    "brightRed": "#E74856",
    "brightWhite": "#F2F2F2",
    "brightYellow": "#F9F1A5",
    "cursorColor": "#FFFFFF",
    "cyan": "#3A96DD",
    "foreground": "#FFFFFF",
    "green": "#13A10E",
    "name": "Monokai",
    "purple": "#881798",
    "red": "#C50F1F",
    "selectionBackground": "#FFFFFF",
    "white": "#CCCCCC",
    "yellow": "#C19C00"
}

batファイルの作成

Win + Rのファイル名を指定して実行からすぐに呼び出すためにbatを作成。
batはパスが通っている場所に格納しておく。

@echo off
wt -p "[Windows Terminalで設定したプロファイル名]"

reference

Discussion