X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=README.md;h=13f46c6a561dbad062c9f0496ebeedaa8c45899f;hb=fee45d58d49ae14299c849abe0a3eb1b5f9de060;hp=d14ab2f09793edbb22466a593e65e760e4c4f117;hpb=dc1dac2d4cde194d0ec0ed04fedf9ea9d651f370;p=rapid-gossip-sync-server diff --git a/README.md b/README.md index d14ab2f..13f46c6 100644 --- a/README.md +++ b/README.md @@ -12,18 +12,17 @@ These are the components it's comprised of. A config file where the Postgres credentials and Lightning peers can be adjusted. Most adjustments can be made by setting environment variables, whose usage is as follows: -| Name | Default | Description | -|:-------------------------------------|:--------------|:-----------------------------------------------------------------------------------------------------------| -| RAPID_GOSSIP_SYNC_SERVER_DB_HOST | localhost | Domain of the Postgres database | -| RAPID_GOSSIP_SYNC_SERVER_DB_USER | alice | Username to access Postgres | -| RAPID_GOSSIP_SYNC_SERVER_DB_PASSWORD | _None_ | Password to access Postgres | -| RAPID_GOSSIP_SYNC_SERVER_DB_NAME | ln_graph_sync | Name of the database to be used for gossip storage | -| BITCOIN_REST_DOMAIN | 127.0.0.1 | Domain of the [bitcoind REST server](https://github.com/bitcoin/bitcoin/blob/master/doc/REST-interface.md) | -| BITCOIN_REST_PORT | 8332 | HTTP port of the bitcoind REST server | -| BITCOIN_REST_PATH | /rest/ | Path infix to access the bitcoind REST endpoints | - -Notably, one property needs to be modified in code, namely the `ln_peers()` method. It specifies how -many and which peers to use for retrieving gossip. +| Name | Default | Description | +|:-------------------------------------|:--------------------|:-----------------------------------------------------------------------------------------------------------| +| RAPID_GOSSIP_SYNC_SERVER_DB_HOST | localhost | Domain of the Postgres database | +| RAPID_GOSSIP_SYNC_SERVER_DB_USER | alice | Username to access Postgres | +| RAPID_GOSSIP_SYNC_SERVER_DB_PASSWORD | _None_ | Password to access Postgres | +| RAPID_GOSSIP_SYNC_SERVER_DB_NAME | ln_graph_sync | Name of the database to be used for gossip storage | +| RAPID_GOSSIP_SYNC_SERVER_NETWORK | mainnet | Network to operate in. Possible values are mainnet, testnet, signet, regtest | +| BITCOIN_REST_DOMAIN | 127.0.0.1 | Domain of the [bitcoind REST server](https://github.com/bitcoin/bitcoin/blob/master/doc/REST-interface.md) | +| BITCOIN_REST_PORT | 8332 | HTTP port of the bitcoind REST server | +| BITCOIN_REST_PATH | /rest/ | Path infix to access the bitcoind REST endpoints | +| LN_PEERS | _Wallet of Satoshi_ | Comma separated list of LN peers to use for retrieving gossip | ### downloader