p2pool-salvium/docs/COMMAND_LINE.MD

### P2Pool command line options

```
--wallet              Main wallet address (the one that starts with 4...). To mine to a subaddress of this wallet, use it together with --subaddress
--subaddress          Subaddress to mine to. It must belong to the same wallet that was specified with --wallet parameter
--host                IP address of your Monero node, default is 127.0.0.1
--rpc-port            monerod RPC API port number, default is 18081
--zmq-port            monerod ZMQ pub port number, default is 18083 (same port as in monerod's "--zmq-pub" command line parameter)
--stratum             Comma-separated list of IP:port for stratum server to listen on
--p2p                 Comma-separated list of IP:port for p2p server to listen on
--addpeers            Comma-separated list of IP:port of other p2pool nodes to connect to
--stratum-ban-time N  Number of seconds to ban misbehaving stratum client, default is 600
--light-mode          Don't allocate RandomX dataset, saves 2GB of RAM
--loglevel            Verbosity of the log, integer number between 0 and 6
--data-dir            Path to store general p2pool files (log, cache, peer data, etc.), default is current directory
--sidechain-config    Name of the p2pool sidechain parameters file (only use it if you run your own sidechain)
--data-api            Path to the p2pool JSON data (use it in tandem with an external web-server). Not affected by --data-dir setting!
--local-api           Enable /local/ path in api path for Stratum Server and built-in miner statistics
--stratum-api         An alias for --local-api
--no-cache            Disable p2pool.cache
--no-color            Disable colors in console output
--no-randomx          Disable internal RandomX hasher: p2pool will use RPC calls to monerod to check PoW hashes
--out-peers N         Maximum number of outgoing connections for p2p server (any value between 10 and 450)
--in-peers N          Maximum number of incoming connections for p2p server (any value between 10 and 450)
--start-mining N      Start built-in miner using N threads (any value between 1 and 64)
--mini                Connect to p2pool-mini sidechain. Note that it will also change default p2p port from 37889 to 37888
--nano                Connect to p2pool-nano sidechain. Note that it will also change default p2p port from 37889 to 37890
--no-autodiff         Disable automatic difficulty adjustment for miners connected to stratum (WARNING: incompatible with Nicehash and MRR)
--rpc-login           Specify username[:password] required for Monero RPC server
--socks5              Specify IP:port of a SOCKS5 proxy to use for outgoing connections
--no-dns              Disable DNS queries, use only IP addresses to connect to peers (seed node DNS will be unavailable too)
--p2p-external-port   Port number that your router uses for mapping to your local p2p port. Use it if you are behind a NAT and still want to accept incoming connections
--no-upnp             Disable UPnP port forwarding
--no-igd              An alias for --no-upnp
--upnp-stratum        Port forward Stratum port (it's not forwarded by default)
--merge-mine          IP:port and wallet address for another blockchain to merge mine with
--version             Print p2pool's version and build details
--tls-cert file       Load TLS certificate chain from "file" in the PEM format
--tls-cert-key file   Load TLS certificate private key from "file" in the PEM format
--rpc-ssl             Enable SSL on RPC connections to the Monero node
--rpc-ssl-fingerprint base64-encoded fingerprint of the Monero node's certificate (optional, use it for certificate pinning)
--no-stratum-http     Disable HTTP on Stratum ports
--full-validation     Enables full share validation / increases CPU usage
--onion-address       Tell other peers to use this .onion address to connect to this node through TOR
--no-clearnet-p2p     Forces P2P server to listen on 127.0.0.1 and to not connect to clearnet IPs
```

### Example command line

```
p2pool.exe --host 127.0.0.1 --rpc-port 18081 --zmq-port 18083 --wallet YOUR_WALLET_ADDRESS --stratum 0.0.0.0:3333 --p2p 0.0.0.0:37889
```

### Example command line (mining to a subaddress)

```
p2pool.exe --host 127.0.0.1 --wallet WALLET_MAIN_ADDRESS --subaddress SUBADDRESS_FROM_THE_SAME_WALLET
```

### Multiple backup hosts

You can have multiple hosts in command line. If P2Pool detects that the host it's currently using is down or stuck, it will cycle through hosts until it finds a working one. It will not switch back as long as the current host it found is working.

Each new host uses RPC and zmq-pub port numbers from the previous host (or default 18081/18083 if none were specified). Note that `--rpc-login`, `--rpc-ssl` and `--rpc-ssl-fingerprint` are not copied from the previous host, you must specify it for each host that has username/password or RPC-SSL enabled.

In the following example, you have local Monero host running on ports 18081/18083 (RPC/zmq-pub), and several backup hosts running on ports 18089/18084.


```
p2pool.exe --host 127.0.0.1 --host node.monerodevs.org --rpc-port 18089 --zmq-port 18084 --host node2.monerodevs.org --host node.richfowler.net --wallet YOUR_WALLET_ADDRESS
```

### Merge mining

Merge mining is available in P2Pool since the fork that happened on October 12th, 2024. Version 4.0 or newer is required to use it.

- Blockchains that will support [Merge mining RPC API](https://github.com/SChernykh/p2pool/blob/master/docs/MERGE_MINING.MD#proposed-rpc-api)
  - [Townforge](https://townforge.net/) supports it in their [tmp-mm branch](https://git.townforge.net/townforge/townforge/src/branch/tmp-mm) (not released yet)
  - [DarkFi](https://dark.fi/) is going to support it, but it's [not ready yet](https://github.com/darkrenaissance/darkfi/issues/244)
  ```
  p2pool.exe --wallet YOUR_MONERO_WALLET_ADDRESS --merge-mine IP:port YOUR_WALLET_ADDRESS_ON_ANOTHER_BLOCKCHAIN
  ```

### Tari merge mining

[Tari](https://www.tari.com/) uses their own gRPC API and requires a different command line:
```
./p2pool --wallet YOUR_MONERO_WALLET_ADDRESS --merge-mine tari://TARI_NODE_IP:18102 TARI_WALLET_ADDRESS
```
and on the Tari side
```
./minotari_node --grpc-enabled --mining-enabled
```
TARI_NODE_IP is 127.0.0.1 if you run both on the same machine (recommended).

Merge mining is available on Tari's mainnet:
- Download [Tari suite](https://github.com/tari-project/tari/releases/latest) for your OS
- Run Minotari node and wait until in synchronizes
- Run Minotari console wallet to create a Tari wallet
- Copy the interactive wallet address from the "Receive" tab of the wallet
- Paste it into the P2Pool command line above
- Everything is ready now to start merge mining Monero and Tari!

Note that Tari will be mined in solo mode (only full Tari blocks can be mined for now). This doesn't affect P2Pool payouts - they will stay the same.

### TLS

Starting from v4.1, P2Pool supports SSL/TLS connections to its Stratum port. Port 443 can also be safely used for Stratum connections since v4.1 - P2Pool will detect HTTP requests and respond to them.

All `--tls...` parameters are optional. If they are not provided, P2Pool will generate a self-signed certificate upon startup.

If you want to use your own certificate, please refer to your certificate provider's documentation (or OpenSSL documentation) on how to generate the appropriate PEM files.

Note that you need to use certificate files and `--tls...` parameters to be able to use certificate pinning in XMRig miners that connect to your P2Pool instance.

`--tls-cert` and `--tls-cert-key` parameters must always be used together.

### RPC-SSL

Starting from v4.4, P2Pool supports RPC-SSL connections to Monero nodes. Add `--rpc-ssl` to P2Pool command line to enable it.

P2Pool supports certificate pinning on RPC-SSL connections via `--rpc-ssl-fingerprint MONERO_NODE_FINGERPRINT_BASE64` parameter. To get your node certificate's fingerprint, run

```
openssl x509 -in rpc_ssl.crt -pubkey -noout -inform pem | openssl pkey -pubin -outform der | openssl dgst -sha256 -binary | openssl enc -base64
```

By default, `rpc_ssl.crt` can be found in Monero data directory: `/home/username/.bitmonero/rpc_ssl.crt` on Linux and `C:\ProgramData\bitmonero\rpc_ssl.crt` on Windows.


### Full validation

`--full-validation` is a boolean flag and will set the value to true; by default it is false to reduce CPU usage

Enable this if untrusted sources can submit shares to your p2pool server and you want to verify the validity of the shares PoW.  Increases CPU usage.
This option is for shared mining services, and not neccessary in local setups.