search

cryptoGlance / cryptoGlance-web-app

Self-hosted, PHP-based frontend interface for cgminer, MPOS pools, and other APIs, all in one responsive UI.
http://cryptoglance.github.io/cryptoGlance-web-app/
Other
68 stars 53 forks source link

readme

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:

NEW v2.0 Changes:

Requirements:

Windows Version:

Running from source:

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)\, 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:

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

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:

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:

Running from source:

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