Ecosystem/gupaxx
1
0
Fork 0
mirror of https://github.com/Cyrix126/gupaxx.git synced 2024-11-16 15:27:46 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

feat: update doc for xmrig-proxy

Browse source
This commit is contained in:
Cyrix126 2024-06-28 11:06:14 +02:00
parent 09e1e50ca1
commit 10b63c6b27
2 changed files with 10 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
DIFFERENCES.md
View file

@ -1,12 +1,18 @@
# Differences with upstream [Gupax](https://github.com/hinto-janai/gupax)
## Integration of the XvB Raffle
## Added functionalities
### Integration of the XvB Raffle
A new fancy tab to apply an algorithm of distribution of HR to xmrig (see [NOTES_ALGORITHM](NOTES_ALGORITHMS)) with your token from XvB.
This tab also includes a console output to let you track if everything is working and what are the decision of the algorithm, and show you personal stats from XvB.
A new column in Status Tab to see public stats from the raffle.
### Xmrig-Proxy
You can now point all your external miners and get all the juicy stats in Gupaxx. XvB algorithm is able to control Xmrig-Proxy when it is enabled.
## Removed functionality
Updates by tor. The version of the crate used was outdated, plagued with security concerns and bloated the binary.

26
NOTES_XMRIG-PROXY.md
View file

@ -10,31 +10,11 @@ Allows a user to point his miners on the Gupaxx instance.
## UI implementation
It is not useful to someone who have only one miner, so it needs to be manually enabled.
Tab to start Xmrig-Proxy, interact with console output and give custom options.
Message on Xmrig tab indicating xmrig is automatically redirected to it.
Local ip will be displayed.
Button to fetch public ip to know at which one to point miner at.
Status column of xmrig is replaced by xmrig-proxy when it is enabled.
Xmrig-proxy will display stats for each miners.
New Tab to start Xmrig-Proxy, interact with console output, give custom options, select a pool from the pool list.
New process column in Status Tab for Xmrig-Proxy.
## Technical implementation
xmrig-proxy will mine on p2pool instead of xmrig.
When xmrig-proxy is enabled, xmrig is automatically redirected to it instead of p2pool.
XvB algo will check if xmrig-proxy is enabled and watch/control his data instead.
## TODO
- [x] State
- [x] Helper thread
- [x] impl Helper
- [x] UI
- [x] interaction with xmrig
- [ ] advanced tls, keep alive, ip port
- [ ] info about ip and firewall
- [ ] status tab
- [ ] interaction with xvb
XvB algo will check if xmrig-proxy is enabled and watch/control his data instead of xmrig.