Coder Social home page Coder Social logo

cryptoglance / cryptoglance-web-app Goto Github PK

View Code? Open in Web Editor NEW
68.0 68.0 53.0 24.89 MB

Self-hosted, PHP-based frontend interface for cgminer, MPOS pools, and other APIs, all in one responsive UI.

Home Page: http://cryptoglance.github.io/cryptoGlance-web-app/

License: Other

PHP 74.18% CSS 13.77% Shell 0.04% JavaScript 9.18% Hack 2.84%

cryptoglance-web-app's Introduction

CRYPTOGLANCE HAS BEEN ARCHIVED

The Git repository will be left accessible in a read-only, archived state.


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.

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!)

NEW v2.0 Changes:

  • 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
  • [+POOL] Bitcoin Affiliate Network (http://mining.bitcoinaffiliatenetwork.com)
  • [+POOL] CkPool
  • [+POOL] Eligius
  • [+POOL] MagicPool
  • [+POOL] Multipool.Us
  • [+POOL] NOMP
  • [+COIN] NeosCoin
  • [+COIN] ReddCoin
  • [+COIN] PayCoin

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],

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.


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.


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!).


/end README.md

cryptoglance-web-app's People

Contributors

dchaykas avatar donaldsteele avatar owenvoke avatar scar45 avatar snypelife avatar stoyvo avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

cryptoglance-web-app's Issues

Antminer S9 Temp Fix? Please...

I saw Awesome Miner managed to show Bitmain Antminer S9 temperature. Is it still not possible to show the temp of an S9 in Cryptoglance? Is there a fix? I cannot find it.. I would be glad to make a donation if it can be fixed. Thank you.

ReddCoin balance not updating

The ReddCoin blockchain explorer has not updated their wallet to the latest fork. Currently no ReddCoin Blockchain explorer exist with API access

Update MPOS Pool URL Placeholder

Unfortunately coinhuntr has shut down their service. We will need to update the URL placeholder on the Add Pool modal. Purhaps vertsquad.com?

error popup at startup and at all refresh ...

HI,

since the last automatic update, I got this error from php-cgi : "il n'y a pas de disque dans le lecteur. Insérez un disque dans le lecteur \Device\Harddisk2\DR2" which will translate as : "The is no disk in the tray. Insert a disk in \Device\Harddisk2\DR2."

I did the upgrade by the automatic way, with nightly update ;)
I try to rename the web-cache folder with no success ...
I also tried to erase the cookies with no success .... HELP

I cannot use it anymore ...

Stéphane

update

autoupdate not working. keeps halting on ==> Creating temporary directory to download update and unzip: update/v2.0
==> ERROR: Failed to create the directory: update/v2.0

Feature Request - Move Module Positions

I realize that drag-and-drop module positions might not be easy, but is there a way a user can easily edit the module order? IE: Place pool API data at the top of the dashboard.

I would consider shuffling around some HTML/PHP easy, so maybe no work involved if you could give a place to start?

Thanks!

Missing "Manage" button on offline rigs

Should still be there so IPs / etc., can still be adjusted even if the rig is offline (possibly restoring the connection in the case of editing IP while offline)

BTCGarden ASICS

I am unable to get any API data from BTCGarden ASICS. Using Paxxil's cgminer_remote_monitoring and Selaux's miner-dashboard I am able to at least pull summary CGminer data, although no specific device information is available. This makes me think that it's not all Garden Asic's build of cgminer.

Please let me know how I can help.

Thank you!

Grid layout borked on refresh

The call to initMasonry() is seemingly not being run after a page refresh:

** Also appears that the Rig Panel is not respecting the max width (possibly due to new implementations in the table scroll?) **

image

Feature Request: iOS

For those of us with iOS devices, a native app or MobileMiner monitoring would be a nice :D

Antminer L3+ no Temp or Fan speed info.

I love the cryptoGlance app thus far but i have an issue connecting to the Antminer L3+ rig details page.
The overview works 100% and I can see the basic info but when I go to the manage details page it complains about a connection to the rig.

I think it requires access (username,password) to the rigs but don't where that should be configure.

I see from the change log Bitmain ASIC fan and Temp details are support but I have trouble accessing that.

Thank you.

Switching Pools causes Overview to reset

Steps:

  1. Click Manage btn on rig
  2. Click Switch Pool
  3. Select new pool, click Switch Pool green btn
  4. Watch overview panel....

Result:
Most of the time the overview panel removes all the rigs except the one you just switched pools on.

Expected:
Rigs to not disappear from overview panel.

Notification Center

Display an icon in the navbar that gets coloured/styled depending on if there are notifs.

Possible notifications later could be:

  • Update available
  • Payment received (when address balance changes)
  • Warning temp reached on Rig: N and Device: 3
  • etc.

Add Graphs

It'd be great to give the option to the user to choose their 'y-axis' stat (hashrate, work util, etc.), where the 'x-axis' will always be time.

Add more than 1 user + Read-Only public view

  • Enable the use of more than one user
  • Possibly allow other users to be READ ONLY
  • Properly handle the method to reset passwords/accounts if one already exists, but the 2nd+ account is created or needs to be reset

Feature Request: ASIC ID via serial number

As a suggestion to assist larger "farms" monitoring multiple ASIC units from a single controller unit, next to the "dev #" which ID's as "ASC0" (for example), include the ASIC serial number. I am aware that this is possible with Gridseed ASIC units, though I am not sure if this is possible with Zeus Miner ASIC units.

Thanks in advance!

Show total hashrate pref in Tools menu

This needs to actually work to toggle the total hashrate(s) which appear just under the navbar. Also, switch/checkbox needs to be reworked per other areas to have a better 'target' area.

image

Enable NMA Push Notifications

Possible alternatives:

Notify My Android is a sweet app/service that allows you to push updates via an API. We need to hook this into our notification system (e-mail, site icon like G+, etc.) to send alerts such as:

  • Rig is unreachable
  • Device temperature reached danger levels
  • etc.

We should create template segments for each possible notification type. @scar45 can design/handle these.

Also, the NMA API documentation is here: http://www.notifymyandroid.com/api.jsp

FAQs to add / Help / Installation Video + Guide

Setup a clean VM walking people through the steps for installing via IIS / Apache (XAMPP), using a VM of Win 7 (unactivated) with snapshots for reversing back to pre-web server install state

"Why is my wallet balance 0?"
"Well, you dont have any monies. Sorry"

"Why my shit no work?"
"You need to have PHP Short_Open_Tags set to 'On' in php.ini, and ensure the php_sockets.dll module is loaded as well.

"Is this secure?"
"Yes. Everything is running on your own server, and no private keys or passwords are stored, with exception to API keys, but they are not included in source."

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.