Skip to content
This repository has been archived by the owner on Mar 1, 2020. It is now read-only.

ChrisMacNaughton/BtSync

Repository files navigation

BtSync

Gem Version Build Status Code Climate Coverage Status Flattr this

BtSync is a library to help you interact with Bittorrent Sync in Ruby

Installation

Add this line to your application's Gemfile:

gem 'btsync'

And then execute:

$ bundle

Or install it yourself as:

$ gem install btsync

Usage

Using BtSync

bittorrent = BtSync.new(options)

options is a hash that can contain any of the following options. The values shown are the defaults if no argument is passed in

{
  :protocol => "http",
  :uri => "localhost",
  :port => "8888",
  :user => "",
  :password => ""
}

####BtSync::Directory

A system directory managed with Bittorrent Sync is represented as a BtSync::Directory.

On a BtSync::Directory you can

  • Update the secret
  • change the settings for
    • Use tracker server
    • Use relay server when required
    • Search LAN
    • SearchDHT network
    • Delete Files to Sync Trash
    • Use Predefined Hosts

Todo

  • Manage predefined hosts
  • Allow user authentication

Known Issues

  • [] Bittorrent Sync must be run on a Linux system

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

About

Manage Bittorrent Sync from Ruby

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages