FTP/SFTP/SSH Sync
A tool for rapid code synchronization
🔥 Download Link
🎉 Supported Languages
✨ Plugin Features
- [x] Supports custom configuration of multiple development environments
- [x] Supports real-time code synchronization
- [x] Supports tracking code changes and manually uploading code
- [x] Supports automatic building and packaging of front-end projects
- [x] Supports code compression and upload (but only SSH supports remote decompression after upload)
- [x] Supports committing to Git during upload
- [x] Supports custom upload directories and excluding specific directories from upload
- [x] Supports concurrent upload and download
- [x] Supports pausing, resuming, and stopping uploads and downloads
- [x] Supports local and remote file comparison
- [x] Supports viewing remote code, with operations like adding, deleting, modifying, changing permissions, moving code, renaming, and downloading files
- [x] Supports proxy settings
- [x] Supports drag-and-drop upload of files or folders to specified server directories
- [x] 👍👍👍 Supports encryption of account and password in configuration files to prevent server account leaks 👍👍👍
📖 Usage Instructions
Plugin Configuration
- By default, the .git, .svn, .DS_Store, Thumbs.db, .idea, node_modules, runtime, and sync_config.jsonc files and folders are ignored. You can add others manually.
- If there is a .gitignore configuration file, it will be used by default to ignore the content to be uploaded.
Adding Project Configuration
Proxy Settings. The proxy will only take effect if you also set proxy = true in the project configuration below.
sync_config.jsonc Configuration Reference
{
// Environment name, supports custom names
"test": {
// Test environment
"type": "ftp", // (Required) Transfer type, supports ftp, sftp, ssh
"host": "0.0.0.0", // (Required) Server address
"port": 22, // (Optional) Port number. Default is 21 for ftp, 22 for sftp and ssh
"username": "username", // (Required) Login username
"password": "password", // Login password (choose one between this and private key path)
// "privateKeyPath": "/your_path/id_rsa", // (For sftp, ssh configuration) Private key path (choose one between this and login password). Note: It's best not to put the key in the code root directory
// "secretKeyPath": "/your_path/secret_key.txt", // Path to the encryption private key, used for encrypting usernames and passwords. Note: It is best not to place the key in the code directory.
"proxy": false, // Whether to use a proxy, default is false
"upload_on_save": false, // Submit code in real-time after saving. It's recommended for single developers. When upload_on_save is set to true, watch, submit_git_before_upload, compress, and deleteRemote are invalid. Default is false
"watch": false, // Monitor file changes in the upload directory. Default is true. If upload_on_save is true, this option is invalid. If the distPath directory is configured, only file changes under the distPath directory will be monitored
"submit_git_before_upload": true, // For team development. Commit local Git before uploading code to prevent overwriting remote code. Default is false
"submit_git_msg": "", // Configuration for the commit message of Git. Default is empty. When submit_git_before_upload is true and this field is not filled, a prompt box will pop up for manual input
// "build": "yarn build:test", // (Optional) Command to execute for building. Open this option if it's a front-end project
"compress": true, // Whether to upload in compressed form. Default is false
//"remote_unpacked": true, // Whether to unpack remotely after compressed upload (requires SSH support). Default is true for SSH, false for others
//"delete_remote_compress": true, // Whether to delete the remote compressed file after uploading the compressed file. Default is true for SSH, false for others
//"delete_local_compress": true, // Whether to delete the local compressed file after uploading the compressed file. Default is true
"distPath": [], // (Optional) Local directories to be uploaded. Supports strings or arrays. Default is to upload the root directory
"upload_to_root": false, // If only one directory is configured in distPath, upload it to the root of the remotePath. Generally used for deploying front-end code. Default is false
"deleteRemote": false, // Whether to delete the remote distPath directory before uploading. Generally used for cleaning up front-end deployment code. Default is false
"remotePath": "/www/wwwroot/test", // (For sftp, ssh configuration) Server address for upload
"excludePath": [], // (Optional) Files and directories to be excluded from upload in the current environment. It will be merged with the plugin's excludePath configuration. When the plugin uses gitignore, it will be merged with the .gitignore configuration file
// "downloadPath": "" // (Optional) Download path. Default is the current project root directory. Used when manually downloading files or folders. You can specify a download address
// "downloadExcludePath": [], // (Optional) Files and directories to be excluded from download
"default": true // Whether it's the default environment. When set to true, you can use the right-click menu to quickly upload files or folders and compare with remote files. Default is false
},
"online": {
// Production environment
"type": "sftp",
"host": "0.0.0.0",
"port": 22,
"proxy": true,
"username": "username",
"password": "password",
// "privateKeyPath": "/your_path/id_rsa",
"upload_on_save": false,
"watch": false,
"submit_git_before_upload": true,
"submit_git_msg": "",
// "build": "yarn build:online",
"compress": false,
//"remote_unpacked": false,
//"delete_remote_compress": true,
"upload_to_root": false,
"deleteRemote": false,
"distPath": [],
"remotePath": "/www/wwwroot/online",
"excludePath": [],
// "downloadPath": "",
// "downloadExcludePath": [],
"default": false
}
}
// Exclusion rules for excludePath and downloadExcludePath, support wildcards
[
"**/*.mp4",
"aaa/bbb", // Exclude aaa/bbb
"!aaa/bbb/ccc", // Do not exclude the ccc folder under aaa/bbb
]
Upload Demonstration
Upload demonstration
File comparison demonstration
Friendly Reminder
- If you are unable to connect to the server, you can try using other connection tools such as xftp, filezilla, etc. to connect to the server. Once confirmed, you can try connecting again.
- After uploading files, if the tree menu is not updated, you can use the right-click menu to refresh the file tree.
- Why is the file not downloaded from the server when reopening it? To save resources, the plugin caches opened files. If you need to update the file, please use the right-click menu and refresh it.
- Why can't the username or password be decrypted? Your key has been modified. Please re-enter the initial account password and encrypt/decrypt again.
- Every time you edit the configuration file, all tasks will be automatically stopped. Therefore, please do not modify the configuration file randomly during the upload process.
Issue Feedback
This project is developed in spare time. You can report issues here, but the fixes may not be immediate.
Submit an Issue
| |
