docker-scripts/linux/ecosystem/monero/monerod/README.md

85 lines
4.2 KiB
Markdown
Raw Normal View History

2022-09-05 18:44:55 +03:00
# Simple Monerod Docker
A simple and straightforward Dockerized monerod built from source and exposing standard ports.
## Actions
[![Weekly Update Rebuild](https://github.com/sethforprivacy/simple-monerod-docker/actions/workflows/update-base-image.yml/badge.svg)](https://github.com/sethforprivacy/simple-monerod-docker/actions/workflows/update-base-image.yml)
[![Latest Dockerfile build on push](https://github.com/sethforprivacy/simple-monerod-docker/actions/workflows/update-image-on-push.yml/badge.svg)](https://github.com/sethforprivacy/simple-monerod-docker/actions/workflows/update-image-on-push.yml)
## Docker
![Docker Pulls](https://img.shields.io/docker/pulls/sethsimmons/simple-monerod)
![Docker Image Size (tag)](https://img.shields.io/docker/image-size/sethsimmons/simple-monerod/latest)
![Docker Image Version (latest by date)](https://img.shields.io/docker/v/sethsimmons/simple-monerod)
## Docker Hub
This repo is used to build the images available at:
https://hub.docker.com/r/sethsimmons/simple-monerod
## Tags
I will always release the latest Monero version under the `latest` tag as well as the version number tag (i.e. `v0.18.0.0`).
`latest`: The latest tagged version of Monero from https://github.com/monero-project/monero/tags, built on an Alpine base image
`vx.xx.x.x`: The version corresponding with the tagged version from https://github.com/monero-project/monero/tags, built on an Alpine base image
Note that the primary focus and images are using the Alpine base image, but I will continue to support the Ubuntu based image for now.
## Recommended usage
I am using this container for my guide on running a Monero node:
https://sethforprivacy.com/guides/run-a-monero-node/
The ways I would generally recommend running this container for a personal or public Monero node are below.
monerod Docker w/o public RPC:
```bash
sudo docker run -d --restart unless-stopped --name="monerod" -v bitmonero:/home/monero/.bitmonero sethsimmons/simple-monerod:latest --rpc-restricted-bind-ip=0.0.0.0 --rpc-restricted-bind-port=18089 --no-igd --no-zmq --enable-dns-blocklist
```
monerod Docker w/ public RPC:
```bash
sudo docker run -d --restart unless-stopped --name="monerod" -v bitmonero:/home/monero/.bitmonero sethsimmons/simple-monerod:latest --rpc-restricted-bind-ip=0.0.0.0 --rpc-restricted-bind-port=18089 --public-node --no-igd --no-zmq --enable-dns-blocklist
```
monerod Docker w/o public RPC (pruned):
```bash
sudo docker run -d --restart unless-stopped --name="monerod" -v bitmonero:/home/monero/.bitmonero sethsimmons/simple-monerod:latest --rpc-restricted-bind-ip=0.0.0.0 --rpc-restricted-bind-port=18089 --no-igd --no-zmq --enable-dns-blocklist --prune-blockchain
```
monerod Docker w/ public RPC (pruned):
```bash
sudo docker run -d --restart unless-stopped --name="monerod" -v bitmonero:/home/monero/.bitmonero sethsimmons/simple-monerod:latest --rpc-restricted-bind-ip=0.0.0.0 --rpc-restricted-bind-port=18089 --public-node --no-igd --no-zmq --enable-dns-blocklist --prune-blockchain
```
## Running as a different user
In situations where you need the daemon to be run as a different user, I have added [fixuid](https://github.com/boxboat/fixuid) to enable that. Much of the work for this was taken from [docker-monero](https://github.com/cornfeedhobo/docker-monero), and enables you to specify a new user/group in your `docker run` or `docker-compose.yml` file to run as a different user.
- In `docker run` commands, you can specify the user like this: `--user 1000:1000`
- In `docker-compose.yml` files, you can specify the user like this: `user: ${FIXUID:-1000}:${FIXGID:-1000}`
A great use-case for this is running with the daemon's files stored on an NFS mount, or running monerod on a Synology NAS.
## Copyrights
Code from this repository is released under MIT license. [Monero License](https://github.com/monero-project/monero/blob/master/LICENSE), [@leonardochaia License](https://github.com/leonardochaia/docker-monerod/blob/master/LICENSE)
## Credits
The base for the Dockerfile was pulled from:
https://github.com/leonardochaia/docker-monerod
The migration to Alpine from a Ubuntu 20.04 base image was based largely on previous commits from:
https://github.com/cornfeedhobo/docker-monero