From fe989f9f5f79ff20449f08624a0d4d2fa8524319 Mon Sep 17 00:00:00 2001 From: Arik Sosman Date: Mon, 22 Aug 2022 17:46:14 -0700 Subject: [PATCH] Rename environment variables to reflect the name of this project. --- README.md | 20 ++++++++++---------- src/config.rs | 8 ++++---- 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 2efb27d..b8cbfe7 100644 --- 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,15 +12,15 @@ 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 | +| 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 | 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. diff --git a/src/config.rs b/src/config.rs index 4d44efe..9289945 100644 --- a/src/config.rs +++ b/src/config.rs @@ -15,13 +15,13 @@ pub(crate) fn network_graph_cache_path() -> &'static str { pub(crate) fn db_connection_config() -> Config { let mut config = Config::new(); - let host = env::var("RUST_LN_SYNC_DB_HOST").unwrap_or("localhost".to_string()); - let user = env::var("RUST_LN_SYNC_DB_USER").unwrap_or("alice".to_string()); - let db = env::var("RUST_LN_SYNC_DB_NAME").unwrap_or("ln_graph_sync".to_string()); + let host = env::var("RAPID_GOSSIP_SYNC_SERVER_DB_HOST").unwrap_or("localhost".to_string()); + let user = env::var("RAPID_GOSSIP_SYNC_SERVER_DB_USER").unwrap_or("alice".to_string()); + let db = env::var("RAPID_GOSSIP_SYNC_SERVER_DB_NAME").unwrap_or("ln_graph_sync".to_string()); config.host(&host); config.user(&user); config.dbname(&db); - if let Ok(password) = env::var("RUST_LN_SYNC_DB_PASSWORD") { + if let Ok(password) = env::var("RAPID_GOSSIP_SYNC_SERVER_DB_PASSWORD") { config.password(&password); } config -- 2.39.5