Add more detail about directory_mode settings to default config and docs

2 files changed, 15 insertions, 5 deletions

diff --git a/doc/faq_admins.bb b/doc/faq_admins.bb
index 0a3f774e9..fed66a8dd 100644
--- a/doc/faq_admins.bb
+++ b/doc/faq_admins.bb
@@ -63,6 +63,16 @@ Do not reinstall a hub with a fresh database and fresh .htconfig.php unless as a
 
 Use the custom_home addon available in the main addons repository.
 
-
+[h3]What do the different directory mode settings mean?[/h3]
+[code]// Configure how we communicate with directory servers.
+// DIRECTORY_MODE_NORMAL     = directory client, we will find a directory (all of your member's queries will be directed elsewhere)
+// DIRECTORY_MODE_SECONDARY  = caching directory or mirror (keeps in sync with realm primary [adds significant cron execution time])
+// DIRECTORY_MODE_PRIMARY    = main directory server (you do not want this unless you are operating your own realm. one per realm.)
+// DIRECTORY_MODE_STANDALONE = "off the grid" or private directory services (only local site members in directory)
+[/code]
+- The default is NORMAL. This off-loads most directory services to a different server. The server used is the config:system/directory_server. This setting MAY be updated by the code to one of the project secondaries if the current server is unreachable. You should either be in control of this other server, or should trust it to use this setting.
+- SECONDARY. This allows your local site to act as a directory server without exposing your member's queries to another server. It requires extra processing time during the cron polling, and is not recommended to be run on a shared web host.
+- PRIMARY. This allows you to run a completely separate 'Network' of directory servers with your own Realm. By default, all servers are on the RED_GLOBAL realm unless the config:system/directory_realm setting is overridden. [i]Do not use this unless you have your own directory_realm.[/i]
+- STANDALONE. This is like primary, except it's a 'Network' all on it's own without talking to any other servers. Use this if you have only one server and want to be segregated from the Red#Matrix directory listings.
 
 #include doc/macros/main_footer.bb;
diff --git a/install/htconfig.sample.php b/install/htconfig.sample.php
index b23dfe3b6..25ac2df7c 100755
--- a/install/htconfig.sample.php
+++ b/install/htconfig.sample.php
@@ -64,10 +64,10 @@ $a->config['system']['php_path'] = 'php';
 
 
 // Configure how we communicate with directory servers.
-// DIRECTORY_MODE_NORMAL     = directory client, we will find a directory
-// DIRECTORY_MODE_SECONDARY  = caching directory or mirror
-// DIRECTORY_MODE_PRIMARY    = main directory server
-// DIRECTORY_MODE_STANDALONE = "off the grid" or private directory services
+// DIRECTORY_MODE_NORMAL     = directory client, we will find a directory (all of your member's queries will be directed elsewhere)
+// DIRECTORY_MODE_SECONDARY  = caching directory or mirror (keeps in sync with realm primary [adds significant cron execution time])
+// DIRECTORY_MODE_PRIMARY    = main directory server (you do not want this unless you are operating your own realm. one per realm.)
+// DIRECTORY_MODE_STANDALONE = "off the grid" or private directory services (only local site members in directory)
 
 $a->config['system']['directory_mode']  = DIRECTORY_MODE_NORMAL;