Merge pull request #54 from arik-so/2023/08/incremental-update-fix

[rapid-gossip-sync-server] / README.md

diff --git a/README.md b/README.md
index e38376293616e496500d0b7c557abd2cb240f900..13f46c6a561dbad062c9f0496ebeedaa8c45899f 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-# rust-ln-sync
+# rapid-gossip-sync-server
 
 This is a server that connects to peers on the Lightning network and calculates compact rapid sync
 gossip data.
@@ -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                                                                                                |
-|:-------------------------|:--------------|:-----------------------------------------------------------------------------------------------------------|
-| RUST_LN_SYNC_DB_HOST     | localhost     | Domain of the Postgres database                                                                            |
-| RUST_LN_SYNC_DB_USER     | alice         | Username to access Postgres                                                                                |
-| RUST_LN_SYNC_DB_PASSWORD | _None_        | Password to access Postgres                                                                                |
-| RUST_LN_SYNC_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        | 80            | 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
 
@@ -58,4 +57,4 @@ incremental update.
 
 ## License
 
-[Apache 2.0](LICENSE-APACHE) or [MIT](LICENSE-MIT), at your option.
+[Apache 2.0](LICENSE-APACHE.md) or [MIT](LICENSE-MIT.md), [at your option](LICENSE.md).