diff --git a/contributors/piterden.txt b/contributors/piterden.txt new file mode 100644 index 000000000..86548831b --- /dev/null +++ b/contributors/piterden.txt @@ -0,0 +1,3 @@ +I hereby accept the terms of the Contributor License Agreement in the CONTRIBUTING.md file of the mempool/mempool git repository as of December 17, 2022. + +Signed: piterden diff --git a/docker/README.md b/docker/README.md index 0c53cee97..1c10a5e15 100644 --- a/docker/README.md +++ b/docker/README.md @@ -17,7 +17,7 @@ _Note: address lookups require an Electrum Server and will not work with this co The default Docker configuration assumes you have the following configuration in your `bitcoin.conf` file: -``` +```ini txindex=1 server=1 rpcuser=mempool @@ -26,7 +26,7 @@ rpcpassword=mempool If you want to use different credentials, specify them in the `docker-compose.yml` file: -``` +```yaml api: environment: MEMPOOL_BACKEND: "none" @@ -54,7 +54,7 @@ First, configure `bitcoind` as specified above, and make sure your Electrum Serv Then, set the following variables in `docker-compose.yml` so Mempool can connect to your Electrum Server: -``` +```yaml api: environment: MEMPOOL_BACKEND: "electrum" @@ -85,7 +85,7 @@ Below we list all settings from `mempool-config.json` and the corresponding over
`mempool-config.json`: -``` +```json "MEMPOOL": { "NETWORK": "mainnet", "BACKEND": "electrum", @@ -116,7 +116,7 @@ Below we list all settings from `mempool-config.json` and the corresponding over ``` Corresponding `docker-compose.yml` overrides: -``` +```yaml api: environment: MEMPOOL_NETWORK: "" @@ -153,8 +153,8 @@ Corresponding `docker-compose.yml` overrides:
`mempool-config.json`: -``` -"CORE_RPC": { +```json + "CORE_RPC": { "HOST": "127.0.0.1", "PORT": 8332, "USERNAME": "mempool", @@ -163,7 +163,7 @@ Corresponding `docker-compose.yml` overrides: ``` Corresponding `docker-compose.yml` overrides: -``` +```yaml api: environment: CORE_RPC_HOST: "" @@ -176,7 +176,7 @@ Corresponding `docker-compose.yml` overrides:
`mempool-config.json`: -``` +```json "ELECTRUM": { "HOST": "127.0.0.1", "PORT": 50002, @@ -185,7 +185,7 @@ Corresponding `docker-compose.yml` overrides: ``` Corresponding `docker-compose.yml` overrides: -``` +```yaml api: environment: ELECTRUM_HOST: "" @@ -197,14 +197,14 @@ Corresponding `docker-compose.yml` overrides:
`mempool-config.json`: -``` +```json "ESPLORA": { "REST_API_URL": "http://127.0.0.1:3000" }, ``` Corresponding `docker-compose.yml` overrides: -``` +```yaml api: environment: ESPLORA_REST_API_URL: "" @@ -214,7 +214,7 @@ Corresponding `docker-compose.yml` overrides:
`mempool-config.json`: -``` +```json "SECOND_CORE_RPC": { "HOST": "127.0.0.1", "PORT": 8332, @@ -224,7 +224,7 @@ Corresponding `docker-compose.yml` overrides: ``` Corresponding `docker-compose.yml` overrides: -``` +```yaml api: environment: SECOND_CORE_RPC_HOST: "" @@ -237,7 +237,7 @@ Corresponding `docker-compose.yml` overrides:
`mempool-config.json`: -``` +```json "DATABASE": { "ENABLED": true, "HOST": "127.0.0.1", @@ -249,7 +249,7 @@ Corresponding `docker-compose.yml` overrides: ``` Corresponding `docker-compose.yml` overrides: -``` +```yaml api: environment: DATABASE_ENABLED: "" @@ -264,7 +264,7 @@ Corresponding `docker-compose.yml` overrides:
`mempool-config.json`: -``` +```json "SYSLOG": { "ENABLED": true, "HOST": "127.0.0.1", @@ -275,7 +275,7 @@ Corresponding `docker-compose.yml` overrides: ``` Corresponding `docker-compose.yml` overrides: -``` +```yaml api: environment: SYSLOG_ENABLED: "" @@ -289,7 +289,7 @@ Corresponding `docker-compose.yml` overrides:
`mempool-config.json`: -``` +```json "STATISTICS": { "ENABLED": true, "TX_PER_SECOND_SAMPLE_PERIOD": 150 @@ -297,7 +297,7 @@ Corresponding `docker-compose.yml` overrides: ``` Corresponding `docker-compose.yml` overrides: -``` +```yaml api: environment: STATISTICS_ENABLED: "" @@ -308,7 +308,7 @@ Corresponding `docker-compose.yml` overrides:
`mempool-config.json`: -``` +```json "BISQ": { "ENABLED": false, "DATA_PATH": "/bisq/statsnode-data/btc_mainnet/db" @@ -316,7 +316,7 @@ Corresponding `docker-compose.yml` overrides: ``` Corresponding `docker-compose.yml` overrides: -``` +```yaml api: environment: BISQ_ENABLED: "" @@ -327,7 +327,7 @@ Corresponding `docker-compose.yml` overrides:
`mempool-config.json`: -``` +```json "SOCKS5PROXY": { "ENABLED": false, "HOST": "127.0.0.1", @@ -338,7 +338,7 @@ Corresponding `docker-compose.yml` overrides: ``` Corresponding `docker-compose.yml` overrides: -``` +```yaml api: environment: SOCKS5PROXY_ENABLED: "" @@ -352,7 +352,7 @@ Corresponding `docker-compose.yml` overrides:
`mempool-config.json`: -``` +```json "PRICE_DATA_SERVER": { "TOR_URL": "http://wizpriceje6q5tdrxkyiazsgu7irquiqjy2dptezqhrtu7l2qelqktid.onion/getAllMarketPrices", "CLEARNET_URL": "https://price.bisq.wiz.biz/getAllMarketPrices" @@ -360,7 +360,7 @@ Corresponding `docker-compose.yml` overrides: ``` Corresponding `docker-compose.yml` overrides: -``` +```yaml api: environment: PRICE_DATA_SERVER_TOR_URL: "" @@ -371,7 +371,7 @@ Corresponding `docker-compose.yml` overrides:
`mempool-config.json`: -``` +```json "LIGHTNING": { "ENABLED": false "BACKEND": "lnd" @@ -383,7 +383,7 @@ Corresponding `docker-compose.yml` overrides: ``` Corresponding `docker-compose.yml` overrides: -``` +```yaml api: environment: LIGHTNING_ENABLED: false @@ -398,7 +398,7 @@ Corresponding `docker-compose.yml` overrides:
`mempool-config.json`: -``` +```json "LND": { "TLS_CERT_PATH": "" "MACAROON_PATH": "" @@ -407,7 +407,7 @@ Corresponding `docker-compose.yml` overrides: ``` Corresponding `docker-compose.yml` overrides: -``` +```yaml api: environment: LND_TLS_CERT_PATH: "" @@ -419,14 +419,14 @@ Corresponding `docker-compose.yml` overrides:
`mempool-config.json`: -``` +```json "CLIGHTNING": { "SOCKET": "" } ``` Corresponding `docker-compose.yml` overrides: -``` +```yaml api: environment: CLIGHTNING_SOCKET: ""