Skip to content

Latest commit

 

History

History
89 lines (60 loc) · 2.74 KB

README.md

File metadata and controls

89 lines (60 loc) · 2.74 KB
Raw

Joinmarket Docker Container

gitlab pipeline status

What?

This automates the process for Joinmarket in a nice docker container.

Why?

  • Ease of use (Create and Restore Wallet should be automated, as well as being able to add and remove their own funds)
  • Everyone should run and use their full node to use. Your full node supports the network and supports your privacy
  • Everyone should mix and protect their privacy
  • Everyone should be able to be a market maker (fuck DEFI, bitcoin is the real DEFI)

Project Git Mirrors

Usage Notes

Environment variables

The following environment variables control the configuration for jm-entrypoint.sh

  • RPCUSER (bitcoin rpc user. default is lncm)
  • RPCPASS (bitcoin rpc pass. default is lncm)
  • RPCHOST (bitcoin rpc hostname. default is 127.0.0.1)
  • RPCPORT (bitcoin rpc port. default is 8332)
  • TORADDR (socks5 address for tor. default is 127.0.0.1)
  • TORPORT (socks5 port for tor. default is 9050)

Example Default Usage

Here is the example usage which uses the default entrypoint

docker run --rm  -it --network host \
        -v $HOME/.joinmarket:/data/.joinmarket \
        -v $HOME/.bitcoin:/data/.bitcoin \
        --name joinmarket \
        -e RPCPASS="btcrpcpassword" \
        -e RPCUSER="bitcoindrpcuser" \ 
        lncm/joinmarket:v0.8.0

Wallettool command

# Param can be 'generate' '--help' or the wallet filename (eg. wallet.jmdat)

PARAM='wallet.jmdat'

docker run --rm  -it --network host \
        -v $HOME/.joinmarket:/data/.joinmarket \
        -v $HOME/.bitcoin:/data/.bitcoin \
        --entrypoint="/joinmarket-clientserver/scripts/wallet-tool.py" \
        --name joinmarket \
        lncm/joinmarket:v0.7.2 $PARAM

Build Notes

Maintainer Notes

Github Action Environment Variables

  • DOCKER_USERNAME - (required) Username to access docker hub
  • DOCKER_PASSWORD - (required) Password associated with the username. Can be a token too.
  • DOCKER_HUB_USER - (required) docker hub username if DOCKER_USERNAME differs, in this case an organization. It can be the same too but its required
  • MAINTAINER_USER - (optional) Username for github to use Github Container Registry
  • MAINTAINER_TOKEN - (optional) Personal Access token for github which accesses Github Container Registry.

Building Notes

docker build -t lncm/joinmarket .

Inspecting the Container

docker run --rm --entrypoint="/bin/bash" -it lncm/joinmarket:v0.8.0