【Visual Studio Code】「拡張機能」 Remote – SSHでリモートサーバーのファイルを編集する

はじめに

こちらの記事で紹介したVisual Studio Codeの深堀りです。

Virtual Studio Code(VS Code)は、Microsoftが提供する人気の高いコードエディターです。VS Codeには様々な拡張機能があり、その中でも「Remote – SSH」は開発者にとって非常に便利な機能です。

本記事では、Remote – SSH拡張機能の概要と導入方法、リモートサーバーでのファイル編集・デバッグの方法、よくあるトラブルと解決方法について解説します。リモートサーバー内のファイルを直接編集して開発したい方は、ぜひ参考にしてください。

Oracle VM VirtualBoxを使用して、Windows端末上に開発用Linuxサーバーを建てて作業するので、開発用Linuxサーバーのファイルを直接編集できるRemote – SSHは必須です。

※ Oracle VM VirtualBoxを用いて、Linux環境を構築する記事も書きますね

Remote – SSH拡張機能の導入は簡単です。VS Codeのエクステンションマーケットプレイスから
「Remote – SSH」を検索し、インストールしましょう。

インストール後は、VS Code左下のリモート接続アイコンをクリックして、SSHの歯車マークをクリック後に.ssh配下のconfigファイルを選択します。（大体候補の一番上に出てくる）

configファイルは以下のように設定します。

Host <好きな名前>
    HostName <IPアドレス>
    IdentityFile <秘密鍵ファイルのフルパス> ※ 公開鍵認証の場合
    User <ユーザー名>

Remote – SSH拡張機能は、VS CodeとリモートサーバーをSSH接続することで、ローカル環境と同じように開発できるようにしてくれます。

余談ですが、cmdなどのターミナルからsshコマンドで繋げる場合は以下のコマンドですね！

ssh -p <ポート番号> <ユーザー名>@<IPアドレス>

話を戻しますが、Remote – SSH拡張機能では、リモートサーバー上に.vscode-serverというディレクトリが作られて、その中にいろんな機能を持ったファイルが作られてそれが動くことで機能を実現しているみたいです。

サーバーのリソースを消費すること、空いてるポートを勝手に使うことは気をつけた方が良いみたいですね。

Remote – SSHを使ったリモート開発の流れは以下の通りです。

リモートサーバー上のファイルを直接編集できるため、ローカル環境とリモート環境の同期を気にする必要がなくなります。デバッグ時にリモートサーバーの実行環境を活用できるのも大きなメリットです。

Remote – SSHを使う上で考えられるトラブルと解決方法は以下の通りです。

SSHキーの認証に失敗する
- 公開鍵認証の設定が正しく行われているか確認する
- SSHクライアントの設定を確認する
リモートサーバーに接続できない
- ファイアウォールの設定を確認する
- SSHポートが開放されているか確認する
rootユーザーでリモートログインが許可されていない
- リモートサーバー上の/etc/ssh/sshd_configのPermitRootLoging yesに設定する
よく分からないがRemote – SSHのゾンビプロセスが生きていてうまく接続できない
- setting.jsonの"remote.SSH.useExecServer": falseにする
- リモートサーバーにインストールされた.vscode-serverを一度削除する