Access the Storj network using a simple REST API.

Usage no npm install needed!

<script type="module">
  import storjBridge from '';


Storj Bridge">

Build Status Coverage Status NPM GitHub license

Access the Storj network via simple REST API.

Running Your Own Bridge

If you're planning to run your own bridge in production, mainnet, there are several issues that need to be addressed before this use case will be better supported. The largest of the issues is that there are several manual processes that will need to be run including running monthly payouts to farmers as well as communicating with farmers to add a new "trusted key" for the bridge. Decentralized bridges is described in the Storj whitepaper (a.k.a Federated Bridges) and is an area of ongoing research. There are also several Storj Improvement Proposals to streamline these processes using Ethereum smart contracts.

Aside from those issues, running a bridge within a private network is currently an option as those will not be issues in that environment. Please see and for quick setup of an entire Storj network.

Quick Start

Install MongoDB, Git and Wget:

apt-get install mongodb redis-server git wget

Install NVM, Node.js and NPM:

wget -qO- | bash
source ~/.profile
nvm install --lts

Clone the repository, install dependencies:

git clone && cd bridge
npm install && npm link

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

NODE_ENV=develop storj-bridge

Note: Storj Bridge cannot communicate with the network on it's own, but instead must communicate with a running Storj Complex instance.

This will use the configuration file located at ~/.storj-bridge/config/develop.json.


Install utilizing automated script

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


Edit production in notepad/wordpad. For more information, see the documentation.


Storj Bridge - Access The Storj Network via REST Interface
Copyright (C) 2017 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


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.