Configuring Your SFTP Extension Server Settings ✅ - asankoh/Technical_Writing_Examples GitHub Wiki

Table of Contents

  1. What is a SFTP Server
  2. Configuring Your SFTP Server
  3. Conclusion

What is an SFTP Server

An SFTP Server is a file transfer protocol that allows users to securely access, transfer and manage files over a network. The SFTP extension in VS Code offers multiple benefits as it can enhance your overall development workflow by creating a secure way to synchronize code, edit files on remote servers and encrypt file transfers, ensuring protection from interception.

After reading this document, you will be able to configure the SFTP Extension server in VS Code, allowing yourself to efficiently enhance your functionality in development.

Prerequisites

In order to accomplish this procedure you must have the following:

  • A stable internet connection
  • Visual Studio Code Installed

Configuring Your SFTP Server

⚠️NOTE: Make sure you are in the main folder and not a sub folder before starting this process.

  1. Open the ** Extensions Tab** in VS Code and Type "SFTP" in the Search Bar.
  2. Download the following extension shown in the picture. (created by Natizyskunk)
Figure 1: Natizyskunk SFTP Extension

VSCode Image SFTP

  1. Exit out the Extension Tab & Press Command+Shift+P (Mac) or Ctrl+Shift+P (Windows/Linux) to open the option menu at the top.
  2. Type in SFTP and you should see the following option: ** SFTP: Config**. Select that Option.
Figure 2: SFTP: Config Option

VSCode Image SFTP 2

  1. Once you select the SFTP: Config option, you will see a new folder in your folder system: .vscode containing a sftp.json file. You will modify this file in the following ways:
Figure 3: Default SFTP.json File

VSCode Image SFTP 4

  • Name: Input whatever name you want for your server connection

  • Host: The hostname or IP address of your SFTP server (e.g. : localhost)

  • Protocol: Keep as "SFTP" unless prompted otherwise

  • Port: 22 for SFTP Port Number

  • Username: Input your username for the SFTP server

  • Password: Enter your password here(optional unless prompted otherwise) ⚠️ Note: Passwords are not recommended. Consider using SSH key authentication for better security. If password is needed do the following:

  • After the comma at the end of the username line, hit return and add the following field.

  • RemotePath: Input the path on the remote server where your project files will be synced.

  • The rest of the options will stay the same.

  1. Save your file.

Example: SFTP Configuration for Indiana University Accounts:

{ 
"name": "Web Class Server", 
"host": "in-info-web4.informatics.iui.edu",
"protocol": "sftp", 
"port": 22, 
"username": "IU_Username", "password": "IU_Password", 
"remotePath": "/home/IU_Username/public_html", 
"uploadOnSave": false, 
"useTempFile": false, 
"openSsh": false, 
"ignore": [".vscode", "node_modules", ".git", "package.json", "package-lock.json"] 
}
Figure 4: IU Indianapolis SFTP Configuration Example

VSCode Image SFTP 3

Conclusion

By following the steps provided in this document, you have successfully installed the SFTP Extension in VS Code and configured a secure server connection. With this extension applied, it will allow you to securely transfer files and work directly on remote servers, allowing you to enhance your web development workflow.

If you need additional configuration options, refer to the official SFTP extension documentation.

⚠️ **GitHub.com Fallback** ⚠️