You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on May 16, 2019. It is now read-only.
- This contains most of the backend networking for OpenBazaar. Going forward, the relevant parts of the current OpenBazaar repo will likely be merged into this.
4
-
- If you are looking to contribute to the OpenBazaar backend, this is the repo you want to work on.
5
-
- The reference client that interacts with the OpenBazaar backend [is found here](https://github.com/OpenBazaar/OpenBazaar-Client)
4
+
This repo contains the OpenBazaar networking daemon that can be used to access the p2p network. It establishes connections and maintains
5
+
a Kademlia style DHT. Rest and websocket APIs are available for clients to communicate with the daemon.
6
6
7
-
Installation notes:
8
-
---------------------
9
-
You will need Python 2 and pip installed on your system.
7
+
## Install
10
8
11
-
Depending on your configuration, you may also need to install python-dev, libffi-dev and python-pylint-common. If you're on Linux, you can do so using your operating system's standard package manager (ex. `sudo apt-get install python-dev`)
12
-
13
-
To install all Python requirements, run:
9
+
Pre-built installers which bundle the client and server components can be found [here](https://github.com/OpenBazaar/OpenBazaar-Installer/releases).
14
10
11
+
To install just this server:
15
12
```bash
16
13
pip install -r requirements.txt
17
14
```
18
15
19
-
Running Unit Tests (optional and non-Windows only)
20
-
```
21
-
pip install -r test_requirements.txt
22
-
bash
23
-
make
24
-
```
25
-
26
-
If everything has installed fine, you should get a message that everything went OK.
16
+
Depending on your system configuration you may need to install some additional dependencies. You can find more detailed, OS specific, instructions [here](https://slack-files.com/T02FPGBKB-F0KJU1CLX-cbbcf8a02c).
27
17
28
-
You can now start the server on testnet (recommended at this point) with:
18
+
## Usage
29
19
30
20
```bash
31
-
python openbazaard.py start --testnet
21
+
python openbazaard.py start --help
32
22
```
33
23
34
-
To run on the regular network:
35
-
36
-
```bash
37
-
python openbazaard.py start
38
24
```
39
-
40
-
Various options, including those related to logging and debugging, can be displayed like so:
41
-
42
-
```bash
43
-
python openbazaard.py start --help
25
+
usage: python openbazaard.py start [<args>]
26
+
27
+
Start the OpenBazaar server
28
+
29
+
optional arguments:
30
+
-h, --help show this help message and exit
31
+
-d, --daemon run the server in the background as a daemon
32
+
-t, --testnet use the test network
33
+
-l LOGLEVEL, --loglevel LOGLEVEL
34
+
set the logging level [debug, info, warning, error,
35
+
critical]
36
+
-p PORT, --port PORT set the network port
37
+
-a ALLOWIP, --allowip ALLOWIP
38
+
only allow api connections from this ip
39
+
-r RESTAPIPORT, --restapiport RESTAPIPORT
40
+
set the rest api port
41
+
-w WEBSOCKETPORT, --websocketport WEBSOCKETPORT
42
+
set the websocket api port
43
+
-b HEARTBEATPORT, --heartbeatport HEARTBEATPORT
44
+
set the heartbeat port
45
+
--pidfile PIDFILE name of the pid file
44
46
```
45
47
46
-
License
47
-
---------------------
48
+
## License
48
49
OpenBazaar Server is licensed under the [MIT License](LICENSE).
0 commit comments