فهرست منبع

darkwikid: Add more explanations in the config file.

Luther Blissett 3 سال پیش
والد
کامیت
98d6300c5e
1فایلهای تغییر یافته به همراه16 افزوده شده و 6 حذف شده
  1. 16 6
      bin/darkwiki/darkwikid/darkwikid_config.toml

+ 16 - 6
bin/darkwiki/darkwikid/darkwikid_config.toml

@@ -6,10 +6,15 @@
 ## The default values are left commented. They can be overridden either by
 ## uncommenting, or by using the commandline.
 
-# JSON-RPC listen URL
+# JSON-RPC endpoint listen URL, this is where the daemon's clients connect to. 
+# Usually, this should be listening on localhost, where you'll also be running
+# your clients that interface with the daemon. Running the JSON-RPC endpoint
+# publicly accessible is dangerous as it allows others to interact with it and
+# potentially destroy and/or steal your data!
 #rpc_listen = "tcp://localhost:24330"
 
-# Toplevel path to where you wish to store darkwiki files.
+# Toplevel path to where you wish to store darkwiki files. This is where you'll
+# make edits to files and commit them.
 #docs = "~/darkwiki"
 
 # The nickname your darkwikid will use for your patches.
@@ -18,18 +23,23 @@
 # Workspaces, configured as an array, so instead of having multiple
 # keys, just append them in this list:
 # workspace = [
-#     "darkfi:Ar7GhqEPdc8dYWbmPwLaTfvtHGwaS9Ki2UmSJvCURisd",
+#     "darkwiki_playground:Ar7GhqEPdc8dYWbmPwLaTfvtHGwaS9Ki2UmSJvCURisd",
 # ]
 
 # Network settings
 [net]
-# P2P accept addresses
+# P2P accept addresses, set this to 0.0.0.0 and/or [::] to listen on all
+# available interfaces. Alternatively, add the IP addresses or domains you
+# want your daemon to listen to.
 #inbound = ["tls://0.0.0.0:24331"]
 
-# Outbound connection slots
+# Outbound connection slots, the target number of peers your node will try
+# to connect to.
 outbound_connections = 8
 
-# P2P external addresses, if your node is reachable from the Internet.
+# P2P external addresses. If your node is reachable from the Internet, this
+# address will be advertised to the seed node(s) you connect to for bootstrap.
+# If your daemon isn't reachable by others, leave this commented.
 #external_addr = ["tls://your_ip_addr_or_domain:24331"]
 
 # Manual connections to peers. This is in addition to outbound_connections.