private/apostol-dm
1
1
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Docker fix: update readme

Browse Source
This commit is contained in:
status404
2024-02-20 13:15:08 +03:00
parent 7eaeb727c3
commit c25da22cc8
1 changed files with 16 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
docker/README.md
View File

@@ -11,7 +11,7 @@ On first run the initialization script will create, a new bitcoin and PGP keys a
Daemon settings may specified by an environment variables. PGP secret key is stored on a Docker volume.
First run example: `docker run -i -t -e DM_TESTNET=1 -p 127.0.0.1:443:443 bitdeals/apostol-dm` - register new user, open WebUI port.
First run example: `docker run -i -t -e DM_TESTNET=true -p 127.0.0.1:443:443 bitdeals/apostol-dm` - register new user, open WebUI port.
# Usage
@@ -25,11 +25,10 @@ services:
bitdeals-module:
image: bitdeals/apostol-dm
environment:
- DM_TESTNET=0
- DM_TESTNET=true
- DM_BITCOIN=<address>
- DM_FEE=<0.1%>
- DM_FORWEB=https://127.0.0.1
- DM_WEBAUTH=0
- DM_FORWEB=127.0.0.1
- |
DM_PGP_SEC=
-----BEGIN PGP PRIVATE KEY BLOCK-----
@@ -50,12 +49,12 @@ volumes:
```sh
docker run -d \
-e DM_TESTNET=0 \
-e DM_TESTNET=true \
-e DM_BITCOIN=<address> \
-e DM_FEE=0.1% \
-e DM_PGP_SEC="$(gpg2 --armor --export-secret-key Account_URL)" \
-e DM_WEBAUTH=0 \
-e DM_LC_ALL=en_US.UTF-8 \
-e DM_LC_ALL=ru_RU.UTF-8 \
-e DM_WEB_LANG=ru \
-p 127.0.0.1:4999:4999 \
-p 127.0.0.1:80:80 \
-p 127.0.0.1:443:443 \
@@ -72,15 +71,16 @@ Container images are configured using parameters passed at runtime.
|-p 80|WebUI port|
|-p 443|WebUI port|
|-p 4999|dm API port [(API documentation)](/private/apostol-dm/src/branch/master/doc/REST-API-ru.md)|
|-e DM_TESTNET=|Enable bitcoin testnet mode. Default: `0`|
|-e DM_ACCOUNT_URL=|Set Account_URL for a new account registration. Format: `http[s]://<host>[:<port>]`|
|-e DM_BITCOIN=|User account bitcoin address. Will be created if empty.|
|-e DM_FEE=|User fee for created deals. You MUST indicate the sign "%" for a percentage of the deal amount or FIXED value in satoshi. Default: `0.1%`|
|-e DM_PGP_SEC=|Variable with ASCII armored PGP user secret key. Will be created if empty (with Account_URL in the key details).|
|-e DM_PGP_PASSWORD=|User PGP key password.|
|-e DM_FORWEB=|dm host for dm Web app (the host should be accessable from your browser). Default: `https://127.0.0.1`|
|-e DM_WEBAUTH=|Enable Web app user interface authentication. Default: `0`|
|-e DM_LC_ALL=|Set locale for dm. Default: `en_US.UTF-8`|
|-e DM_TZ=|Set timezone for dm. Default: `Etc/UTC`|
|-e DM_ACCOUNT_URL=|Set Account_URL for a new account registration. Format: `http[s]://<host>[:<port>]`|
|-e DM_BITDEALS_PGP_FINGERPRINT=|Force to get BitDeals PGP key by fingerprint from keyserver. Default: `none`|
|-e DM_FEE=|User fee for created deals. You MUST indicate the sign "%" for a percentage of the deal amount or FIXED value in satoshi. Default: `0.1%`|
|-e DM_FORWEB=|dm host for dm Web app (the host should be accessable from your browser). Default: `https://127.0.0.1`|
|-e DM_LC_ALL=|Set locale for dm. Default: `en_US.UTF-8`|
|-e DM_PGP_PASSWORD=|User PGP key password.|
|-e DM_PGP_SEC=|Variable with ASCII armored PGP user secret key. Will be created if empty (with Account_URL in the key details).|
|-e DM_TESTNET=|Enable bitcoin testnet mode. Default: `0`|
|-e DM_TZ=|Set timezone for dm. Default: `Etc/UTC`|
|-e DM_WEBAUTH=|Enable Web app user interface authentication. Default: `0`|
|-e DM_WEB_LANG=|Set interface language for dm WebUI. Default: `en`|