This repository currently contains the following applications:
- Pickaxe
Pickaxe is an open-source Java application that will extract metrics from cryptocurrency miners and upload them directly to Foreman.
You can find the documentation and getting started guides for pickaxe on the Foreman dashboard. Note: you must be logged in to view the dashboard and all guides.
At a high-level,
- Download pickaxe (latest).
- Unzip pickaxe.
- Add your API information from here to
conf/pickaxe.yml. - Start pickaxe.
- Add miners from your dashboard! :)
Pickaxe queries the APIs built into each miner (most have this, and most are enabled by default). If you're having trouble getting your miner to update, consult our documentation here - we've documented how every miner needs to be ran so pickaxe can connect to it.
- JDK version 8 (or higher)
- Apache Maven (only if building Pickaxe from sources)
To build the entire foreman-apps repository, which will build all of the Foreman applications:
From the top level of the repository:
$ mvn clean installUpon a successful build, you should see something similar to the following:
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 39.070 s
[INFO] Finished at: 2018-07-07T19:54:47-04:00
[INFO] Final Memory: 46M/494M
[INFO] ------------------------------------------------------------------------The application distributions can be found in the target/ folders. You'll only need one - pick the extension you prefer.
$ ls -la **/target | grep -E "\.(zip|tar)"
-rw-r--r-- 1 dan dan 9621049 Jul 7 19:54 foreman-pickaxe-1.0.0-SNAPSHOT-bin.tar.bz2
-rw-r--r-- 1 dan dan 9662936 Jul 7 19:54 foreman-pickaxe-1.0.0-SNAPSHOT-bin.tar.gz
-rw-r--r-- 1 dan dan 9669478 Jul 7 19:54 foreman-pickaxe-1.0.0-SNAPSHOT-bin.zip
$
Copyright © 2018, OBM LLC. Released under the GPL-3.0 License.