Skip to content
This repository has been archived by the owner. It is now read-only.
Permalink
Browse files

Updated README and LICENSE; Minor CSS changes to non-Dashboard pages

  • Loading branch information...
scar45 committed Apr 13, 2014
1 parent 203f27b commit 5a153ca418cb936a8ccbd0638bcfcc9db5f50969
Showing with 165 additions and 104 deletions.
  1. +54 −64 LICENSE
  2. +88 −37 README.md
  3. +22 −2 css/cryptoglance-base.css
  4. +1 −1 help.php
  5. BIN images/cryptoGlance-video-intro-landscape.png
118 LICENSE
@@ -1,10 +1,59 @@
GNU GENERAL PUBLIC LICENSE

cryptoGlance
Copyright (C) 2014 cryptoGlance Team

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

* Neither the name of cryptoGlance, nor the name PHP Desktop, nor the
name Google Inc. nor the name Chromium Embedded Framework nor the
names of its contributors may be used to endorse or promote products
derived from this software without specific prior written
permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

This product includes the following third party libraries:
* Chromium Embedded Framework licensed under the BSD 3-clause license.
See: https://code.google.com/p/chromiumembedded/
* PHP Software licensed under the PHP License 3.0.1.
See: http://www.php.net/software/
* Mongoose webserver revision 04fc209 licensed under the MIT license.
See: https://github.com/cesanta/mongoose/tree/04fc209644b414d915c446bb1815b55e9fe63acc
* JSON parser licensed under the BSD 2-clause license.
See: https://github.com/udp/json-parser

You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.


GNU GENERAL PUBLIC LICENSE
Version 2, June 1991

Copyright (C) 1989, 1991 Free Software Foundation, Inc., <http://fsf.org/>
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Copyright (C) 1989, 1991 Free Software Foundation, Inc., <http://fsf.org/>
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.

Preamble

@@ -278,62 +327,3 @@ PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.

END OF TERMS AND CONDITIONS

How to Apply These Terms to Your New Programs

If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.

To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
convey the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.

{description}
Copyright (C) {year} {fullname}

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

Also add information on how to contact you by electronic and paper mail.

If the program is interactive, make it output a short notice like this
when it starts in an interactive mode:

Gnomovision version 69, Copyright (C) year name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.

The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, the commands you use may
be called something other than `show w' and `show c'; they could even be
mouse-clicks or menu items--whatever suits your program.

You should also get your employer (if you work as a programmer) or your
school, if any, to sign a "copyright disclaimer" for the program, if
necessary. Here is a sample; alter the names:

Yoyodyne, Inc., hereby disclaims all copyright interest in the program
`Gnomovision' (which makes passes at compilers) written by James Hacker.

{signature of Ty Coon}, 1 April 1989
Ty Coon, President of Vice

This General Public License does not permit incorporating your program into
proprietary programs. If your program is a subroutine library, you may
consider it more useful to permit linking proprietary applications with the
library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License.
125 README.md
@@ -1,14 +1,13 @@
<br>

_[Skip to FAQ](#faq)_ &bull; <a href="http://cryptoglance.info/" rel="external">http://cryptoglance.info/</a>
_[Skip to FAQ](#faq)_ &bull; <a href="http://cryptoglance.info/" rel="external">http://cryptoglance.info</a>

----

## What is CryptoGlance?
### What is CryptoGlance?

Self-hosted, PHP-based frontend interface for cgminer, MPOS pools, and other APIs, all in one responsive UI. Protected with a login, but also offers a read-only/public view (if desired).

## Features:
### Features:

- Add multiple rigs which display data from cgminer
- Add multiple pools to watch that support MPOS frontends (ask your pool op if you're unsure, or look in their site's footer)
@@ -22,35 +21,35 @@ Self-hosted, PHP-based frontend interface for cgminer, MPOS pools, and other API
- Create exchange/conversion rate pairs that display fresh data
- Add your addresses to keep on top of their current balance (determined from the public blockchain)

## Requirements:
### Video Demo:

<a href="http://www.youtube.com/watch?v=5BBI8icIFuI" rel="external"><img src="images/cryptoGlance-video-intro-landscape.png" alt="cryptoGlance Video Thumb" /></a>

### Requirements:

- PHP v5.2+
- Apache or IIS
- cgminer / bfgminer / cudaminer / sgminer with API access allowed
- MPOS Mining Pool account with your API key (for certain pool stats -- ask your pool operatir)

## Installation:
### Installation:

#### How-to Video:
**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**, and you should be good to go.

[![IMAGE ALT TEXT HERE](http://img.youtube.com/vi/YOUTUBE_VIDEO_ID_HERE/0.jpg)](http://www.youtube.com/watch?v=YOUTUBE_VIDEO_ID_HERE)
**Windows App Users:**

#### Step-by-step Instructions:
1. <a href="https://sourceforge.net/projects/cryptoglance/files/latest/download" rel="external">Download the latest version of cryptoGlance</a> and run the setup executable to begin 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, and you should be good to go.
2. Read the information that appears in the installer carefully.

**Beginner Users:**
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 Program Files. 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*.

1. Install (if required) a web server such as Apache or Microsoft IIS.
1. If you're running Windows, and have neither IIS nor PHP installed, there is a simple tool from Microsoft called [Web Platform Installer](http://www.microsoft.com/web/downloads/platform.aspx) that can do this painlessly.
1. Windows/IIS users may also need to add the '.woff' MIME type, which has a value of 'application/font-woff'
4. You'll want to ensure you're running your mining application with API-Access enabled, here's an example excerpt from the .conf:

2. Setup a new site and point the home/root directory to this project.

You'll want to ensure you're running cgminer with API-Access enabled, here's an example excerpt from the .conf:
<br>

...
"api-allow" : "127.0.0.1,192.168.1.0/24",
"api-allow" : "127.0.0.1,192.168.1/24",
"api-listen" : true,
"api-mcast-port" : "4028",
"api-port" : "4028",
@@ -60,61 +59,113 @@ You'll want to ensure you're running cgminer with API-Access enabled, here's an

...and you should be good to go.

FAQ:
--
---

### 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. No private keys are requested, nor passwords stored, with exception to API keys, but they are excluded from source.
**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, and copy that somewhere safe.
**A.** Just look for the **/user_data** folder in the following locations, and copy it somewhere safe:

*Windows Version:*

- **{{ cG Install Dir }}\application\user_data**

*Running from source:*

- **{{ project root }}/user_data**

---

**Q. I cannot get CryptoGlance to run. What can I check?**

A. Getting CryptoGlance setup requires a tiny bit of knowledge relating to web servers that host PHP sites. Most often you can search for any specific errors you see, or try the following:
**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:
- **{{ cG 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:*

- Ensure that the **php_sockets** extension is loaded via **php.ini**
- Configure any firewalls/anti-virus to allow for your web server traffic (usually port 80)
- Confirm that PHP is installed and working properly
- Adjust any permissions which will allow for write access to the /user_data folder
- Ensure that the **php_sockets** extension is loaded via **php.ini**
- 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 / bfgminer / cudaminer / etc.) requires that API access is allowed. Please see the installation section above for the proper settings to use in your .conf or .bat files.

---

**Q. The CryptoGlance site loads, but no data or stats are displayed. Why?**
**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:

A. Your mining utility (cgminer / bfgminer / cudaminer / etc.) requires that API access is allowed. Please see the installation section above for the proper settings to use in your .conf or .bat files.
"api-allow" : "W:127.0.0.1,W:192.168.1/24",

---

**Q. Why is my wallet balance 0?**

A. Double-check that you've entered information accurately. Note that CryptoGlance will never ask for private keys or any other sensitive information.
**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?**

## We owe thanks to the following projects:
**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 <a href="http://cryptoglance.info/" rel="external">http://cryptoglance.info</a>) to discuss.

---

### We owe thanks to the following projects:

- [WebhostingHub Glyphs](http://www.webhostinghub.com/glyphs/)
- [PHP Markdown by Michel Fortin](http://michelf.ca/projects/php-markdown/)
- [Flat icon social media by Guilherme Spigolan](https://www.iconfinder.com/search/?q=iconset%3Aflat-icon-social-media)
- [PHP Desktop](http://code.google.com/p/phpdesktop/)
- [PHP Markdown by Michel Fortin](http://michelf.ca/projects/php-markdown/)
- [(elements of) PHPMailer](https://github.com/PHPMailer/PHPMailer)
- [Bootstrap CSS Framework](http://getbootstrap.com)

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:
---

### 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 a donation to any of the following 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
**Bitcoin**<br>
12PqYifLLTHuU2jRxTtbbJBFjkuww3zeeE

**Litecoin** == LKUceKGBJwcmL4uVykL9CzKjmEqo6Fcx9M
**Litecoin**<br>
LKUceKGBJwcmL4uVykL9CzKjmEqo6Fcx9M

**Vertcoin** == Vp9izfX1kM3BqGADtvan1Et5nBiU1s32Zp
**Vertcoin**<br>
Vp9izfX1kM3BqGADtvan1Et5nBiU1s32Zp

**Dogecoin** == D8bcNHYbkBDqwkvZKKpfu8oAyzqezJ5RvW
**Dogecoin**<br>
D8bcNHYbkBDqwkvZKKpfu8oAyzqezJ5RvW

---

/*end README.md*
@@ -82,6 +82,10 @@ hr {
border-style: solid none solid;
}

pre {
display: inline-block;
}

a, a:visited, a:hover, a i, a:hover i {
-webkit-transition: color 300ms ease-in-out !important;
-moz-transition: color 300ms ease-in-out !important;
@@ -1191,7 +1195,11 @@ a#dash-add-panel {
.full-content .panel-body {
font-size: 18px;
text-align: left;
padding: 0;
padding: 0 10px;
}

.full-content .panel-no-grid {
margin: 0 0 50px;
}

.panel-pool .panel-body {
@@ -1918,6 +1926,13 @@ a#dash-add-panel {
margin-bottom: 70px;
}

.full-content .panel-body {
padding: 0 20px;
}

.full-content .panel-no-grid {
margin: 0 20px 70px;
}

.panel-in-footer {
margin-bottom: 0px;
@@ -2072,7 +2087,12 @@ a#dash-add-panel {
-o-transition: none !important;
transition: none !important;
}


.full-content .panel-no-grid {
margin: 0 auto;
width: 60%;
}

.width-reading {
float: right;
font-weight: bold;
@@ -34,7 +34,7 @@

<div id="help-wrap" class="container sub-nav full-content">
<div class="markdown-body">
<div id="readme" class="panel panel-default">
<div id="readme" class="panel panel-default panel-no-grid">
<h1>cryptoGlance Help</h1>
<div class="panel-heading">
<h2 class="panel-title"><i class="icon icon-document"></i> README.md</h2>
Binary file not shown.

0 comments on commit 5a153ca

Please sign in to comment.
You can’t perform that action at this time.