This repo contains the CXO 2.0 Node and CLI. These tools allow you to make use of the CXO 2.0 network and register/communicate with the CXO 2.0 Tracker, hosted at cxo.skycoin.com.
The following lines describe the process to install the base CXO Node. If you want to share files or directories, or download feed updates you should also install the example file sharing app, which utilizes CXO to perform file sharing tasks. The Readme for file sharing can be found here.
In order to run the Node or CLI, the following steps should be completed (skip 1 and 2 if you are using the default cxo.skycoin.com tracker):
- Obtain CXO Tracker's pub key value following the steps given on that project's README (once public, this should be published somewhere else)
- Update local pointer to the tracker service with that pub key
- Run
sh install.shfrom the root of this project (node and CLI will be installed in GOPATH/bin so make sure it's on your environment's PATH variable or use absolute path for both of them)
The Node handles all background activity and communication with the CXO 2.0 Tracker. This includes:
- Listening to subscribed data feed updates
- Requesting and downloading newly published files from subscribed data feeds
The Node is purely a background service and does not require any commands for usage.
Node instance is available running the cxo-node. Executing it will run the daemon service on the user's local machine.
The Node stores data locally in a BoltDB bucket called Data Objects. Currently it's storing the data object hash and the path to the local file. This is being improved further at the moment.
The CLI may be used manually or called upon from other applications. The CLI is available by running the cxo-node-cli. It enables users to interact with the CXO 2.0 Tracker and allows:
-
Subscribing to pub key
Example usage:
cxo-node-cli subscribe <publisher's pub key> -
Publishing new objects (includes signing of the object)
Example usage:
cxo-node-cli publish <pathToFile>