SSHでサーバにリモート接続する（Remote - SSH）

Visual Studio Codeの拡張機能である「Remote - SSH」を使ってサーバにSSH接続できることを知ったので、実際に使ってみました。

結論から言うとかなり使えるので、これまでは「Tera Term」や「WinSCP」を使っていましたが、これからは「VSCode」に置き換えようと思います。

以下、Remote-SSHの設定、操作の手順になります。

VSCodeを起動したら拡張機能から「Remote - SSH」を検索してインストールします。

「Remote - SSH」はMicrosoft提供の拡張機能になります。

インストールが終わったら、左側のメニューから「リモートエクスプローラー」を選択して、プルダウンで「SSH Targets」を選択します。

表示された「SSH Targets」横の歯車アイコンをクリックすると、

接続先の設定ファイルを保存するパスの一覧が表示されるので、保存する場所を指定します。（保存場所を変更したい場合は「Settings」を選択）

保存場所を選択すると「config」ファイルが作成されるので、ここに接続先の情報を追記します。（複数記述することも可能）

リモート接続するには、追加した接続先の右横にあるウィンドウアイコンを選択します。

新しいウィンドウが表示されたら、接続先のプラットフォーム（Linux / Windows / macOS）を選択します。（ここではLinuxを選択）

正常に接続されると左下に「SSH: 接続先」が表示されます。

なお、Windowsの場合、秘密鍵のファイルが誰でもアクセスできる場所に配置されているとエラー（It is required that your private key files are NOT accessible by others.）が発生して、リモート接続に失敗します。

Permissions for 'C:\\ssh\\test.pem' are too open.
It is required that your private key files are NOT accessible by others.        
This private key will be ignored.
Load key "C:\\ssh\\test.pem": bad permissions

秘密鍵のファイルをユーザー配下のフォルダに配置すると、上記のエラーは出なくなります。

リモート接続が成功した後、メニューから「フォルダーを開く」を選択すると、接続先のサーバのディレクトリを指定することができます。

フォルダを選択すると、配下のファイルやディレクトリがエクスプローラーに表示されます。

VSCodeでSSH接続する際の真骨頂はここからで、ファイルの追加や編集、それに削除といった操作がエディタ上で可能となっていて、リモート先の環境をまるでローカルの環境と同様に操作することができます。

ローカルPCのファイルをリモート接続したサーバに配置する際には、ドラッグ＆ドロップも可能です。

逆にVSCode上のファイルをローカルPCに落とす場合は、右クリックからダウンロードを選択することで可能です。

もちろん、ターミナルからコマンドを実行することも可能となっています。

VSCodeの「Remote-SSH」を本番環境に対して使用するのは、使い勝手が良すぎて逆に不安になりますが、開発環境やステージングなどであれば、これで十分だと思います。