Merge branch 'master' of github.com:janoside/btc-rpc-explorer

.env-sample

@@ -1,18 +1,27 @@
-# Optional logging settings, see comments after each for more info
-#DEBUG=*  # Enable all logging, including middleware, etc
+# Optional logging settings, uncomment one of these example lines or add your own.
+# See comments after each for more info.
+# Default: "btcexp:app,btcexp:error"
+#DEBUG=*  # Enable all logging, including middleware
 #DEBUG=btcexp:*  # Enable all logging specific to btc-rpc-explorer
-#DEBUG=btcexp:app,btcexp:error  # Default logging setting if "DEBUG" is not set
+#DEBUG=btcexp:app,btcexp:error  # Default
 
-# The active coin: BTC/LTC
+# The active coin. Only officially supported value is "BTC".
+# Default: BTC
 #BTCEXP_COIN=BTC
 
 # Host/Port to bind to
+# Defaults: shown
 #BTCEXP_HOST=127.0.0.1
 #BTCEXP_PORT=3002
 
 # Bitcoin RPC Credentials (URI -OR- HOST/PORT/USER/PASS)
+# Defaults:
+#   - [host/port]: 127.0.0.1:8332
+#   - [username/password]: none
+#   - cookie: '~/.bitcoin/.cookie'
+#   - timeout: 5000 (ms)
 #BTCEXP_BITCOIND_URI=bitcoin://rpcusername:rpcpassword@127.0.0.1:8332?timeout=10000
-#BTCEXP_BITCOIND_HOST=localhost
+#BTCEXP_BITCOIND_HOST=127.0.0.1
 #BTCEXP_BITCOIND_PORT=8332
 #BTCEXP_BITCOIND_USER=rpcusername
 #BTCEXP_BITCOIND_PASS=rpcpassword
@@ -23,49 +32,64 @@
 # Options: electrumx, blockchain.com, blockchair.com, blockcypher.com
 # If electrumx set, the BTCEXP_ELECTRUMX_SERVERS variable must also be
 # set.
-BTCEXP_ADDRESS_API=(electrumx|blockchain.com|blockcypher.com)
+# Default: none
+#BTCEXP_ADDRESS_API=(electrumx|blockchain.com|blockcypher.com)
 
 # Optional ElectrumX Servers. See BTCEXP_ADDRESS_API. This value is only
 # used if BTCEXP_ADDRESS_API=electrumx
 #BTCEXP_ELECTRUMX_SERVERS=tls://electrumx.server.com:50002,tcp://127.0.0.1:50001,...
 
 # Set number of concurrent RPC requests. Should be lower than your node's "rpcworkqueue" value.
-# The default for this value is 10, aiming to be less than Bitcoin Core's default rpcworkqueue=16.
+# Note that Bitcoin Core's default rpcworkqueue=16.
+# Default: 10
 #BTCEXP_RPC_CONCURRENCY=10
 
 # Disable app's in-memory RPC caching to reduce memory usage
+# Default: false (i.e. in-memory cache **enabled**)
 #BTCEXP_NO_INMEMORY_RPC_CACHE=true
 
 # Optional redis server for RPC caching
+# Default: none
 #BTCEXP_REDIS_URL=redis://localhost:6379
 
+# Default: hash of credentials
 #BTCEXP_COOKIE_SECRET=0000aaaafffffgggggg
 
 # Whether public-demo aspects of the site are active
+# Default: false
 #BTCEXP_DEMO=true
 
 # Privacy mode disables:
 # Exchange-rate queries, IP-geolocation queries
+# Default: false
 #BTCEXP_PRIVACY_MODE=true
 
 # Don't request currency exchange rates
+# Default: true (i.e. no exchange-rate queries made)
 #BTCEXP_NO_RATES=true
 
 # Password protection for site via basic auth (enter any username, only the password is checked)
+# Default: none
 #BTCEXP_BASIC_AUTH_PASSWORD=mypassword
 
 # Enable to allow access to all RPC methods
+# Default: false
 #BTCEXP_RPC_ALLOWALL=true
 
 # Custom RPC method blacklist
+# Default: (see config.js)
 #BTCEXP_RPC_BLACKLIST=signrawtransaction,sendtoaddress,stop,...
 
+# Optional API keys
+# Default: none
 #BTCEXP_GANALYTICS_TRACKING=UA-XXXX-X
 #BTCEXP_SENTRY_URL=https://00000fffffff@sentry.io/XXXX
 #BTCEXP_IPSTACK_APIKEY=000000fffffaaaaa
 
-# Optional value for "max_old_space_size", default: 1024
+# Optional value for "max_old_space_size"
+# Default: 1024
 #BTCEXP_OLD_SPACE_MAX_SIZE=2048
 
-# Show tools list in a sub-nav at top of screen (default: true)
+# Show tools list in a sub-nav at top of screen
+# Default: true
 BTCEXP_UI_SHOW_TOOLS_SUBHEADER=true

.github/ISSUE_TEMPLATE/bug_report.md

@@ -8,15 +8,24 @@ assignees: ''
 ---
 
 **Describe the bug**
+
 A clear and concise description of what the bug is.
 
 **Environment (please complete the following information):**
+
  - Bitcoin Core / Node Version [e.g. 0.16.3]
  - NodeJS Version [e.g. 9.x]
  - Browser [e.g. chrome, safari]
  - Code Version / Commit [e.g. ab6cde8]
  
+**Configuration file content**
+
+Please include the content from the following files. **BE SURE TO MODIFY YOUR CREDENTIALS BEFORE SUBMITTING!!!**
+ - bitcoin.conf
+ - Your btc-rpc-explorer environment configuration (either `$WORKING_DIR/.env` or `~/.config/btc-rpc-explorer.env`)
+
 **To Reproduce**
+
 Steps to reproduce the behavior:
 1. Go to '...'
 2. Click on '....'
@@ -24,7 +33,9 @@ Steps to reproduce the behavior:
 4. See error
 
 **Screenshots or Log Output**
+
 If applicable, add screenshots or log output to help explain your problem.
 
 **Additional context**
+
 Add any other context about the problem here.