kimitzu-go
Kimitzu Server Daemon forked from OpenBazaar
This repository contains the OpenBazaar server daemon used by Kimitzu Services to crawl and index listings. It also handles profile, wallet, and order processing for the Kimitzu Client.
The primary changes are in the schemas wherein we added additional information such as:
- Listing Location information
- Two-way rating system (Service Provider and Vendor)
- Custom properties for Service Competency Matrix
Other features and APIs on Openbazaar-Go remains as-is in Kimitzu-Go to ensure maximum compatibility and interoperability.
Table of Contents
Install
A typical install of Kimitzu contains a bundle of the server daemon and user interface. If this is what you are looking for, you can find an installer at https://github.com/kimitzu/kimitzu-client/releases. If you are looking to run the server daemon by itself or to contribute to development, see below for instructions.
Install Pre-built Packages
The easiest way to run the server is to download a pre-built binary. You can find binaries of our latest release for each operating system here.
Build from Source
To build from source you will need to have Go installed and properly configured. Detailed instructions for installing Go and openbazaar-go on each operating system can be found in the docs package.
Dependency Management
We use Godeps with vendored third-party packages.
IPFS Dependency
We are using a fork of go-ipfs in the daemon. The primary changes include different protocol strings to segregate the OpenBazaar network from the main IPFS network and an increased TTL on certain types of DHT data. You can find the full diff in the readme of the forked repo. The fork is bundled in the vendor package and will be used automatically when you compile and run the server. Note that you will still see github.com/ipfs/go-ipfs import statements instead of github.com/OpenBazaar/go-ipfs despite the package being a fork. This is done to avoid a major refactor of import statements and make rebasing IPFS much easier.
Updating
You can either pull in remote changes as normal or run go get -u -v github.com/kimitzu/kimitzu-go.
Usage
You can run the server with go run openbazaard.go start. Ensure you are using at least version 1.10 of Golang, otherwise you might get errors while running.
Options
Usage:
openbazaard [OPTIONS] start [start-OPTIONS]
The start command starts the OpenBazaar-Server
Application Options:
-v, --version Print the version number and exit
Help Options:
-h, --help Show this help message
[start command options]
-p, --password= the encryption password if the database is encrypted
-t, --testnet use the test network
-r, --regtest run in regression test mode
-l, --loglevel= set the logging level [debug, info, notice, warning, error, critical]
(default: debug)
-f, --nologfiles save logs on disk
-a, --allowip= only allow API connections from these IPs
-s, --stun use stun on µTP IPv4
-d, --datadir= specify the data directory to be used
-c, --authcookie= turn on API authentication and use this specific cookie
-u, --useragent= add a custom user-agent field
-v, --verbose print openbazaar logs to stdout
--torpassword= Set the tor control password. This will override the tor password in
the config.
--tor Automatically configure the daemon to run as a Tor hidden service and
use Tor exclusively. Requires Tor to be running.
--dualstack Automatically configure the daemon to run as a Tor hidden service IN
ADDITION to using the clear internet. Requires Tor to be running.
WARNING: this mode is not private
--disablewallet disable the wallet functionality of the node
--disableexchangerates disable the exchange rate service to prevent api queries
--storage= set the outgoing message storage option [self-hosted, dropbox]
(default=self-hosted)
--bitcoincash use a Bitcoin Cash wallet in a dedicated data directory
--zcash= use a ZCash wallet in a dedicated data directory. To use this you must
pass in the location of the zcashd binary.
Documentation
Documentation of the OpenBazaar protocol has not been formalized yet. If you would like to help, please reach out on Slack or via a new issue on GitHub.
openbazaar-go exposes an HTTP API which permits high-level interactions on the network and the internal wallet. Find the HTTP API documentation at https://api.docs.openbazaar.org.
License
MIT.