Web status page for Litecoin (and similar) full nodes
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.gitignore
LICENSE
README.md
config-example.php
forms.php
index.php
requests.php
style.css
utils.php

README.md

Litecoin Node Interface

This is a basic web status page for Litecoin1 full nodes. It's not pretty, but it works. If you want to see how it looks, a demo is available here.

You can use it to check thing like:

  • Node uptime (but only on very recent versions of Litecoin Core).
  • Sync status (by looking at the number of blocks/headers).
  • Network usage: How much data your node has sent/received (since daemon start).
  • Connected peers: Info about inbound ant outbound connections to your node.

If you have any problems or suggestions, feel free to open an issue or pull request.

1: While I did it with Litecoin in mind, it should work with bitcoin or any of its forks without problems.

Security

I think this is secure, but that doesn't mean there's not a security hole somewhere. If you find one, please contact me.

Before doing anything, consider reviewing the source code (or ask someone you trust to do it) to check that it's not doing anything malicious.

There's not any type of authentication mechanism built in. If you want to restrict access, use the features provided by your web server to do so.

WARNING: if your full node has a wallet enabled, this software has access to it. It no longer prevents you to run it if a wallet is found, but please do not use this if your node has a non-zero balance.

Requirements

To run this you need a web server (like Apache) with a recent version of PHP with curl support. The web server can be installed on a different machine, but you will need to allow RPC calls from it.

On Debian and derivates (Ubuntu, etc) you can install everything with

# apt-get install apache2 libapache2-mod-php php-curl

For other distros, there are a lot of awesome tutorials online you can check.

Installing

First thing you need to do is add an username/password to the node configuration. Add the following lines to your litecoin.conf file:

rpcuser=someusername
rpcpassword=somethingsecret

Once you do it, restart the daemon:

$ litecoin-cli stop
$ litecoind -daemon

After that, clone this repository in an empty, publicly accessible directory:

$ git clone https://github.com/xblau/node-interface.git .

Now, copy (not rename) the example config file to config.php:

$ cp config-example.php config.php

Using your favorite editor, edit config.php and replace the default username and password with the ones specified on your config file.

After you do that, open your browser and go to the webpage. If your node is running, everything should be working.

Updating

Simply run git pull. This should get any new commits and apply them to your local copy.

License

This project is free software, licensed under the terms of the MIT License. See the LICENSE file on this repository or opensource.org/licenses/mit.

If you liked or found this useful, starring this repo on GitHub or sending an email (even if it's just a "Hey, I'm using your project") helps a lot! Also, in case you want to send a tip: LXBLauKyugeQGY2m8JZSMQJzc9rR1yNXgR.