Dockerfile

README.md

@@ -0,0 +1,52 @@
+# Intro
+
+[PyBitmessage](https://bitmessage.org/) 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
+
+```yaml
+version: "3"
+services:
+  pybitmessage:
+    image: bitdeals/pybitmessage
+    environment:
+      - BITMESSAGE_API_USER=<API username>
+      - BITMESSAGE_API_PASSWORD=<API password>
+      - BITMESSAGE_SEED_PHRASE=<passphrase>
+      - BITMESSAGE_SEED_ADDRESSES=<1>
+    ports:
+      - 8442:8442
+```
+
+## docker cli
+
+```sh
+docker run -d \
+  -e BITMESSAGE_API_USER=api \
+  -e BITMESSAGE_API_PASSWORD=changeme \
+  -e BITMESSAGE_SEED_PHRASE=changeme \
+  -e BITMESSAGE_SEED_ADDRESSES=1 \
+  -p 8442:8442 \
+  bitdeals/pybitmessage
+```
+
+# Parameters
+
+Container images are configured using parameters passed at runtime.
+
+|Parameter|Function|
+|:--------|:-------|
+|-p 8442|XML-RPC API port TCP|
+|-e BITMESSAGE_API_USER=|XML-RPC API user. Default: `api`|
+|-e BITMESSAGE_API_PASSWORD=|XML-RPC API password. Default: `changeme`|
+|-e BITMESSAGE_SEED_PHRASE|Create Deterministic Addresses password. Default: `changeme`|
+|-e BITMESSAGE_SEED_ADDRESSES|Number of Deterministic Addresses to generate. Default: `1`|
+