Skip to content

Remote File Sync Documentation: Comprehensive guide and documentation for the Remote File Sync extension, a powerful tool for synchronizing files between local and remote servers directly within Visual Studio Code. Includes setup instructions, usage examples, troubleshooting tips, and more.

License

Notifications You must be signed in to change notification settings

katorymnd/remote-file-sync-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 

Repository files navigation

Remote File Sync

Remote File Sync Banner

Welcome to the "Remote File Sync" extension for Visual Studio Code. This extension provides seamless file synchronization between your local workspace and remote servers, leveraging FTP, SFTP, SSH, WebDAV, and Google Drive connections.

Features

  • Remote File Synchronization: Effortlessly sync files between your local workspace and remote servers.

  • Multiple Protocol Support: Compatible with FTP, SFTP, SSH, WebDAV, and Google Drive.
    Multiple Protocol Support

  • Connection Pooling: Manage multiple connections efficiently without compromising performance.

  • Remote File Tree View: Navigate remote directories and files without local cloning.

  • Sync Panel: Real-time monitoring and management of file synchronization.

    Remote File Tree View

Tip: Use the Transfer Status to view updates on file synchronization dynamically.

Requirements

Before using this extension, ensure you have:

  • VS Code: Version 1.85.0 or newer.
  • Supported Protocols: Confirm support for FTP, SFTP, SSH, WebDAV, or Google Drive API on your remote servers.

Extension Settings

This extension contributes the following settings:

  • remotefilesync.openSyncPanel: Opens the synchronization panel.
  • remotefilesync.transferStatus: Displays the transfer status.

Known Issues

  • Large File Handling: Syncing very large files (>1GB) might impact performance. These files may also take longer to open.
  • Google Drive API Limits: Be mindful of API rate limits when syncing a large number of files with Google Drive.

Unsupported Files

Certain file types are not supported for synchronization, including:

Executable Files:

  • .exe, .dll, .so

Image Files:

  • .jpg, .jpeg, .png, .gif, .bmp, .tiff, .tif

Audio Files:

  • .mp3, .wav, .aac, .flac

Video Files:

  • .mp4, .avi, .mkv, .mov, .wmv

Document Files:

  • .pdf, .doc, .docx, .ppt, .pptx, .xls, .xlsx

Compressed Files:

  • .zip, .rar, .tar, .gz

Disk Image Files:

  • .iso, .img, .dmg

Tutorials and Guides

Explore these resources to get started and make the most of Remote File Sync:

Release Notes

0.0.1 - 0.0.4

  • Initial releases: Core features like multi-protocol support and remote file tree view introduced.

1.0.1

  • Synchronization panel display issues fixed.
  • Enhanced stability for file synchronization.

1.1.1 - 1.3.5

  • Enhanced configurations for FTP, SFTP, SSH, WebDAV, and Google Drive.
  • Improved file transfer performance and synchronization.
  • Bug fixes and documentation updates for better user guidance.

1.3.6

  • Added escaping of special characters in file paths to handle SSH command execution properly.

1.3.7

  • Updated doc files.

Enjoy using Remote File Sync! If you find it helpful, please share it with a friend or colleague to help them streamline their workflow as well!

About

Remote File Sync Documentation: Comprehensive guide and documentation for the Remote File Sync extension, a powerful tool for synchronizing files between local and remote servers directly within Visual Studio Code. Includes setup instructions, usage examples, troubleshooting tips, and more.

Topics

Resources

License

Stars

Watchers

Forks