diff --git a/docs/images/jm_orderbook.png b/docs/images/jm_orderbook.png new file mode 100644 index 0000000..2e0ee81 Binary files /dev/null and b/docs/images/jm_orderbook.png differ diff --git a/docs/orderbook.md b/docs/orderbook.md new file mode 100644 index 0000000..5bc4d56 --- /dev/null +++ b/docs/orderbook.md @@ -0,0 +1,30 @@ +# Orderbook + +![](images/jm_orderbook.png) + +To setup your own local orderbook, the only thing you need is an install of Joinmarket (you don't need Bitcoin Core for that); +follow either the Quick Install on the readme (`./install.sh`) (RECOMMENDED), or one of the manual installation as per [here](INSTALL.md). + +## Configuration + +To run the orderbook without access to Bitcoin Core, edit the `joinmarket.cfg` file in your Joinmarket data directory as per below +(NOTE: if you don't have a data directory, it will be created the first time you run the script). + +``` +[BLOCKCHAIN] +blockchain_source = no-blockchain +``` + +Comments are omitted; do read them. + +You may also want to check the `[MESSAGING:server]` options, e.g., if you want to use IRC Tor onion services you can edit the relevant parts. + +## Start + +Launch the `ob-watcher.py` script from `scripts/obwatch` as any other Joinmarket script. + +`(jmvenv)$ python ob-watcher.py` + +Add `-p PORT` to use a custom port (default is equivalent to `-p 62601`). + +Then open the link to the just created local server in your favorite browser. \ No newline at end of file