Updated documentation in torch.conf

torch.conf

@@ -1,22 +1,47 @@
+#################
+# The `tor` section heading is required
 [tor]
+
+# Optional: The Tor onion proxy host and port (default: 127.0.0.1:9050)
+#ProxyHost 127.0.0.1
 ProxyPort = 9050
+
+# Optional: The Tor controller port (default: 9051) for creating new hidden services
 ControllerPort = 9051
 
+
+#################
+# The `ssh` section heading is required
 [ssh]
+
+# Optional: Local SSH sevice port (default: 22)
 Port = 22
 
+
+#################
+# The `mqtt` section heading is required
 [mqtt]
 
+# Optional: The MQTT broker host and port (default: localhost:1883)
+#    Can be either IPv4 or Tor onion hostname
 BrokerHost = mqtt.example.com
 #BrokerHost = example1i3uyrbfoi3fi.onion
-
 BrokerPort = 1883
+
+# Optional: ID that will be used as an MQTT client ID when connecting to the broker (defaults to the current host's hostname)
 ClientID = my-client
+
+# Optional: Topic to be used when publishing connection info (defaults to 'torch/[hostname]/onion_url')
 Topic = example/topic
 
-### Options for Using TLS
+### Optional: TLS Options
+#
+# Note: when CaFile, CertFile and KeyFile are ALL defined, then TLS (MQTTS) is used to connect to the broker.  Otherwise MQTT is used.
+#
 
+# Optional: Whether or not TORch Agent will verify the hostname of the broker and require it to match the name on the certificate the broker provides.  This will be automatically DISABLED for connections to Tor onion hosts
 #RequireCertificate = true
+
 #CaFile = ca.crt
 #CertFile = client.crt
 #KeyFile = client.key