break out proxy command validation code into it's own function (no functional change)
[monkeysphere.git] / etc / monkeysphere.conf
index f2ba4a78c12c6b0e8377ac4d27da1d9e51d3ab4b..ca2fb834460dbe0b79d42069233a42211276a6ad 100644 (file)
@@ -1,33 +1,39 @@
-# MonkeySphere system-wide client configuration file.
+# Monkeysphere system-wide client configuration file.
 
 # This is an sh-style shell configuration file.  Variable names should
-# be separated from their assignements by a single '=' and no spaces.
-
-# GPG home directory
+# be separated from their assignments by a single '=' and no spaces.
+# Environment variables with the same names as these variables but
+# prefaced by "MONKEYSPHERE_" will take precedence over the values
+# specified here.
+
+# Log level.  Can be SILENT, ERROR, INFO, VERBOSE, DEBUG, in
+# increasing order of verbosity.
+#LOG_LEVEL=INFO
+
+# GPG home directory.  If not specified either here or in the
+# MONKEYSPHERE_GNUPGHOME environment variable, then the value of the
+# GNUPGHOME environment variable will be used.  If GNUPGHOME is not
+# set either, then the default value is listed below.
 #GNUPGHOME=~/.gnupg
 
-# GPG keyserver to search for keys
-#KEYSERVER=subkeys.pgp.net
+# GPG keyserver to search for keys.
+#KEYSERVER=pool.sks-keyservers.net
 
-# Required key capabilities
-# Must be quoted, lowercase, space-seperated list of the following:
-#   e = encrypt
-#   s = sign
-#   c = certify
-#   a = authentication
-#REQUIRED_HOST_KEY_CAPABILITY="a"
-#REQUIRED_USER_KEY_CAPABILITY="a"
+# Set whether or not to check keyservers at every monkeysphere
+# interaction, including all ssh connections if you use the
+# monkeysphere ssh-proxycommand.  Leave unset for default behavior
+# (see KEYSERVER CHECKING in monkeysphere(1)), or set to true or false.
+# NOTE: setting CHECK_KEYSERVER explicitly to true will leak
+# information about the timing and frequency of your ssh connections
+# to the maintainer of the keyserver.
+#CHECK_KEYSERVER=true
 
-# ssh known_hosts file
+# The path to the SSH known_hosts file.
 #KNOWN_HOSTS=~/.ssh/known_hosts
 
 # Whether or not to hash the generated known_hosts lines.
-# Should be "true" or "false"
-#HASH_KNOWN_HOSTS=true
-
-# ssh authorized_keys file
-#AUTHORIZED_KEYS=~/.ssh/known_hosts
+# Should be "true" or "false".
+#HASH_KNOWN_HOSTS=false
 
-# This overrides other environment variables
-# NOTE: there is leakage
-#CHECK_KEYRING=true
+# The path to the SSH authorized_keys file.
+#AUTHORIZED_KEYS=~/.ssh/authorized_keys