Skip to content

Latest commit

 

History

History
49 lines (38 loc) · 2.14 KB

README.md

File metadata and controls

49 lines (38 loc) · 2.14 KB
Raw

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.

To install just this server:

pip install -r requirements.txt

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

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

License

OpenBazaar Server is licensed under the MIT License.