Updated documentation

skavanagh · skavanagh · commit 115e0e51a528 · 2015-11-03T05:53:08.000-05:00
Updated documentation on disabling key management.
diff --git a/README.md b/README.md
@@ -81,7 +81,7 @@ Managing SSH Keys
 ------
 By default KeyBox will overwrite all values in the specified authorized_keys file for a system.  You can disable key management by editing KeyBoxConfig.properties file and use KeyBox only as a bastion host.  This file is located in the jetty/keybox/WEB-INF/classes directory. (or the src/main/resources directory if building from source)
 
-	#enable key management  --set to false to disable
+	#set to false to disable key management. If false, the KeyBox public key will be appended to the authorized_keys file (instead of it being overwritten completely).
 	keyManagementEnabled=false
 
 Also, the authorized_keys file is updated/refreshed periodically based on the relationships defined in the application.  If key management is enabled the refresh interval can be specified in the KeyBoxConfig.properties file.
diff --git a/src/main/resources/KeyBoxConfig.properties b/src/main/resources/KeyBoxConfig.properties
@@ -28,7 +28,7 @@ websocketTimeout=0
 agentForwarding=false
 #enable two-factor authentication
 enableOTP=true
-#enable key management
+#set to false to disable key management. If false, the KeyBox public key will be appended to the authorized_keys file (instead of it being overwritten completely).
 keyManagementEnabled=true
 #set to true to generate keys when added/managed by users and enforce strong passphrases set to false to allow users to set their own public key
 forceUserKeyGeneration=true
