PHP Bitcoin Node Status Page

[CraigWatson]

After setting up my VPS as a full node, I thought it would be nice if I had some way of displaying it to the world.

My Node

https://odin.vikingserv.net

GitHub Code: https://github.com/craigwatson/bitcoind-status
Travis CI: https://travis-ci.org/craigwatson/bitcoind-status

Donations

BTC donations are also graciously accepted both direct to 174N2KwMzKYvYkCSx1kezrzfSQuJQEZY9T and also via ChangeTip  

TL;DR - Main Features

• List of connected nodes, with optional geolocation
• Simple file-based cache system to limit RPC calls
• Ships with two different CSS styles - "light" (default) and "dark"
• Generates and displays a donation QR code for donations
• IP-based whitelist for clearing/bypassing the cache
• Displays historical number of connections (requires the use of a stats-collecting cron job)
• Displays graph showing peer type breakdown over time (requires the use of another stats-collecting cron job)

Full Features List

• Peer list is filterable - you can ignore a set list of peer IPs and also Tor peers
• Extra agent strings can be added to the peer type graph
• Fully responsive mobile design, including connected nodes table
• Can bypass the file-based cache system entirely
• Displays free disk space
• Can either display the node's IP address via the PHP $_SERVER variable, or from the Bitcoin Daemon
• Display if the node is running on testnet
• Display the currently running Bitcoind version
• Optionally display the remote port when listing connected peers.
• IP-based geolocation flags for both node and peer IP addresses
• Optional "Fork me on GitHub" ribbon (toggleable via config.php, enabled by default)
• Testing includes PHP syntax checking and PEAR standards compliance

Please note that disabling the cache could overload your Bitcoind with RPC calls, and also cause geolocation errors (the current geolocation provider is rate-limited to 120 requests per minute). Please use with caution!

I'd really appreciate it if everyone could keep the ribbon enabled to try and boost exposure for the code

Contributions

Please feel free to comment, suggest (or better still, contribute!) new features or improvements.

Wanted - PHP Test Writers!

I'd like to get more test coverage of my code to make contributions even easier - if anyone has any experience in writing PHP tests (either PHPunit or something else), please reach out.

[Remember remember the 5th of November]

I was about to suggest a cache, then I read your post again

[hamdi]

nice one

[Taras]

Looks nice! I'll have a look, maybe put it on my node.

[mrflibblehat]

Very Nice, It might be nice to show some Peer Info, Who is connected, What version of bitcoind they use etc.

I can fork your code and add this if you like, You are welcome to use it.

MrF

[CraigWatson]

Very Nice, It might be nice to show some Peer Info, Who is connected, What version of bitcoind they use etc.

I can fork your code and add this if you like, You are welcome to use it.

MrF

Just added this - bit of a hacky implementation as it's not responsive, but responsive tables are annoying as hell

[mrflibblehat]

Very Nice, It might be nice to show some Peer Info, Who is connected, What version of bitcoind they use etc.

I can fork your code and add this if you like, You are welcome to use it.

MrF

Just added this - bit of a hacky implementation as it's not responsive, but responsive tables are annoying as hell

No thats good, Looks really neat.

Good Job

Would be nice to have multiple themes I will use this for my full node.

[Taras]

Submitted a pull request with some potential improvements just now

[Just Magicmann]

This is fantastic. Likely going to fork it to use for a cryptocurrency I've been supporting and running nodes for. 

[CraigWatson]

Just improved a few things, including handling errors from RPC and responsifying the peer information tables, check out the live copy here: https://loki.vikingserv.net

A full README is next on the list!

This is fantastic. Likely going to fork it to use for a cryptocurrency I've been supporting and running nodes for. 

Thanks, much appreciated - please feel free to tip/donate if you find it useful

Submitted a pull request with some potential improvements just now

Pull request merged

[Just Magicmann]

Would you consider adding something in the config files that would give users the option of displaying the connected user's IPs?

[CraigWatson]

Would you consider adding something in the config files that would give users the option of displaying the connected user's IPs?

It already exists, just flip the 'display_peer_info' switch to TRUE -  a full readme is on the way though

Reference: https://github.com/craigwatson/bitcoind-status/blob/master/php/config.php#L20

[Just Magicmann]

Would you consider adding something in the config files that would give users the option of displaying the connected user's IPs?

It already exists, just flip the 'display_peer_info' switch to TRUE -  a full readme is on the way though

Reference: https://github.com/craigwatson/bitcoind-status/blob/master/php/config.php#L20

My bad, I meant to not display it, but I see I can just ensure that's set to false.

[terrytibbs]

You need to sanitize the protocol subversion before displaying it to users.

[CraigWatson]

You need to sanitize the protocol subversion before displaying it to users.

Any particular reason?

[terrytibbs]

You need to sanitize the protocol subversion before displaying it to users.

Any particular reason?

Nevermind, the client does it for you these days: https://github.com/bitcoin/bitcoin/commit/a946aa8d3ec7009ac670eeb65a525efe5eeb6e84

I haven't been around for a while.

[Taras]

You need to sanitize the protocol subversion before displaying it to users.

Any particular reason?

Nevermind, the client does it for you these days: https://github.com/bitcoin/bitcoin/commit/a946aa8d3ec7009ac670eeb65a525efe5eeb6e84

I haven't been around for a while.

Welcome back

[Gumbork]

something new, time to give it a shot.

[Nikinger]

You need to sanitize the protocol subversion before displaying it to users.

Any particular reason?

Nevermind, the client does it for you these days: https://github.com/bitcoin/bitcoin/commit/a946aa8d3ec7009ac670eeb65a525efe5eeb6e84

I haven't been around for a while.

This fix was made at version 0.9 (if I read it correctly). When doing a "getpeerlist" on my own client (or visiting CraigWatson's status page), I see some clients still having <0.9.
I think htmlspecialchars() shouldn't hurt. It's better than potentially endangering webmasters who integrates the status page on a <0.9 node.

[Mitchell]

Well, I just setup a Bitcoin node, just give this try this. I have always wanted to run a Bitcoin node so now I had a reason to do so. The status page can be found here: click. Bitcoind is still syncing blocks though and has been doing so for the last 12 hours.