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

Update README to note that the project has been abandoned

  • Loading branch information...
scar45 committed Oct 13, 2019
1 parent 3064da2 commit 7881b57477bf31e3286023652ef5e41e17364488
Showing with 11 additions and 74 deletions.
  1. +11 −74 README.md
@@ -1,14 +1,14 @@
<br>
# CRYPTOGLANCE HAS BEEN ARCHIVED

_[Skip to **FAQs**](#faq)_ &bull; _[Skip to **Changelog**](#changelog)_ &bull; <a href="http://cryptoglance.info/" rel="external">http://cryptoglance.info</a>
### The Git repository will be left accessible in a read-only, archived state.

----

<img src="images/cryptoGlance-thread-header.png" alt="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 <a href="https://play.google.com/store/apps/details?id=com.scar45.cryptoGlance" rel="external">Android companion app</a> which connects to your cryptoGlance installation remotely (it's much the same as using your mobile browser, but acts as a form of donation).
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:

@@ -45,12 +45,9 @@ cryptoGlance is an open-source, self-hosted PHP webapp providing you with a glan
</li>
<li>Configurable warning and danger status with visual cues</li>
<li>Void of malware or donation mining (does <strong>NOT</strong> require your private keys at all -- code is open source!)</li>
<li>Companion <a href="https://play.google.com/store/apps/details?id=com.scar45.cryptoGlance" rel="external">Android app</a> which easily allows you to quickly access your cryptoGlance instance while on the go</li>
<li><strong>MUCH MORE is planned!</strong> Follow our social accounts, or drop by our IRC channel to find out when new features are released!</li>
</ul>

### **NEW** v2.0 Changes:
**Recently Added Features:**
<ul>
<li>Total Hashrates are now categorized by Rig Algorithms used</li>
<li>Enable/Disable Total Hashrate via Tools dropdown</li>
@@ -72,28 +69,20 @@ cryptoGlance is an open-source, self-hosted PHP webapp providing you with a glan
<li>Ability to reset rig stats on pool change</li>
<li>New FIAT conversions for most coins (Thanks to FunkyC: <a href="https://firstrally.com/" rel="external">https://firstrally.com/</a>)</li>
<li>New debug command to see raw miner data: CTRL + D</li>
</ul>
**Recently Added Features:**
<ul>
<li>[+POOL] Bitcoin Affiliate Network (<a href="http://mining.bitcoinaffiliatenetwork.com/" rel="external">http://mining.bitcoinaffiliatenetwork.com</a>)</li>
<li>[+POOL] CkPool</li>
<li>[+POOL] Eligius</li>
<li>[+POOL] MagicPool</li>
<li>[+POOL] Multipool.Us</li>
<li>[+POOL] NOMP</li>
</ul>
**Recently Added Coins:**
<ul>
<li>[+COIN] NeosCoin</li>
<li>[+COIN] ReddCoin</li>
<li>[+COIN] PayCoin</li>
</ul>

### Video Demo:

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

### Requirements:
## Requirements:

- cgminer / sgminer properly configured with API access allowed

@@ -107,24 +96,18 @@ cryptoGlance is an open-source, self-hosted PHP webapp providing you with a glan
- Apache / IIS / mongoose, or whichever web server you prefer
- php_sockets extension enabled in PHP

<br>

---

### Installation:
## Installation:

_**Advanced Users:**_

Simply setup a new PHP instance and point it to the root folder of the <a href="https://github.com/cryptoGlance/cryptoGlance-web-app" rel="external">cryptoGlance source/download</a>. 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.

<br>

_**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.

<br>

_**Windows App Users:**_

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.
@@ -135,17 +118,13 @@ _**Windows App Users:**_

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:

<br>

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

...and you should be good to go.

<br>
```

---

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

@@ -157,36 +136,16 @@ Next, you'll need to **Enable cryptoGlance Updates** on the Settings page. Then,
- **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.

<br>

_**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 <a href="https://sourceforge.net/projects/cryptoglance/files/latest/download" rel="external">check for the latest version on SourceForge</a> 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.

<a name="changelog"></a>

<br>

---

### Changelog:

With every major **Release**, <a href="changelog.php">we include a concise changelog</a> of all updates contained within. Alternatively, you can check out our live commits if you are running Beta or Nightlies:

- View the <a href="https://github.com/cryptoGlance/cryptoGlance-web-app/blob/beta/CHANGELOG.md" rel="external">Live **Beta** changelog</a>
- View the <a href="https://github.com/cryptoGlance/cryptoGlance-web-app/blob/nightly/CHANGELOG.md" rel="external">Live **Nightly** changelog</a>

<a name="faq"></a>

_* 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._

<br>
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:
## FAQ:

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

@@ -270,14 +229,6 @@ The **Run from Source** version is for users who know how to setup a (simple) PH

---

**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 <a href="http://cryptoglance.info/" rel="external">http://cryptoglance.info</a>) to discuss.

<br>

---

### We owe thanks to the following projects:

- [WebhostingHub Glyphs](http://www.webhostinghub.com/glyphs/)
@@ -289,20 +240,6 @@ The **Run from Source** version is for users who know how to setup a (simple) PH

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

<br>

---

### 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**<br>
<small>12PqYifLLTHuU2jRxTtbbJBFjkuww3zeeE</small>

**Reddcoin**<br>
<small>RiJuGDb1e1SLVaTseHeMXMUrzhei2ex5AQ</small>

---

/*end README.md*

0 comments on commit 7881b57

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