Giter VIP home page Giter VIP logo

bitcoind-status's Introduction

bitcoind-status

This is a small PHP application designed to display status and information from the Bitcoin node daemon.

Requirements

To run the application, you will need:

  • A Bitcoin node!
  • A web-server with PHP installed.
  • The PHP curl module - this is used to make RPC calls to the Bitcoin daemon.

Getting Started

To get started, all you need to do is copy/rename php/config.sample.php to php/config.php and configure your node's RPC credentials. The application will connect to your node via RPC and report statistics.

Advanced Options

The config.php file also contains lots of options to control how the application behaves:

  • debug (Boolean, default: FALSE) - Enables debug mode. This prints the full $data array into the page`s HTML output inside a comment.
  • rpc_user(String, default: rpcuser) - Username for RPC calls.
  • rpc_pass (String, default: rpcpass) - Password for RPC calls.
  • rpc_host (String, default: localhost) - Which RPC host to connect to.
  • rpc_port (String, default: 8332) - Port to use for the RPC connection.
  • rpc_ssl (Boolean, default: FALSE) - Should we use SSL for the RPC connection?
  • rpc_ssl_ca (String, default: NULL) - The SSL CA chain file.
  • cache_file (String, default: /tmp/bitcoind-status.cache) - File location to write to for cache.
  • max_cache_time (Int, default: 300`) - Expiry time for cache.
  • nocache_whitelist (Array, default: array('127.0.0.1')) - The IP addresses that are allowed to bypass or clear cache.
  • admin_email (String, default: [email protected]) - Email address to display on error
  • display_donation_text (Boolean, default: TRUE) - Display text to encourage donations.
  • donation_address (String, default: not_set) - Bitcoin address to use for donations to support the node.
  • donation_amount (String, default: 0.001) - Donation amount - not currently implemented.
  • use_bitcoind_ip (Boolean, default: FALSE) - Use the Bitcoin daemon to get the public IP, instead of $_SERVER
  • intro_text (String, default: not_set) - Introductory text to display above the node statistics.
  • display_peer_info (Boolean, default: FALSE) - Switch to enable displaying connected peers.
  • display_free_disk_space (Boolean, default: FALSE) - Switch to enable displaying free disk space.
  • display_ip_location (Boolean, default: FALSE) - Switch to enable displaying your IP location.
  • display_testnet (Boolean, default: TRUE) - Switch to enable displaying if the node is running on testnet.
  • display_version (Boolean, default: FALSE) - Switch to enable displaying the nodes version.
  • use_cache (Boolean, default: TRUE) - Switch to enable the cache feature.

Important Note

  • Do not disable cache unless you either have an alternative mechanism or your node is protected from potential DDoS attacks.

bitcoind-status's People

Contributors

craigwatson avatar btctaras avatar bitcoinmitchell avatar hipio avatar

Watchers

Tealc avatar

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.