[CalendarServer-changes] [15696] CalendarServer/trunk
source_changes at macosforge.org
source_changes at macosforge.org
Thu Jun 23 14:57:12 PDT 2016
Revision: 15696
http://trac.calendarserver.org//changeset/15696
Author: sagen at apple.com
Date: 2016-06-23 14:57:12 -0700 (Thu, 23 Jun 2016)
Log Message:
-----------
Add some stdconfig comments
Modified Paths:
--------------
CalendarServer/trunk/conf/caldavd-stdconfig.plist
CalendarServer/trunk/twistedcaldav/stdconfig.py
Modified: CalendarServer/trunk/conf/caldavd-stdconfig.plist
===================================================================
--- CalendarServer/trunk/conf/caldavd-stdconfig.plist 2016-06-23 19:55:00 UTC (rev 15695)
+++ CalendarServer/trunk/conf/caldavd-stdconfig.plist 2016-06-23 21:57:12 UTC (rev 15696)
@@ -271,30 +271,40 @@
<!-- Data store -->
+ <!-- The top level directory, contains (by default) ConfigRoot and DataRoot -->
<key>ServerRoot</key>
<string>/var/db/caldavd</string>
+ <!-- Data directory, parent to DatabaseRoot, AttachmentsRoot, and others -->
<key>DataRoot</key>
<string>Data</string>
+ <!-- Database directory, contains PostgreSQL cluster -->
<key>DatabaseRoot</key>
<string>Database</string>
+ <!-- Attachments directory, where file attachments are stored -->
<key>AttachmentsRoot</key>
<string>Attachments</string>
+ <!-- Documents directory, contains files to be served as HTTP resources at the
+ root level -->
<key>DocumentRoot</key>
<string>Documents</string>
+ <!-- Config directory, contains additional config files -->
<key>ConfigRoot</key>
<string>Config</string>
+ <!-- Log directory, contains access.log, error.log and others -->
<key>LogRoot</key>
<string>/var/log/caldavd</string>
+ <!-- Run-time directory, contains PID files and UNIX socket files -->
<key>RunRoot</key>
<string>/var/run/caldavd</string>
+ <!-- WebCal directory, contains HTML implementing the web calendar -->
<key>WebCalendarRoot</key>
<string>/Applications/Server.app/Contents/ServerRoot/usr/share/collabd/webcal/public</string>
@@ -559,15 +569,17 @@
<key>AccessLogFile</key>
<string>access.log</string>
- <!-- Server activity log -->
+ <!-- Server activity log (the verbosity is controlled by DefaultLogLevel and
+ LogLevels keys) -->
<key>ErrorLogFile</key>
<string>error.log</string>
- <!-- Agent activity log -->
+ <!-- Agent activity log (only applies to Server.app edition) -->
<key>AgentLogFile</key>
<string>agent.log</string>
- <!-- Utility log - name will be dynamically changed to executable name -->
+ <!-- Utility log (used for command line utilities; the name will be dynamically
+ changed to that of the utility being run) -->
<key>UtilityLogFile</key>
<string>utility.log</string>
@@ -599,13 +611,18 @@
<key>EnableExtendedTimingAccessLog</key>
<false/>
+ <!-- Controls the verbosity of ErrorLogFile (valid values are error, warn,
+ info, debug; default is info) -->
<key>DefaultLogLevel</key>
<string></string>
+ <!-- Allows overriding log levels on a per-package, per-module, or even per-
+ class basis -->
<key>LogLevels</key>
<dict>
</dict>
+ <!-- Used internally to track which worker process is logging a message -->
<key>LogID</key>
<string></string>
@@ -652,6 +669,8 @@
<array>
</array>
+ <!-- The parent directory for accounting log directories (by default, relative
+ to LogRoot) -->
<key>AccountingLogRoot</key>
<string>accounting</string>
@@ -770,7 +789,7 @@
<true/>
</dict>
- <!-- Service ACLs -->
+ <!-- If enabled, will honor macOS Server ACLs to control access -->
<key>EnableSACLs</key>
<false/>
Modified: CalendarServer/trunk/twistedcaldav/stdconfig.py
===================================================================
--- CalendarServer/trunk/twistedcaldav/stdconfig.py 2016-06-23 19:55:00 UTC (rev 15695)
+++ CalendarServer/trunk/twistedcaldav/stdconfig.py 2016-06-23 21:57:12 UTC (rev 15696)
@@ -278,15 +278,15 @@
#
# Data store
#
- "ServerRoot": "/var/db/caldavd",
- "DataRoot": "Data",
- "DatabaseRoot": "Database",
- "AttachmentsRoot": "Attachments",
- "DocumentRoot": "Documents",
- "ConfigRoot": "Config",
- "LogRoot": "/var/log/caldavd",
- "RunRoot": "/var/run/caldavd",
- "WebCalendarRoot": "/Applications/Server.app/Contents/ServerRoot/usr/share/collabd/webcal/public",
+ "ServerRoot": "/var/db/caldavd", # The top level directory, contains (by default) ConfigRoot and DataRoot
+ "DataRoot": "Data", # Data directory, parent to DatabaseRoot, AttachmentsRoot, and others
+ "DatabaseRoot": "Database", # Database directory, contains PostgreSQL cluster
+ "AttachmentsRoot": "Attachments", # Attachments directory, where file attachments are stored
+ "DocumentRoot": "Documents", # Documents directory, contains files to be served as HTTP resources at the root level
+ "ConfigRoot": "Config", # Config directory, contains additional config files
+ "LogRoot": "/var/log/caldavd", # Log directory, contains access.log, error.log and others
+ "RunRoot": "/var/run/caldavd", # Run-time directory, contains PID files and UNIX socket files
+ "WebCalendarRoot": "/Applications/Server.app/Contents/ServerRoot/usr/share/collabd/webcal/public", # WebCal directory, contains HTML implementing the web calendar
#
# Quotas
@@ -413,9 +413,9 @@
# Logging
#
"AccessLogFile" : "access.log", # Apache-style access log
- "ErrorLogFile" : "error.log", # Server activity log
- "AgentLogFile" : "agent.log", # Agent activity log
- "UtilityLogFile" : "utility.log", # Utility log - name will be dynamically changed to executable name
+ "ErrorLogFile" : "error.log", # Server activity log (the verbosity is controlled by DefaultLogLevel and LogLevels keys)
+ "AgentLogFile" : "agent.log", # Agent activity log (only applies to Server.app edition)
+ "UtilityLogFile" : "utility.log", # Utility log (used for command line utilities; the name will be dynamically changed to that of the utility being run)
"ErrorLogEnabled" : True, # True = use log file, False = stdout
"ErrorLogRotateMB" : 10, # Rotate error log after so many megabytes
"ErrorLogMaxRotatedFiles" : 5, # Retain this many error log files
@@ -424,9 +424,9 @@
"RotateAccessLog" : False,
"EnableExtendedAccessLog": True,
"EnableExtendedTimingAccessLog": False,
- "DefaultLogLevel" : "",
- "LogLevels" : {},
- "LogID" : "",
+ "DefaultLogLevel" : "", # Controls the verbosity of ErrorLogFile (valid values are error, warn, info, debug; default is info)
+ "LogLevels" : {}, # Allows overriding log levels on a per-package, per-module, or even per-class basis
+ "LogID" : "", # Used internally to track which worker process is logging a message
"AccountingCategories": {
"HTTP": False, # Log regular HTTP requests
@@ -440,7 +440,7 @@
"migration": False, # Log cross-pod migration details
},
"AccountingPrincipals": [],
- "AccountingLogRoot" : "accounting",
+ "AccountingLogRoot" : "accounting", # The parent directory for accounting log directories (by default, relative to LogRoot)
"Stats" : {
"EnableUnixStatsSocket" : False,
@@ -496,7 +496,7 @@
"ResidentOnly" : True, # True: only take into account resident memory; False: include virtual memory
},
- "EnableSACLs": False, # Service ACLs
+ "EnableSACLs": False, # If enabled, will honor macOS Server ACLs to control access
"EnableReadOnlyServer": False, # Make all data read-only
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.macosforge.org/pipermail/calendarserver-changes/attachments/20160623/52a4650e/attachment-0001.html>
More information about the calendarserver-changes
mailing list