https://github.com/hexojs/hexo-deployer-rsync

Rsync deployer plugin for Hexo.
https://github.com/hexojs/hexo-deployer-rsync

hexo hexo-plugin

Last synced: 4 months ago
JSON representation

Rsync deployer plugin for Hexo.

• Host: GitHub
• URL: https://github.com/hexojs/hexo-deployer-rsync
• Owner: hexojs
• License: mit
• Created: 2014-12-29T11:27:27.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2025-09-29T19:06:57.000Z (9 months ago)
• Last Synced: 2025-09-30T11:57:50.699Z (9 months ago)
• Topics: hexo, hexo-plugin
• Language: JavaScript
• Homepage:
• Size: 62.5 KB
• Stars: 52
• Watchers: 12
• Forks: 31
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# hexo-deployer-rsync

[![Build Status](https://github.com/hexojs/hexo-deployer-rsync/workflows/Tester/badge.svg)](https://github.com/hexojs/hexo-deployer-rsync/actions?query=workflow%3ATester)

[![NPM version](https://badge.fury.io/js/hexo-deployer-rsync.svg)](https://www.npmjs.com/package/hexo-deployer-rsync)

[![Coverage Status](https://coveralls.io/repos/github/hexojs/hexo-deployer-rsync/badge.svg)](https://coveralls.io/github/hexojs/hexo-deployer-rsync)

Rsync deployer plugin for [Hexo].

## Installation

``` bash

$ npm install hexo-deployer-rsync --save

```

## Options

You can configure this plugin in `_config.yml`.

``` yaml

deploy:

  type: rsync

  host: 

  user: 

  root: 

  port: [port] # Default is 22

  delete: [true|false] # Default is true

  progress: [true|false] # Default is true

  args: 

  rsh: 

  key: 

  verbose: [true|false] # Default is true

  ignore_errors: [true|false] # Default is false

  create_before_update: [true|false] # Default is false

```

- **host**: Address of remote host

- **user**: Username

- **root**: Root directory of remote host

- **port**: Port

- **delete**: Delete old files on remote host

- **progress**: Show rsync progress

- **args**: Rsync arguments (support space-separated strings)

- **rsh**: Specify the remote shell to use

- **key**: Custom SSH private key

- **verbose**: Display verbose messages

- **ignore_errors**: Ignore errors

- **create_before_update**: First create non-existing files, then update existing files

## License

MIT

[Hexo]: https://hexo.io/