GithubHelp home page GithubHelp logo

btsync's Introduction

btsync Cookbook

Fast, unlimited &amp secure file-syncing. Free from the cloud. Sync never stores your files on servers, so they stay safe from data breaches and prying eyes. A more detailed and in depth FAQ and documentation about bittorrent sync can be found on: http://www.bittorrent.com/sync

The btsync cookbook installs bittorrent sync and provides a simple LWRP for adding shared folders that are to be synced between multiple servers. When using a hosted chef install you will be able to use the search feature to automatically find and add additional nodes to bittorrent sync without making any modifications.

Requirements

Please note btsync on linux requires glibc 2.3 or greater.

Attributes

TODO: Full attributes will be completed soon.

btsync::default

Key Type Description Default
['btsync']['setup']['user'] String The user that the btsync daemon will run as webserv
['btsync']['setup']['bin_dir'] String Where the binary will be installed to (should be in your path) /usr/local/bin/

Usage

btsync::default

Just include btsync in your node's run_list:

{
  "name":"my_node",
  "run_list": [
    "recipe[btsync::default]"
  ]
}

Then add a path and options to your server role like so:

{
    "name": "examplerole",
    "chef_type": "role",
    "json_class": "Chef::Role",
    "description": "Example Role for BTSYNC",
    "override_attributes": {
        "btsync":{
            "setup":{
                "user": "httpd",
                "group": "httpd"
            },
            "main_options":{
                "storage_path": "/data/btsync",
                "webui":{
                    "password": "SomeCoolPasswordForTheUI"
                }
            },
            "shared_folders":{
                "DescriptiveNameForPathToSearchON":{
                    "dir":"/path/to/some/directory/",
                    "secret":"S0M3L0NGB7SYNCG3N3R4T3DS3CR37",
                    "SyncIgnore":[".DS_Store",".DS_Store?","._*",".Spotlight-V100",".Trashes","Icon?","ehthumbs.db","desktop.ini","Thumbs.db","somefile.log","logs/*"]
                 },
                "AnotherDirectoryToSync":{
                  "dir":"/path/to/some/other/directory/",
                  "secret":"S0M3L0NGB7SYNCG3N3R4T3DS3CR372",
                  "SyncIgnore":[".DS_Store",".DS_Store?","._*",".Spotlight-V100",".Trashes","Icon?","ehthumbs.db","desktop.ini","Thumbs.db","somefile.log"]
                }
               }
            }
        }
    },
    "run_list": [
        "recipe[btsync::default]"
    ]
}

Contributing

  1. Fork the repository on Github
  2. Create a named feature branch (like add_component_x)
  3. Write your change
  4. Write tests for your change (if applicable)
  5. Run the tests, ensuring they all pass
  6. Submit a Pull Request using Github

License and Authors

Authors: Will Hattingh & contributors https://github.com/Nitecon/btsync/graphs/contributors

btsync's People

Contributors

ctrld avatar johntdyer avatar matt-thomson avatar mbryne avatar nanassito avatar nitecon avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.