Configurable Coin Support

README.md

@@ -1,32 +1,93 @@
-# zcash-cli-cockpit
+# zcash-cli-cockpit (equihash coins)
 
-zcash-cli cockpit plugin - a browser based wallet ui for zcash based coins
+zcash-cli cockpit plugin - a browser based wallet ui for zcash based coins (now multi-coin configurable)
 
 ## install cockpit
-Fedora Server comes with Cockpit installed.
 
-Installing Cockpit in Ubuntu 16.04  
-http://www.itzgeek.com/how-tos/linux/ubuntu-how-tos/install-cockpit-on-ubuntu-16-04.html
+Cockpit is a very useful web interface for server admins.
 
-Access cockpit at the following url: https://localhost:9090/
+Ubuntu 16.04
+
+    sudo apt-get install cockpit
 
-## install zcash
+Fedora Server
+
+    sudo dnf install cockpit
 
-https://z.cash/download.html
+Access cockpit at the following url: https://localhost:9090/
 
-Follow the <a target="_blank" href="https://github.com/zcash/zcash/wiki/1.0-User-Guide">Install Guide</a> to build zcash from source.
+## setup coin daemon wallet
 
-## prepare your linux system
-Login to your linux server with your regular user account to get started.
+This cockpit plugin requires the coin-cli binary to be in the executable path (/usr/bin).
 
-    nproc and pidof commands are required to be functioning by this plugin.
+    sudo ln -sr ./src/zcash-cli /usr/bin/zcash-cli
+
+Below is a cheet sheet for getting up and running for multiple coins.
 
-zcash-cli-cockpit plugin requires "zcash-cli" executable to be in your system path. It is possible to create a symbolic link to the "zcash-cli" binary.
+### zcash
 
-    cd zcash_git_checkout_dir
+    git clone https://github.com/zcash/zcash
+    cd zcash
+    git checkout master
+    ./zcutil/build.sh -j2
+
     sudo ln -sr ./src/zcash-cli /usr/bin/zcash-cli
 
-## installing zcash-cli-cockpit plugin
+### zclassic
+
+    git clone https://github.com/z-classic/zclassic
+    cd zclassic
+    git checkout master
+    ./zcutil/build.sh -j2
+
+    sudo ln -sr ./src/zcash-cli /usr/bin/zclassic-cli
+
+### zencash
+
+    git clone https://github.com/ZencashOfficial/zen
+    cd zen
+    git checkout master
+    ./zcutil/build.sh -j2
+
+    sudo ln -sr ./src/zen-cli /usr/bin/zen-cli
+
+### hush
+
+    git clone https://github.com/MyHush/hush
+    cd hush
+    git checkout master
+    ./zcutil/build.sh -j2
+
+    sudo ln -sr ./src/hush-cli /usr/bin/hush-cli
+
+### bitcoinz
+
+    git clone https://github.com/bitcoinz-pod/bitcoinz
+    cd bitcoinz
+    git checkout master
+    ./zcutil/build.sh -j2
+
+    sudo ln -sr ./src/zcash-cli /usr/bin/bitcoinz-cli
+
+### votecoin
+
+    git clone https://github.com/Tomas-M/VoteCoin
+    cd VoteCoin
+    git checkout master
+    ./zcutil/build.sh -j2
+
+    sudo ln -sr ./src/zcash-cli /usr/bin/votecoin-cli
+
+### komodo (work-in-progress)
+
+    git clone https://github.com/jl777/komodo
+    cd komodo
+    git checkout master
+    ./zcutil/build.sh -j2
+
+    sudo ln -sr ./src/komodo-cli /usr/bin/komodo-cli
+
+## installing zcash-cli-cockpit plugin   
 Cockpit will search ~/.local/share/cockpit/ directory for plugins.
 
     mkdir ~/.local/share/cockpit/
@@ -36,24 +97,42 @@ Change directory and clone the git repository.
     cd ~/.local/share/cockpit/
     git clone https://github.com/hellcatz/zcash-cli-cockpit
 
+Copy `config_example.js` to `config.js` and modify as needed.
+
+https://github.com/hellcatz/zcash-cli-cockpit/blob/multi-coin/config_example.js#L1-L7
 
 Upgrading? Since there is no official relase at this time, you must "pull" the lastest from "master" using git.
 
     cd ~/.local/share/cockpit/zcash-cli-cockpit
     git pull
 
 Open https://localhost:9090/ in your web browser and login to cockpit.
+
 Look for a new menu entry under "Tools" called "zcash-cli".
 
-# donate to project author hellcatz
+# multi-coin setup
 
-    ZEC -> t1Qecf6zPTwWQ8eEhMHrux65gPQVYjKVDdq
+Change name of menu label for alternate coin.
 
-    ZCL -> t1f1xRt73TWgVWJQEFAW6DLwKtwmQvFahrN
+https://github.com/hellcatz/zcash-cli-cockpit/blob/multi-coin/manifest.json#L6
 
-    KMD -> R9xUuaZcodTmeKFrKdNR25gKgoBE47Jt88
+Make sure to name your daemons and cli binaries unique! Example alternate coins below...
+
+    sudo ln -sr ./src/hush-cli /usr/bin/hush-cli
+    sudo ln -sr ./src/komodo-cli /usr/bin/komodo-cli
+    sudo ln -sr ./src/zcash-cli /usr/bin/zclassic-cli
+    sudo ln -sr ./src/zen-cli /usr/bin/zen-cli
+    sudo ln -sr ./src/zcash-cli /usr/bin/zcash-cli
+
+# donate to project author hellcatz
 
-    BTC -> 17v5jgu57wGKJnwkhVHvgYhbCVTFt9xXSN
+    Donate BTC: 17v5jgu57wGKJnwkhVHvgYhbCVTFt9xXSN
+    Donate ZEC: t1bBgVQMfak2LZfCVVk88BGV3Cgu4crE3Ci
+    Donate ZEN: znhGeka9zXmixvw6ufzGpcaSXcSACrjx5WZ
+    Donate HUSH: t1JiGEWQCZ4T8CyZzMC1PWLUjvk4TqWEXgn
+    Donate ZCL: t1f1xRt73TWgVWJQEFAW6DLwKtwmQvFahrN
+    Donate KMD: R9xUuaZcodTmeKFrKdNR25gKgoBE47Jt88
+    Donate BTCZ: t1MmkgcWyPuDQ8NkzfoKM8PUXTmjtofCSET
 
 <a target="_blank" href="http://z.cash/">z.cash</a> -> 
 <a target="_blank" href="https://github.com/zcash/zcash/blob/master/doc/payment-api.md">1.0 Payment API</a> |

config_example.js

@@ -0,0 +1,48 @@
+// Example Zcash Config
+var symbol = "ZEC"
+var zcashd = "zcashd";
+var zcashcli = "zcash-cli";
+var zcash_getinfo_rate = 60000;
+var explorer_transactions_url = "https://explorer.zcha.in/transactions/";
+
+// Example Zclassic Config
+//var symbol = "ZCL"
+//var zcashd = "zcashd";
+//var zcashcli = "zclassic-cli";
+//var zcash_getinfo_rate = 60000;
+//var explorer_transactions_url = "http://zclexplorer.org/tx/";
+
+// Example ZenCash Config
+//var symbol = "ZEN"
+//var zcashd = "zend";
+//var zcashcli = "zen-cli";
+//var zcash_getinfo_rate = 60000;
+//var explorer_transactions_url = "https://explorer.zen-solutions.io/tx/";
+
+// Example Hush Config
+//var symbol = "HUSH"
+//var zcashd = "hushd";
+//var zcashcli = "hush-cli";
+//var zcash_getinfo_rate = 60000;
+//var explorer_transactions_url = "http://explorer.myhush.org/tx/";
+
+// Example Komodo Config
+//var symbol = "KMD"
+//var zcashd = "komodod";
+//var zcashcli = "komodo-cli";
+//var zcash_getinfo_rate = 60000;
+//var explorer_transactions_url = "http://kmd.explorer.supernet.org/tx/";
+
+// Example BitcoinZ Config
+//var symbol = "BTCZ"
+//var zcashd = "zcashd";
+//var zcashcli = "bitcoinz-cli";
+//var zcash_getinfo_rate = 60000;
+//var explorer_transactions_url = "https://bitcoinz.ph/tx/";
+
+// Example VoteCoin Config
+//var symbol = "VOTE"
+//var zcashd = "zcashd";
+//var zcashcli = "votecoin-cli";
+//var zcash_getinfo_rate = 60000;
+//var explorer_transactions_url = "http://explorer.votecoin.site/tx/";