|
1 | 1 |  |
2 | 2 |
|
3 | | - |
4 | 3 | ## Development Status |
5 | 4 |
|
6 | | -[](https://github.com/gupax-io/gupax/actions/workflows/rust.yml) [](https://github.com/gupax-io/gupax/actions/workflows/audit.yml) |
7 | | - |
8 | | -This repository has a stable release. |
9 | | -It is intended for end users and offers a friendly and easy user experience, while allowing advanced users to use it for more complex setup. |
10 | | - |
11 | | -## Gupax |
12 | | - |
13 | | -`Gupax` is a GUI for mining [**Monero**](https://github.com/monero-project/monero) on a decentralized pool using [**P2Pool**](https://github.com/SChernykh/p2pool) and [**XMRig**](https://github.com/xmrig/xmrig). It also brings multiple features like running your own monero node, connecting your miners to a proxy and optionally participating (but you will want to 😉) in the [XMRvsBeast raffle](https://xmrvsbeast.com). |
14 | | - |
15 | | - |
16 | | - |
17 | | - |
18 | | -[](https://github.com/gupax-io/gupax/actions/workflows/rust.yml) [](https://github.com/gupax-io/gupax/actions/workflows/audit.yml) |
19 | | -</div> |
20 | | - |
21 | | -## Contents |
22 | | -* [Guide](#Guide) |
23 | | - - [System requirements](#system-requirements) |
24 | | - - [Basic setup](#Basic-Setup) |
25 | | - - [Documentation](#documentation) |
26 | | -* [Tabs](#Tabs) |
27 | | - - [Simple/Advanced](#simple-advanced) |
28 | | - - [About](#About) |
29 | | - - [Status](#Status) |
30 | | - - [Processes](#Processes) |
31 | | - - [P2pool](#P2Pool-1) |
32 | | - - [Benchmarks](#Benchmarks) |
33 | | - - [Gupax](#Gupax) |
34 | | - - [Node](#Node) |
35 | | - - [P2Pool](#P2Pool) |
36 | | - - [Crawler](#Crawler) |
37 | | - - [Proxy](#Proxy) |
38 | | - - [XvB](#XvB) |
39 | | -* [Daemon mode](#daemon-mode) |
40 | | -* [Troubleshooting](#troubleshooting) |
41 | | - - [Windows](#windows) |
42 | | - - [Mac OSX](#mac-osx) |
43 | | -* [FAQ](#FAQ) |
44 | | -* [License](#license) |
45 | | -* [Mirror](#mirror) |
46 | | -* [Donations](#donation) |
47 | | - |
48 | | -## Guide |
49 | | -### System requirements |
50 | | -- OS: Any [LTS version](https://wikipedia.org/wiki/Long-term_support) of: Windows, Linux, Mac OS |
51 | | -- CPU that support for OpenGL 3.0+/Vulkan/Metal/DX12 (not needed for daemon mode) |
52 | | -- Architecture: x86_64 for all, arm for macos, linux arm from compilation |
53 | | - |
54 | | - |
55 | | -### Video guide |
56 | | -See a 3-minute video guide on how to set-up Gupax |
57 | | -https://user-images.githubusercontent.com/101352116/207978455-6ffdc0cc-204c-4594-9a2f-e10c505745bc.mp4 |
58 | | - |
59 | | -More recent video by Anti MoonBoy: |
60 | | -https://www.youtube.com/watch?v=8_MOQHYRE1c |
61 | | - |
62 | | - |
63 | | -### Basic setup: |
64 | | - |
65 | | -1. [Download the bundled version of Gupax](https://github.com/gupax-io/gupax/releases) |
66 | | -2. Extract |
67 | | -3. Add exception from anti-virus (Windows/Max) |
68 | | -3. Launch Gupax |
69 | | -4. Input your Monero address in the `P2Pool` tab |
70 | | -6. Start P2Pool |
71 | | -7. Start XMRig |
72 | | - |
73 | | -You are now mining to your own instance of P2Pool, welcome to the world of decentralized peer-to-peer mining! |
74 | | - |
75 | | -### Documentation |
76 | | - |
77 | | -A more detailed documentation for advanced users and developers |
78 | | - |
79 | | -To come ! |
80 | | - |
81 | | -## Tabs |
82 | | -Each service tab can be hidden in the settings (Gupax tab). Only the `P2Pool` and `XMRig` tabs are enabled by default to make Gupax more simple to new users. |
83 | | -### Simple/Advanced |
84 | | -Each services offers a simple sub-menu (accessible on the bottom bar). The simple mode will start the service with default working out of the box settings. The advanced mode allows powerful users to configure each services to correspond to their needs. |
85 | | -### About |
86 | | -The About tab will show you a brief description of Gupax, along with the available shortcuts. |
87 | | - |
88 | | -### Status |
89 | | -This tab has three sub-menus. By default the `Processes` sub-menu will appear. |
90 | | -#### Processes |
91 | | -Monitoring of every services, as well as displaying resources usage of the system. You can hide the column of a service by checking the Gupax tab. |
92 | | - |
93 | | -#### Payouts |
94 | | -You can see rewards that you were paid. You also have a tool to calculate rewards based on your hashrate. The calculator needs P2Pool to be synced so it has the needed data up to date. |
95 | | - |
96 | | -#### Benchmarks |
97 | | -You can compare your CPU hashrate to the other CPUs of the same model, or even to other models. |
98 | | - |
99 | | -### Gupax |
100 | | -This tab is the settings tab, where you can update Gupax, set where are the binaries for each services, change startup options, the UI scaling, which tabs are hidden and more. |
101 | | - |
102 | | -### Node |
103 | | -Hidden by default. |
104 | | -You can start a local Monero Node in Gupax, or let it detect and use (if compatible with P2Pool) an already existing local node. |
105 | | - |
106 | | -### P2Pool |
107 | | -This is where you set your XMR addresse on which you will receive your rewards. The simple mode will allow you to choose between using a local node or a remote node. |
108 | | -Remote nodes are found by crawling the network. Gupax will do it automatically on startup, so you don't have to wait to start P2Pool. If the Node service is synced, P2Pool will switch to it by default. |
109 | | - |
110 | | -#### Crawler |
111 | | -The crawler tab will allow you to tweak the filter of selected remote nodes to connect with P2Pool. For example, you can try to find nodes with a lower latency at the cost of a longer search. |
112 | | - |
113 | | -### XMRig |
114 | | -The service that will start the mining locally. You can set a number of threads if you don't want all the power of your CPU to be dedicated to mining. |
115 | | - |
116 | | -### Proxy |
117 | | -Hidden by default. |
118 | | -Use this tab if you want to connect external miners to this instance of Gupax. In case you are participating in the XvB raffle, it will redirect all the hashrate at the decision of the XvB algorithm. |
119 | | - |
120 | | -### XvB |
121 | | -Hidden by default. |
122 | | -Use this tab to easily split your hashrate between P2Pool and XMRvsBeast, increasing your chances of winning in the raffle while also supporting the Monero network via decentralizing the mining using using p2pool. |
123 | | -[Register](https://xmrvsbeast.com/cgi-bin/p2pool_bonus_submit.cgi) the same XMR address that you use in the P2Pool tab to participate. |
124 | | -The simple mode will calculate which round you can access based on your current hashrate. The advanced tab allows you to have more manual controls. |
125 | | - |
126 | | - |
127 | | -## Daemon mode |
128 | | -Gupax can be started as a daemon, without any GUI (intended for CLI only environment). |
129 | | -To do so, start the executable with the argument `--daemon`. |
130 | | -The daemon is configurable by the same configuration file that is used by the normal GUI mode that you can find in the following path depending on your OS |
131 | | -| | | | |
132 | | -| ---------- | -------------------------------------------- | ------------------------------------------------| |
133 | | -| Linux | $XDG_DATA_HOME or $HOME/.local/share/gupax | /home/alice/.local/state/gupax | |
134 | | -| macOS | $HOME/Library/Application Support/Gupax | /Users/Alice/Library/Application Support/Gupax | |
135 | | -| Windows | {FOLDERID_RoamingAppData}\Gupax | C:\Users\Alice\AppData\Roaming\Gupax | |
136 | | - |
137 | | - |
138 | | -Once started, you can enter the key 's' to print the status of started processes. |
139 | | - |
140 | | - |
141 | | -## Troubleshooting |
142 | | -If you have any issue, feel free to ask for support in the [xmrvsbeast matrix room ](#xmrvsbeast:monero.social) [](https://matrix.to/#/#xmrvsbeast:monero.social) or you can also just [open an issue ](https://github.com/Cyrix126/gupax/issues/new/choose) in this repo. You can also contact me through [email ](mailto:[email protected]). |
143 | | -### Windows |
144 | | -You must add an exception to your antivirus for the directory where Gupax is executed. Follow the step for Windows only, that starts at 30 seconds in this [video](https://user-images.githubusercontent.com/101352116/207978455-6ffdc0cc-204c-4594-9a2f-e10c505745bc.mp4). |
145 | | -### Mac OSX |
146 | | -You must remove Gupax app from quarantine with following command: |
147 | | -*If you have put Gupax.app in your Applications* |
148 | | -`xattr -d com.apple.quarantine /Applications/Gupax.app` |
149 | | -### P2Pool connection errors |
150 | | -**TL;DR: Run & use your own Monero node.** |
151 | | - |
152 | | -If you are using the [default P2Pool settings](#P2Pool) then you are using a [Remote Monero node](#remote-monero-nodes) that was found by crawling. Using a remote node is convenient but comes at the cost of privacy and reliability. You may encounter connections issues with theses nodes that look like this: |
153 | | -``` |
154 | | -2023-01-05 12:27:37.7962 P2PServer peer 23.233.96.72:37888 is ahead on mainchain (height 2792939, your height 2792936). Is your monerod stuck or lagging? |
155 | | -``` |
156 | | - |
157 | | -``` |
158 | | -P2Pool get_info RPC request to host 157.173.123.245:RPC 18089:ZMQ 18084 failed: Error (empty response), trying again in 1 second |
159 | | -``` |
160 | | - |
161 | | -P2Pool should switch to a backup node in these case, but if all the backup nodes fails, P2Pool will also fail. |
162 | | - |
163 | | -To fix this you can start your own local node by using the [Node](#node) tab. |
164 | | - |
165 | | -Running and using your own local Monero node improves privacy and ensures your connection is as stable as your own internet connection. This comes at the cost of downloading and syncing Monero's blockchain yourself (currently 100GB pruned). If you have the disk space, consider using the [Node](#node) tab and connecting to your own Monero node. |
166 | | -See this [issue](https://github.com/gupax-io/gupax/issues/51). |
167 | | - |
168 | | -## FAQ |
169 | | - |
170 | | - |
171 | | -### Where are updates downloaded from? |
172 | | -The latest versions are downloaded using GitHub's API. |
173 | | -* Gupax [`https://github.com/gupax-io/gupax`](https://github.com/gupax-io/gupax) |
174 | | -### Can I quit mid-update? |
175 | | -If you started an update, you should let it finish. If the update has been stuck for a *long* time, quitting Gupax is probably okay. The worst that can happen is that your `Gupax/Node/P2Pool/XMRig/Proxy` binaries may be moved/deleted. Those can be easily redownloaded. Your actual `Gupax` user data (settings, custom nodes, pools, etc) is never touched. |
176 | | - |
177 | | -Although Gupax uses a temporary folder (`gupax_update_[A-Za-z0-9]`) to store temporary downloaded files, there aren't measures in place to revert an upgrade once the file swapping has actually started. If you quit Gupax anytime before the `Upgrading packages` phase (after metadata, download, extraction), you will technically be safe but this is not recommended as it is risky, especially since these updates can be very fast. |
178 | | - |
179 | | -### Bundled vs Standalone |
180 | | -`Bundled` Gupax comes with the latest version of Node/P2Pool/XMRig/Proxy already in the `zip/tar`. |
181 | | - |
182 | | -`Standalone` only contains the Gupax executable. |
183 | | - |
184 | | -### How much memory/cpu does Gupax use? |
185 | | -#### Memory |
186 | | -It is using about 10 megabytes of memory on x86_64 |
187 | | - |
188 | | -#### CPU |
189 | | -On a Thinkpad T440 with a i5-4300U (2013), it uses about 0.5% of the CPU when unfocused. |
190 | | -When interacted (mouse moving over the window), it will uses about 4.5% CPU (because of [immediate mode](wikipedia.org/wiki/Immediate_mode_(computer_graphics)) which allows a very fast reaction). |
191 | | - |
192 | | -### How is sudo handled? (on macOS/Linux) |
193 | | -[See here for more info.](./SUDO.md) |
194 | | - |
195 | | -### Why does Gupax need to be Admin? (on Windows) |
196 | | -[See here for more info.](./ADMIN.md) |
197 | | - |
198 | | -## License |
199 | | - |
200 | | - |
201 | | - |
202 | | -[Gupax](./LICENSE), [P2Pool](https://github.com/SChernykh/p2pool/blob/master/LICENSE), [XMRig](https://github.com/xmrig/xmrig/blob/master/LICENSE) and [XMRig-Proxy](https://github.com/xmrig/xmrig-proxy/blob/master/LICENSE) are licensed under the GNU General Public License v3.0. |
203 | | - |
204 | | -[Monerod](https://github.com/monero-project/monero) [licence](https://github.com/monero-project/monero?tab=License-1-ov-file) |
205 | | - |
206 | | -[See the licenses of various dependencies.](./Cargo.toml) |
207 | | - |
208 | | -## Mirror |
209 | | -In case Github repository is down, you can still find the source code at [librejo](https://librejo.monerodevs.org/Ecosystem/gupaxx) |
210 | | - |
211 | | -## Donations |
212 | | -If you'd like to thank me for the development of Gupax and/or motivate me to improve it you're welcome to send any amount of XMR to the following address: |
213 | | - |
214 | | - |
215 | | -``` |
216 | | -4AGJScWSv45E28pmwck9YRP21KuwGx6fuMYV9kTxXFnWEij5FVEUyccBs7ExDy419DJXRPw3u57TH5BaGbsHTdnf6SvY5p5 |
217 | | -``` |
218 | | - |
219 | | -Every donations will be converted to hours of work ! |
220 | | - |
221 | | -### Donation transparency |
222 | | - |
223 | | -A Kuno page exist so you can easily keep track of the amount funded in this project. |
224 | | -[Gupax Kuno](https://kuno.anne.media/fundraiser/dsrr/) |
225 | | -In case you don't want to rely on the kuno website, the secret view key is: |
| 5 | +Project has been moved to [Gupax](https://github.com/gupax-io/gupax) |
| 6 | +See context: https://github.com/gupax-io/gupax/issues/137 |
226 | 7 |
|
227 | | -``` |
228 | | -6c6f841e1eda3fba95f2261baa4614e3ec614af2a97176bbae2c0be5281d1d0f |
229 | | -``` |
| 8 | +If you are using Gupaxx, you will be able to update from the Gupaxx tab when Gupax v2 will come out |
0 commit comments