https://github.com/creative-workflow/capistrano-syncfiles
This gem provides up and down file syncing with rsync, tar or sftp. This could be usefull if you are in a shared hosting environment.
https://github.com/creative-workflow/capistrano-syncfiles
Last synced: about 1 month ago
JSON representation
This gem provides up and down file syncing with rsync, tar or sftp. This could be usefull if you are in a shared hosting environment.
- Host: GitHub
- URL: https://github.com/creative-workflow/capistrano-syncfiles
- Owner: creative-workflow
- License: mit
- Created: 2017-08-19T12:16:28.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2018-11-15T13:28:48.000Z (over 7 years ago)
- Last Synced: 2025-11-30T04:26:07.256Z (7 months ago)
- Language: Ruby
- Homepage:
- Size: 7.81 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# capistrano-syncfiles
This gem provides up and down file syncing with rsync, tar or sftp. This could be usefull if you are in a shared hosting environment.
Supports folder excludes.
## Installation
First make sure you install the capistrano-syncfiles by adding it to your `Gemfile`:
gem "capistrano-syncfiles"
Add to Capfile
require 'capistrano/syncfiles'
## Configuration (deploy.rb)
Configure your files and folders like these:
```
set :syncfiles, {
'wordpress/wp-content/uploads' => { # local path
remote: 'wordpress/wp-content/uploads', # remote path
exclude: ['fvm', 'ithemes-security', 'wc-logs'] # excluded folders/files, based on local path, works also for remote
}
}
set :syncfiles_rsync_options, '-avzuO'
set :syncfiles_roles, :all # roles to run on, default: :all
set :syncfiles_temp_file # applies only to tar strategy, default: "/tmp/transfere-#{local_path.hash}.tar.gz"
set :syncfiles_tar_verbose # applies only to tar strategy, default: true
set :syncfiles_sftp_password # password for sftp connection
```
## Usage
The following tasks will be added
```
cap syncfiles:rsync:down
cap syncfiles:rsync:up
cap syncfiles:tar:down
cap syncfiles:tar:up
cap syncfiles:sftp:down
cap syncfiles:sftp:up
```
You can invoke this tasks(Rake) as you do normally: https://github.com/ruby/rake
Capistrano tasks: http://capistranorb.com/documentation/getting-started/flow/
### License
The MIT License (MIT)
### Changelog
##### 1.0.0
* add `syncfiles_rsync_options` default options
##### 0.3.0
* use `current_path` instead of `release_path`
##### 0.2.0
* add sftp strategy
##### 0.1.0
* Initial release