Giter Site home page Giter Site logo

arkstats-reporter's Introduction

ArkStats Reporter

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.

ArkStats Server

The arkstats-server is currently in development and will be released in a separate repository soon:

ArkStats Server

Dependencies

Installation on Ubuntu Server

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.

Updating

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

Installation on Docker

A Docker image containing an ark-node instance and arkstats-reporter will be available soon.

Running the reporter

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

License

Licensed under the GPLv3 License.

Links

Credits

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.

arkstats-reporter's People

Contributors

dafty avatar

Watchers

James Cloos avatar seatrips avatar  avatar

Forkers

mody199610

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.