Self-hosted, PHP-based frontend interface for cgminer, MPOS pools, and other APIs, all in one responsive UI.
PHP CSS JavaScript
Clone or download
scar45 Merge pull request #55 from pxgamer/feature/readme-fixes
Fix 'skip to' links at top of README

Thanks for this @pxgamer!
Latest commit 3064da2 Jun 25, 2018
Permalink
Failed to load latest commit information.
Michelf Attempted fix (fail) of smooth scrolling from Overview panel -> rig; … Feb 17, 2014
css feat/pool-offline-status Apr 10, 2015
fonts copied files from Development branch into this one Feb 9, 2014
images coin/burstcoin Mar 9, 2015
includes v2.1 May 27, 2015
js fix/rigs/js-update-arguments Apr 22, 2015
templates Merge remote-tracking branch 'origin/development' into nightly Apr 14, 2015
user_data Added danger + warning panel styles Mar 7, 2014
.editorconfig fix/switch-pool-modal Aug 21, 2014
.gitignore updated dev configs Aug 12, 2014
CHANGELOG.md v2.1 May 27, 2015
LICENSE Updated README and LICENSE; Minor CSS changes to non-Dashboard pages Apr 13, 2014
README.md Fix 'skip to' links at top of README Jun 25, 2018
ajax.php fix/ajax-autoloader Mar 31, 2015
changelog.php Include functionality for displaying CHANGELOG.md May 13, 2014
debug.php v2.0.0.490-beta Jan 31, 2015
favicon.png Extensively polished the navbar (desktop); Added favicon Feb 16, 2014
help.php *HOTFIX* README on linux May 4, 2014
index.php feat/mobile-miner Mar 31, 2015
install-linux-dependencies.sh Edited update verbage; Made log area larger; renamed install script May 11, 2014
login.php fix/windows-app-alert Feb 14, 2015
logout.php *HOTFIX* Session fix? :D May 7, 2014
permissionfix.sh update/permissionfix-filetype Apr 14, 2015
rig.php fix/rigs-adding-pools Jan 27, 2015
settings.php fix/mobile-miner Apr 9, 2015
update.php fix/update-added-safety Apr 22, 2015
wallet.php fix/wallet Feb 20, 2015

README.md


Skip to FAQsSkip to Changeloghttp://cryptoglance.info


cryptoGlance

What is cryptoGlance?

cryptoGlance is an open-source, self-hosted PHP webapp providing you with a glance at all of your crypto-currency components in one spot. Designed for large and small screens, you can easily monitor and control many aspects of your crypto/mining devices. There's also an Android companion app which connects to your cryptoGlance installation remotely (it's much the same as using your mobile browser, but acts as a form of donation).

Features:

  • Standalone version with installer (for Windows), or run the source code within your own (PHP) web server environment
  • Responsive, mobile-friendly interface
  • Real-time information display (no refresh needed)
  • Secure login system
  • Obtains valid data directly from cgminer/sgminer
  • Rigs/ASICs
    • Monitors detailed statistics, and manages core functions of multiple rigs/ASICs
    • Switch pools and restart miners remotely
  • Pools
    • Actively track pool stats (MPOS and selective pools supported)
  • Wallets/Balances
    • "Wallets" in cryptoGlance are basically collections of public addresses that you wish to check the balance of
    • You can create multiple wallets which will sum up the total balances of all addresses belonging
    • Multiple coin types are supported, with more being added regularly
  • Updates:
    • Notification alerts
    • Automatic updating from within cryptoGlance
    • Select your release type preference
  • Configurable warning and danger status with visual cues
  • Void of malware or donation mining (does NOT require your private keys at all -- code is open source!)
  • Companion Android app which easily allows you to quickly access your cryptoGlance instance while on the go
  • MUCH MORE is planned! Follow our social accounts, or drop by our IRC channel to find out when new features are released!

NEW v2.0 Changes:

Recently Added Features:

  • Total Hashrates are now categorized by Rig Algorithms used
  • Enable/Disable Total Hashrate via Tools dropdown
  • New ability to edit Rigs and Pools
  • Re-amped Rig summary and device details (percentages, etc)
  • New Rig Details
  • Cleaner interface
  • Ability to drag+drop pool priority for a rig
  • Auto-Restart on BITMAIN ASIC failure (chain contains "x" instead of "0")
  • Rig devices have two more types of details showing:
    • BITMAIN ASIC fan speed (fan 1, fan 2, fan 3, etc)
    • BITMAIN ASIC temperatures (temperature 1, temperature 2, temperature 3, etc)
  • Rigs have a new option for Algorithm
  • Rigs Algorithm is auto-set when using sgMiner v5+
  • Ability to reset rig stats
  • Ability to reset rig stats on pool change
  • New FIAT conversions for most coins (Thanks to FunkyC: https://firstrally.com/)
  • New debug command to see raw miner data: CTRL + D
**Recently Added Features:** **Recently Added Coins:**
  • [+COIN] NeosCoin
  • [+COIN] ReddCoin
  • [+COIN] PayCoin

Video Demo:

cryptoGlance Video Thumb

Requirements:

  • cgminer / sgminer properly configured with API access allowed

Windows Version:

  • Windows XP or newer

Running from source:

  • PHP v5.2+
  • Apache / IIS / mongoose, or whichever web server you prefer
  • php_sockets extension enabled in PHP


Installation:

Advanced Users:

Simply setup a new PHP instance and point it to the root folder of the cryptoGlance source/download. Ensure that the php_sockets extension is enabled in php.ini, grant write access to the /user_data folder, and you should be good to go.


Linux Users:

  1. Note that a few php/supporting packages must be installed prior to using cryptoGlance. We've created a simple script that will install them for you, or feel free to run the steps yourself by examining the install-linux-dependencies.sh file.

Windows App Users:

  1. Download the latest version of cryptoGlance and run the setup executable to begin installation.

  2. Read the information that appears in the installer carefully.

  3. Choose your installation directory. NOTE - if you wish to install within C:\Program Files (x86)</b>, you will need to run cryptoGlance as an Administrator, since this is required for applications to write within that system directory. cryptoGlance creates a /user_data/ directory with your settings, and also writes new files here. This is why the default installation directory is C:\cryptoGlance.

  4. OPTIONAL - If you wish to access cryptoGlance from other devices, you'll need to edit the {{install_dir}}/settings.json file. Change line 30 to use your 192.168.x.x address, similar to:


"listen_on": ["192.168.1.20", 4041],

...and you should be good to go.



Upgrading:

Upgrading cryptoGlance is easy. First off, it never hurts to make a backup copy of your entire cryptoGlance folder. Files that should be kept particularly safe are:

  • /user_data folder

Next, you'll need to Enable cryptoGlance Updates on the Settings page. Then, choose your release type:

  • Release: Stable code, should have very few bugs/issues (if any).
  • Beta: Slightly experimental for testing new features and bug-fixes.
  • Nightly: Bleeding-edge code commits, will most likely have bugs, but they shouldn't be very serious.

Windows App:

Since the Windows App works a bit differently, in the sense that it has its own webserver with PHP installed and configured, updates aren't usually frequent, and separate from the main release version numbers. However, if you do use the Windows App, it may be a good idea to check for the latest version on SourceForge from time to time. Simply install the program to the same directory. Your /user_data folder will not be overwritten.

If you've made edits to {{ install-dir }}\settings.json (optional modification for accessing cryptoGlance externally on other devices), then you'll need to re-apply them after the installation finishes.



Changelog:

With every major Release, we include a concise changelog of all updates contained within. Alternatively, you can check out our live commits if you are running Beta or Nightlies:

* Remember, you can choose if you'd like to be alerted to cryptoGlance updates by checking the Settings page, and selecting Enable cryptoGlance Updates. After that, choose the version type you'd like, hit Save and you're good to go.



FAQ:

Q. What is the difference between the Windows and Source downloads?

A. The Windows Version is a pre-packaged solution which allows cryptoGlance to run under its own PHP web server (Mongoose), without the need to setup any external apps/services. This version is recommended for Windows users who are not familiar with server configuration.

The Run from Source version is for users who know how to setup a (simple) PHP site. An ideal use of this version is to clone the repo from Github to a virtual directory that is served by your choice application (Apache, IIS, etc.). This method allows you to update quite easily, and also prepare code that can be contributed back to the project via a pull request.


Q. I am (understandably) careful with my crypto-currency. Can I trust cryptoGlance?

A. Most definitely! The code is completely open source, and you run cryptoGlance on your own web server (even the Windows version). There's no calls to home, or anything of the sort. No private keys are requested, passwords (stored as salted hashes) and API keys are within a protected /user_data directory, excluded from source.


Q. How do I backup my cryptoGlance settings?

A. Just look for the /user_data folder in the following locations, and copy it somewhere safe:

  • {{ project-root }}/user_data
  • Windows App users need to backup {{ install-dir }}\application\user_data and {{ install-dir }}\settings.json (optional modification for accessing cryptoGlance externally on other devices)

Q. I cannot get cryptoGlance to run. What can I check?

A. The Windows version should work quite well out of the box, but getting cryptoGlance setup under your own web server requires a bit of knowledge. Most often times, you can search for any specific errors you see, or try the following:

Windows Version:

  • Configure any firewalls/anti-virus to allow cryptoGlance.exe traffic through
  • Note the default port for the Windows app is 4041. If you are configuring cryptoGlance to be externally accessible, you'll need to forward port 4041 to the IP of the Windows box running it, or change the port via the app's config file here:
  • {{ install-dir }}\settings.json
  • Simply open it in a text editor, and search for "listen_on": ["127.0.0.1", 4041]
  • Investigate the {{ cG Install Dir }}\debug.log file for traces of errors

Running from source:

  • Confirm that PHP is installed and working properly
  • Ensure that the php_sockets extension is loaded via php.ini
  • (Linux) Ensure that you have the following packages installed:
  • apache2
  • php5
  • libapache2-mod-php5
  • php5-json
  • php5-curl
  • Adjust permissions to allow for write access on the /user_data folder

Q. The cryptoGlance site loads, but after adding a rig, no data or stats are displayed. Why?

A. Your mining utility (cgminer) requires that API access is allowed. Here's an example excerpt from the .conf:

...
"api-allow" : "127.0.0.1,192.168.1/24",
"api-listen" : true,
"api-mcast-port" : "4028",
"api-port" : "4028",
...

Q. Why do certain rig commands not work?

A. Some functions require API write access in order to issue commands to the miner. An example of these would be Switch Pools, and other such commands that don't simply read data. In order to fix this, open your miner .conf file (or modify your .bat), and ensure that you have a "W:" notation before each IP that you wish to grant write access to:

"api-allow" : "W:127.0.0.1,W:192.168.1/24",

Q. After adding a pool panel, I see a lot of NULL values. What's up?

A. This is most often caused by entering any one of the pool inputs incorrectly. Try removing the panel, and adding it again with accurate information.


Q. Why is my wallet balance 0?

A. Double-check that you've entered your address information accurately. Note that cryptoGlance will never ask for private keys or any other sensitive information.


Q. Can I include cryptoGlance in my custom Linux distribution, or with hardware that I offer?

A. Yes, you may include it only in non-commercial distributions. If you wish to include it along with software or hardware that you sell, please get in touch with a channel operator in #cryptoGlance on Freenode IRC (use the chat widget on http://cryptoglance.info) to discuss.



We owe thanks to the following projects:

Hope you enjoy what we're trying to do here, and thanks to all of the other similar OSS projects like this for help and inspiration (we give extra special thanks to Anubis for that!).



Our Donation Addresses:

We've put a lot of our time and effort into cryptoGlance, and it hasn't been easy. We also wanted to make this tool free to everyone, however donations keep our fire lit, and more features/improvements coming out. If you like what we've built, or at least appreciate our efforts, please send code, or a donation to any of the following addresses:

Bitcoin
12PqYifLLTHuU2jRxTtbbJBFjkuww3zeeE

Reddcoin
RiJuGDb1e1SLVaTseHeMXMUrzhei2ex5AQ


/end README.md