Expose 8333 in Dockerfile and add Syncing the Bitcoin Network docs

subcoin-project · Jul 27, 2024 · 1366804 · 1366804
1 parent dbd807a
commit 1366804
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 1 deletion.
diff --git a/Dockerfile b/Dockerfile
@@ -48,6 +48,6 @@ VOLUME ["/node-data"]
 
 USER nobody:nogroup
 
-EXPOSE 30333 9933 9944 9615
+EXPOSE 8333 30333 9933 9944 9615
 
 ENTRYPOINT ["/subcoin"]
diff --git a/docs/src/usage.md b/docs/src/usage.md
@@ -6,6 +6,7 @@
     *   [Get the `bitcoind` Binary](#get-the-bitcoind-binary)
     *   [Run `subcoin import-blocks`](#run-subcoin-import-blocks)
     *   [Verify the UTXO Set State](#verify-the-utxo-set-state)
+*   [Syncing the Bitcoin Network](#syncing-the-bitcoin-network)
 
 <!-- /clap-markdown-toc -->
 
@@ -125,3 +126,13 @@ txouts: 9494
 bogosize: 1109244
 total_amount: 500000.00000000
 ```
+
+## Syncing the Bitcoin Network
+
+Run the following command to sync the Bitcoin blockchain from the Bitcoin P2P network. The `--log subcoin_network=debug` option
+will enable debug-level logging to show detailed information about the syncing process. By default, the block will be fully verified.
+You can use `--block-verification=none` to skip the block verification. Check out `subcoin run --help` for more options.
+
+```bash
+subcoin run -d data --log subcoin_network=debug
+```