fkwdigital/Deploy Files Through Rsync to Remote Ubuntu-based Linux Server
Deploy via rsync over SSH with enforced excludes and flexible path configuration.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| SSH_PRIVATE_KEY | Private key contents (highly recommended to add through GitHub secrets) | yes | — |
| REMOTE_HOST | Destination host (server IP or hostname) | yes | — |
| REMOTE_USER | SSH username | yes | — |
| REMOTE_PORT | SSH port | — | 22 |
| REMOTE_PATH | Absolute remote path (e.g., /var/www/html, /home/user/public_html) | yes | — |
| SOURCE | Relative local source. Defaults to public/. | — | public/ |
| RSYNC_ARGS | Rsync args (space separated). | — | -azvr --inplace --exclude='.*' --no-perms --no-times |
| SSH_PASSPHRASE | Passphrase for the SSH private key (required by some managed hosts) | no | — |
| ARGS | (Alias) Same as RSYNC_ARGS for compatibility. | no | — |
| EXCLUDE_FILE | Optional path to an rsync --exclude-from file (e.g., ./public/exclude.txt) | no | — |
| EXTRA_EXCLUDE | Optional comma-separated extra exclude patterns appended to the built-in list. | no | — |
| SCRIPT | Optional shell commands to run on the remote server after deployment (e.g., 'cd /var/www/html && wp cache flush') | no | — |
Outputs
no outputs