https://github.com/simonneutert/ruby-sftp-sync
sync a directory with your webhoster (no deletion) - perfect for jekyll users with a simple webspace
https://github.com/simonneutert/ruby-sftp-sync
command-line-tool ftp jekyll ruby sftp ssh sync
Last synced: about 1 year ago
JSON representation
sync a directory with your webhoster (no deletion) - perfect for jekyll users with a simple webspace
- Host: GitHub
- URL: https://github.com/simonneutert/ruby-sftp-sync
- Owner: simonneutert
- License: mit
- Created: 2018-01-18T07:46:24.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2025-02-01T18:50:37.000Z (over 1 year ago)
- Last Synced: 2025-05-09T00:52:09.373Z (about 1 year ago)
- Topics: command-line-tool, ftp, jekyll, ruby, sftp, ssh, sync
- Language: Ruby
- Size: 13.7 KB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Push files to a server using sftp (and ssh)
In order to automate my Jekyll workflow, I thought about writing a bash script first. But why not use Ruby instead?
__Inspiration__ was found __[here](https://www.infoq.com/articles/ruby-file-upload-ssh-intro), where Matthew Bass__ ([Matthew's GitHub](https://github.com/pelargir)) wrote a nice little article dated 2007. Though its simplicity made it easy to grasp, the script had some flaws. If you used an FTP client for your first upload, and the directories of your project would change or would never be deeper than one level - you are good to go. Yet my project had nested directories and thanks to progress, the gems wouldn't work quite the same as in the old days of 2007.
# How to use?
Simply load the __script__ and the __config.yml__ to the root of your application.
Setup your Configuration in `config.yml`
``` yaml
host_url: 'yourdomain.com'
username: 'xyz'
local_path: './_site'
remote_path: '/httpdocs/public_html'
file_perm: 0o644
dir_perm: 0o755
```
The following commands are implemented:
* `$ ruby Upload2SFTP.rb upload [--config ./path-to-config.yml]`
uploads new files and directories
* `$ ruby Upload2SFTP.rb clean [--config ./path-to-config.yml]`
deletes all files and subdirectories
* `$ ruby Upload2SFTP.rb reupload [--config ./path-to-config.yml]`
deletes all files and subdirectories and resyncs
* `$ ruby Upload2SFTP.rb remove [--config ./path-to-config.yml]`
deletes all files, subdirectories and root
___
relies on the following gems, so either run `$ bundle` or:
``` bash
# https://github.com/net-ssh
$ gem install net-ssh
$ gem install net-sftp
$ gem install commander
```
### Pull requests are welcome! :octocat: