T

Build docker image and push to registry.bitdeals.org / main-build-job (push) Successful in 27s

Details

docs: Russian README, cross-linked, with the examples fixed

Same pairing the bitdeals-ng repositories use: each file points at the
other under its first heading, and both examples are byte-identical across
the two so they cannot drift.

The examples were not safe to copy. They published the API on every
interface next to the default credentials it documents, carried no volume
-- so keys.dat, the node's Bitmessage identity, was lost on every image
update -- and the docker run one was missing a line continuation and did
not run at all. Ports are now on loopback, the volume is there, and the
run was checked verbatim on a host.

Also: stopresendingafterxdays is documented as 30, which is what run.sh
actually defaults to, not 60; the seed phrase is noted as regenerated per
start; and a short Notes section records what cost time to find out -- '%'
is unusable in the API password, clients have to percent-encode
credentials, and the health check waits for a network connection.

2026-08-02 13:52:05 +00:00

.gitea/workflows

add act_runner build job

2026-03-18 11:42:32 +03:00

docker

escape the sed replacements, and stop the script failing silently

2026-08-02 13:13:56 +00:00

docker-compose.yml

add registry

2025-03-19 14:12:45 +03:00

README.md

docs: Russian README, cross-linked, with the examples fixed

2026-08-02 13:52:05 +00:00

README.ru-RU.md

docs: Russian README, cross-linked, with the examples fixed

2026-08-02 13:52:05 +00:00

README.md

Intro

Русская версия: README.ru-RU.md

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.

This repository covers the docker deployment only.

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.

The XML-RPC API controls the daemon completely and has no TLS. Set your own credentials and keep the port on loopback.

docker-compose

services:
  pybitmessage:
    build:
      context: https://git.bitdeals.org/private/bitmessage.git
      dockerfile: ./docker/Dockerfile
    image: registry.bitdeals.org/bitmessage
    environment:
      - BITMESSAGE_API_USER=CHANGE_ME
      - BITMESSAGE_API_PASSWORD=CHANGE_ME
      - BITMESSAGE_SEED_PHRASE=bitmessage_seed_phrase
      - BITMESSAGE_SEED_ADDRESSES=1
      - BITMESSAGE_TTL=172800
      - BITMESSAGE_STOPRESENDINGAFTERXDAYS=60
    ports:
      - 127.0.0.1:8442:8442
    volumes:
      - bitmessage:/home/bitmessage

volumes:
  bitmessage:

docker cli

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

Parameters

Container images are configured using parameters passed at runtime.

Parameter	Function
-p 127.0.0.1:8442	API port. The daemon always binds `0.0.0.0` inside the container, so what you publish decides who reaches it
-v /home/bitmessage	Data directory: `keys.dat` (identity, settings) and `messages.dat`. Without it the node is a new node after every update
-e BITMESSAGE_API_USER	XML-RPC API user. Default: `bitmessage_api_user` — change it
-e BITMESSAGE_API_PASSWORD	XML-RPC API password. Default: `bitmessage_api_password` — change it, see Notes
-e BITMESSAGE_SEED_PHRASE	Create Deterministic Addresses password. Default: regenerated on every start, giving different addresses each time. Only used when `BITMESSAGE_SEED_ADDRESSES` is above `0`
-e BITMESSAGE_SEED_ADDRESSES	Number of Deterministic Addresses to generate. Default: `0`
-e BITMESSAGE_TTL	The expiration of newly send messages, in seconds. Default: `172800`
-e BITMESSAGE_STOPRESENDINGAFTERXDAYS	Stop resending unreceived message after X days. Default: `30`
-e BITMESSAGE_APIVARIANT	provides xml or json-RPC API. Default: `legacy`

Notes

% cannot be used in the API password: it breaks PyBitmessage's own config reader, and every API call then returns 500 while keys.dat looks correct. Other characters are fine, the container escapes them.
Clients must percent-encode the credentials — they go into http://user:password@host:port/, where @, #, / and : change how the URL parses. The scripts in this image do; yours has to as well.
The container turns healthy once the daemon has a network connection, which on a new node takes a few minutes. The start period also covers the startup VACUUM of messages.dat.