Skip to content
This repository has been archived by the owner on May 16, 2019. It is now read-only.

Latest commit

 

History

History
89 lines (67 loc) · 2.82 KB

README.md

File metadata and controls

89 lines (67 loc) · 2.82 KB

Note: This project is no longer maintained. Please see version 2 at https://github.com/OpenBazaar/openbazaar-go


OpenBazaar Server

Build Status Coverage Status Slack Status

This repo contains the OpenBazaar networking daemon that can be used to access the p2p network. It establishes connections and maintains a Kademlia style DHT. Rest and websocket APIs are available for clients to communicate with the daemon.

Install

Pre-built installers which bundle the client and server components can be found here.

Depending on your system configuration you may need to install some additional dependencies. You can find more detailed, OS specific, instructions here.

To install just this server:

sudo pip install -r requirements.txt

Usage

python openbazaard.py start --help
usage: python openbazaard.py start [<args>]

Start the OpenBazaar server

optional arguments:
  -h, --help            show this help message and exit
  -d, --daemon          run the server in the background as a daemon
  -t, --testnet         use the test network
  -l LOGLEVEL, --loglevel LOGLEVEL
                        set the logging level [debug, info, warning, error,
                        critical]
  -p PORT, --port PORT  set the network port
  -a ALLOWIP, --allowip ALLOWIP
                        only allow api connections from this ip
  -r RESTAPIPORT, --restapiport RESTAPIPORT
                        set the rest api port
  -w WEBSOCKETPORT, --websocketport WEBSOCKETPORT
                        set the websocket api port
  -b HEARTBEATPORT, --heartbeatport HEARTBEATPORT
                        set the heartbeat port
  --pidfile PIDFILE     name of the pid file

Docker

Set Username and Password

cp .env.sample .env
nano ./.env

Build and run

docker-compose up

Backup

All relevant data will go to

./data

SSL Support

  • Generate certificate as described here

  • Place the server.crt and server.key into

./ssl
  • Enable SSL in
./docker-compose.yml

License

OpenBazaar Server is licensed under the MIT License.