bitmessage/README.md

Intro

PyBitmessage is a client of the Bitmessages P2P communication protocol used to send encrypted messages to another person or to many subscribers.

PyBitmessage client running as a daemon in docker container with XML-RPC API enabled.

Usage

The container generates a Bitmessage Deterministic Addresses based on a BITMESSAGE_SEED_PHRASE variable.

Here are some example snippets to help you get started creating a container.

docker-compose

version: "3"
services:
  pybitmessage:
    build:
      context: https://git.bitdeals.org/private/bitmessage.git
      dockerfile: ./docker/Dockerfile
    image: registry.bitdeals.org/bitmessage
    environment:
      - BITMESSAGE_API_USER=bitmessage_api_user
      - BITMESSAGE_API_PASSWORD=bitmessage_api_password
      - BITMESSAGE_SEED_PHRASE=bitmessage_seed_phrase
      - BITMESSAGE_SEED_ADDRESSES=1
      - BITMESSAGE_TTL=172800
      - BITMESSAGE_STOPRESENDINGAFTERXDAYS=60
    ports:
      - 8442:8442

docker cli

docker run -d \
  -e BITMESSAGE_API_USER=bitmessage_api_user \
  -e BITMESSAGE_API_PASSWORD=bitmessage_api_password \
  -e BITMESSAGE_SEED_PHRASE=bitmessage_seed_phrase \
  -e BITMESSAGE_SEED_ADDRESSES=1 \
  -e BITMESSAGE_TTL=172800 \
  -e BITMESSAGE_STOPRESENDINGAFTERXDAYS=60
  -p 8442:8442 \
  registry.bitdeals.org/bitmessage

Parameters

Container images are configured using parameters passed at runtime.

Parameter	Function
-p 8442	API port
-e BITMESSAGE_API_USER	XML-RPC API user. Default: bitmessage_api_user
-e BITMESSAGE_API_PASSWORD	XML-RPC API password. Default: bitmessage_api_password
-e BITMESSAGE_SEED_PHRASE	Create Deterministic Addresses password. Default: created randomly.
-e BITMESSAGE_SEED_ADDRESSES	Number of Deterministic Addresses to generate. Default: 1
-e BITMESSAGE_TTL	The expiration of newly send messages, in seconds. Default: 172800
-e BITMESSAGE_STOPRESENDINGAFTERXDAYS	Stop resending unreceived message after X days. Default: 60
-e BITMESSAGE_APIVARIANT	provides xml or json-RPC API. Default: legacy