Giter VIP home page Giter VIP logo

arpanel's Introduction

arPanel

arPanel is a mobile friendly web dashboard for Arweave pool mining using Virdpool miner.
Use this dashboard to control and monitor your miner's status and performance.

arPanel Miner Dashboard

Installation

Requirements

arPanel is not a standalone miner, it is simply a dashboard for Virdpool miner which is available here: Virdpool Miner
Follow the instructions to install the miner first. Then, follow the instructions below to setup arPanel.
arPanel has been tested and runs on Ubuntu 18.04 and Ubuntu 20.04.

Setup

IMPORTANT: Open a terminal, elevate priveleges and clone the arPanel repository inside the Virdpool miner directory.

sudo su
# cd miner
  1. Ensure you are in the directory where Virdpool miner is installed and do:
git clone https://github.com/wxt30/arpanel.git
cd arpanel
  1. Edit mine.sh using your favorite editor to set your WALLET where pool rewards will be sent. If you don't have one, get your own Arweave Web Extension Wallet.

  2. Optionally you can set your arweave data directory using the data_dir option. You need this if you have previously synced. And finally, do some performance tuning for better mining hashrate speeds. See the notes in mine.sh for tuning details.

Start & Stop arPanel

NOTE: You must stop Virdpool miner before using arPanel.

Start arPanel with ./arpanel-start.sh found in the arpanel directory.

Open a web browser to see your dashboard: http://your-rigs-ip:3030
You can also open/forward port 3030 and use your public ip: http://your-public-ip:3030
If needed, the port number can be changed in ./arpanel-start.sh

Stop arPanel with ./arpanel-stop.sh found in the arpanel directory.

Using arPanel

From the 'Miner Control' menu you have the option to 'Start Mining', 'Sync Only' or 'Stop' the Virdpool miner. If you are getting started now, it is advised to initially 'Sync Only' until you have a significant Arweave data set. Then you can switch to mining.

You should keep an eye on the logs for miner errors. Log files are saved in the arpanel/logs directory.

Arweave Node Log: arpanel/logs/arweave.log
Miner Proxy Log: arpanel/logs/proxy.log
arPanel Log: arpanel/logs/arpanel.log

Update arPanel

NOTE: Backup mine.sh first so you don't lose your miner settings.

Stop your Virdpool miner using arPanel. From the side menu click 'Miner Control' > 'Stop'.
Then using a terminal, move to the arPanel installation directory and do:

./arpanel-stop.sh
git pull

Edit mine.sh to set your mining WALLET and startup options.
Edit arpanel-start.sh to set your custom port, if needed.

Start arPanel.

./arpanel-start.sh

Start your Virdpool miner using arPanel. Open arPanel in a browser and from the side menu click 'Miner Control' and select either 'Sync Only' or 'Start Mining'.

FAQ

Q: Is arPanel free to use?
A: Yes, it is totally free.

Q: Is arPanel an Arweave miner?
A: No, arPanel is a dashboard for Virdpool miner, it is not a miner.

Q: Why are there ads in arPanel?
A: arPanel is free to use therefore ads helps us with development and support.

License

Copyright (c) 2021 arPanel

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

arpanel's People

Contributors

wxt30 avatar

Stargazers

David Kilcy avatar KZ avatar Vincent Jousse avatar

Watchers

James Chang avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.