Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add(Docker): Docs for mining with Docker #7179

Merged
merged 3 commits into from
Jul 25, 2023
Merged

add(Docker): Docs for mining with Docker #7179

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7d1cc0a
Add docs for mining with Docker
upbqdn Jul 9, 2023
f4ec740
Refactor the docs for mining with Docker
upbqdn Jul 25, 2023
99fac15
Add a note on syncing
upbqdn Jul 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions book/src/SUMMARY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
- [zk-SNARK Parameters](user/parameters.md)
- [Mining](user/mining.md)
- [Testnet Mining with s-nomp](user/mining-testnet-s-nomp.md)
- [Mining with Zebra in Docker](user/mining-docker.md)
- [Kibana blockchain explorer](user/elasticsearch.md)
- [Troubleshooting](user/troubleshooting.md)
- [Developer Documentation](dev.md)
Expand Down
33 changes: 33 additions & 0 deletions book/src/user/mining-docker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Mining with Zebra in Docker

All [published images](https://hub.docker.com/r/zfnd/zebra/tags) containing the
`.experimental` suffix are compiled with the `getblocktemplate-rpcs` feature, so
you can use them for your mining operations. The images are pre-configured for
Testnet, and you must pass your rewards address as an environment variable to
the container when starting it. For example, executing

```bash
docker run -e MINER_ADDRESS="t27eWDgjFYJGVXmzrXeVjnb5J3uXDM9xH9v" -p 18232:18232 zfnd/zebra:v1.0.1.experimental
gustavovalverde marked this conversation as resolved.
Show resolved Hide resolved
```

will start a container on Testnet and bind port 18232 on your Docker host,
which is the standard Testnet RPC port. If you want to use a different port, you
can specify it in the `RPC_PORT` environment variable, as shown in the next
example. Also, notice that the address we used starts with the prefix `t2`,
indicating that it is a Testnet address. A Mainnet address would not work.

If you want to mine on Mainnet, you can execute the following command.

```bash
docker run -e NETWORK="Mainnet" -e RPC_PORT="8232" -e MINER_ADDRESS="t1XhG6pT9xRqRQn3BHP7heUou1RuYrbcrCc" -p 8232:8232 zfnd/zebra:v1.0.1.experimental
gustavovalverde marked this conversation as resolved.
Show resolved Hide resolved
```

Note that besides specifying the network, we also changed the port to 8232,
which is the standard RPC port for Mainnet. Also, the rewards address now begins
with the prefix `t1`, meaning it is a Mainnet P2PKH address. Please remember to
use your own rewards address.

Instead of listing the environment variables on the command line, you can use
Docker's `--env-file` flag to specify a file containing the variables. You can
find more info here
https://docs.docker.com/engine/reference/commandline/run/#env.