diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..00a3413 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +.env +docker-compose.yml \ No newline at end of file diff --git a/README.md b/README.md index a8fa7b9..d542e3c 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,37 @@ **xmr.sh** script wizard sets up a new server running a monero node daemon with Docker compose, with your choice of SSL certificates for your domain, network selection, a Tor hidden service, Grafana dashboard and more. +## Getting Started + +The most important files are: + +* `.env` - where your configurations/secrets are kept +* `docker-compose.yml` - where your Docker container options are defined + +This repo provides example files for you to copy and modify to suit your deployment needs. To get started, simply copy those files and modify as needed. + +```bash +# Update configurations/secrets/settings +cp env-example .env +vim .env + +# Update Docker containers - uncomment services to run additional helpers +cp docker-compose-example.yml docker-compose.yml +vim docker-compose.yml +``` + +Once those files are present, use `docker-compose` to launch your containers. + +```bash +docker-compose up -d # start and daemonize (background) all containers + +docker-compose logs -f # tail all logs + +docker-compose logs -f monerod # tail individual container logs (here monerod) + +docker-compose down # stop containers +``` + ## Distribution support Compatible and tested on: diff --git a/docker-compose.yml b/docker-compose-example.yml similarity index 99% rename from docker-compose.yml rename to docker-compose-example.yml index 368b5c4..1e13dca 100644 --- a/docker-compose.yml +++ b/docker-compose-example.yml @@ -212,7 +212,7 @@ services: ports: - "${MONEROD_P2P_PORT}:${MONEROD_P2P_PORT}" # Exposes P2P port volumes: - - "./data/monero:/home/monero/.bitmonero" + - "${MONEROD_DATA_DIR}:/home/monero/.bitmonero" labels: - "traefik.enable=true" # - "traefik.http.routers.monerod.rule=(Host(`${DOMAIN}`) && PathPrefix(`/`))" #!le diff --git a/.env b/env-example similarity index 84% rename from .env rename to env-example index efb135f..c5c4627 100644 --- a/.env +++ b/env-example @@ -1,10 +1,10 @@ DOMAIN=your-domain.xmr.example TRAEFIK_TAG=2.7 -TRAEFIK_ACME_EMAIL=your-email@xmr.example +TRAEFIK_ACME_EMAIL=lza_menace@protonmail.com TRAEFIK_LOGLEVEL=DEBUG -TRAEFIK_TLS_PORT=443 -TRAEFIK_HTTP_PORT=80 +TRAEFIK_TLS_PORT=4443 +TRAEFIK_HTTP_PORT=8000 MONEROD_TAG=latest MONEROD_RPC_PORT=18081 @@ -14,6 +14,7 @@ MONEROD_ZMQ_RPC_PORT=18082 MONEROD_ZMQ_PUB_PORT=18083 MONEROD_EXTRA_PARAMS= MONEROD_accessControlAllowOriginList=* +MONEROD_DATA_DIR=./data/monero LWS_TAG=v0.2_0.18 LWS_PORT=8000