arkstats-reporter is a backend service that runs alongside ark-node via JSON-RPC to fetch and send real-time statistics about the Ark network to the ArkStats server. For full installation instructions and to learn how it works, check out the Wiki.
The arkstats-server is currently in development and will be released in a separate repository soon:
- git
- ark-node
- npm
- nodejs
- ntp
Ensure that ark-node is installed, running, and that the API (port 4001 by default) is open and reachable from your server. For instructions on setting up an Ark node, please refer to this blog post.
Clone the arkstats-reporter release branch and run the interactive build script.
sudo apt-get install git
git clone -b release https://github.com/dafty-1/arkstats-reporter.git
cd arkstats-reporter/
bash build.sh
Note: You must clone and install arkstats-reporter as a regular user. Do not run as the root user.
Alternatively, you can edit the RPC_HOST
, RPC_PORT
, LISTENING_PORT
, INSTANCE_NAME
, CONTACT_DETAILS
and WS_SECRET
values directly in app.json if you do not want to use the installation script.
Note: You must obtain the secret token in order to authenticate with ArkStats server. Please send dafty a message, or ask around in the ArkEcosystem Slack to get your secret token.
Simply pull the latest revision and re-run the build script. You will be asked if you want to keep your existing configuration.
cd arkstats-reporter/
git pull
bash build.sh
A Docker image containing an ark-node instance and arkstats-reporter will be available soon.
To start the reporter:
pm2 start app.json
To stop the reporter:
pm2 stop arkstats-reporter
To check if the reporter is running:
pm2 status
To check the logs:
pm2 logs arkstats-reporter
Licensed under the GPLv3 License.
Thanks to karek314 and cubedro for the Lisk and Ethereum reporters in which this project was forked from.
Special thanks to jamiec79, ghostfaceuk and sidzero for testing the reporter.