Skip to content

akm4/bridge

 
 

Repository files navigation

Storj Bridge

Build Status Coverage Status NPM GitHub license

Access the Storj network via simple REST API.

Quick Start

With Vagrant

Download and install vagrant for your platform.

Clone the repository:

git clone https://github.com/Storj/bridge.git
cd bridge

Start up the vagrant VM:

vagrant up

NOTE: the first time you vagrant up it will take a while as vagrant downloads the base VM and provisions it.

SSH into the vm and start the server (set the NODE_ENV environment variable to specify the config):

vagrant ssh
NODE_ENV=develop storj-bridge

Manually

Install MongoDB, Git and Wget:

apt-get install mongodb git wget

Install NVM, Node.js and NPM:

wget -qO- https://raw.githubusercontent.com/creationix/nvm/v0.30.1/install.sh | bash
source ~/.profile
nvm install 4.2.3

Clone the repository, install dependencies:

git clone https://github.com/Storj/bridge.git
cd bridge
npm install && npm link

Start the server (set the NODE_ENV environment variable to specify the config):

NODE_ENV=production

This will use the configuration file located at ~/.storj-bridge/config/develop.json. For local testing and development, you can run Storj Bridge and a farmer to seed it using the included development script:

cd /path/to/storj-bridge
npm run develop

Windows

Install utilizing automated script

https://github.com/Storj/storj-automation/archive/master.zip

The default configuration can be modified as needed. It is located at

%USERPROFILE%\.storj-bridge\config

Edit devel in notepad/wordpad

For more information, see the documentation.

License

Storj Bridge - Access The Storj Network via REST Interface  
Copyright (C) 2016  Storj Labs, Inc

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

Terms

This software is released for testing purposes only. We make no guarantees with respect to its function. By using this software you agree that Storj is not liable for any damage to your system. You also agree not to upload illegal content, content that infringes on other's IP, or information that would be protected by HIPAA, FERPA, or any similar standard. Generally speaking, you agree to test the software responsibly. We'd love to hear feedback too.

About

Access the Storj network via simple REST API.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 94.1%
  • Shell 5.1%
  • HTML 0.8%