<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[15696] CalendarServer/trunk</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://trac.calendarserver.org//changeset/15696">15696</a></dd>
<dt>Author</dt> <dd>sagen@apple.com</dd>
<dt>Date</dt> <dd>2016-06-23 14:57:12 -0700 (Thu, 23 Jun 2016)</dd>
</dl>
<h3>Log Message</h3>
<pre>Add some stdconfig comments</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#CalendarServertrunkconfcaldavdstdconfigplist">CalendarServer/trunk/conf/caldavd-stdconfig.plist</a></li>
<li><a href="#CalendarServertrunktwistedcaldavstdconfigpy">CalendarServer/trunk/twistedcaldav/stdconfig.py</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="CalendarServertrunkconfcaldavdstdconfigplist"></a>
<div class="modfile"><h4>Modified: CalendarServer/trunk/conf/caldavd-stdconfig.plist (15695 => 15696)</h4>
<pre class="diff"><span>
<span class="info">--- 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)
</span><span class="lines">@@ -271,30 +271,40 @@
</span><span class="cx">
</span><span class="cx"> <!-- Data store -->
</span><span class="cx">
</span><ins>+ <!-- The top level directory, contains (by default) ConfigRoot and DataRoot -->
</ins><span class="cx"> <key>ServerRoot</key>
</span><span class="cx"> <string>/var/db/caldavd</string>
</span><span class="cx">
</span><ins>+ <!-- Data directory, parent to DatabaseRoot, AttachmentsRoot, and others -->
</ins><span class="cx"> <key>DataRoot</key>
</span><span class="cx"> <string>Data</string>
</span><span class="cx">
</span><ins>+ <!-- Database directory, contains PostgreSQL cluster -->
</ins><span class="cx"> <key>DatabaseRoot</key>
</span><span class="cx"> <string>Database</string>
</span><span class="cx">
</span><ins>+ <!-- Attachments directory, where file attachments are stored -->
</ins><span class="cx"> <key>AttachmentsRoot</key>
</span><span class="cx"> <string>Attachments</string>
</span><span class="cx">
</span><ins>+ <!-- Documents directory, contains files to be served as HTTP resources at the
+ root level -->
</ins><span class="cx"> <key>DocumentRoot</key>
</span><span class="cx"> <string>Documents</string>
</span><span class="cx">
</span><ins>+ <!-- Config directory, contains additional config files -->
</ins><span class="cx"> <key>ConfigRoot</key>
</span><span class="cx"> <string>Config</string>
</span><span class="cx">
</span><ins>+ <!-- Log directory, contains access.log, error.log and others -->
</ins><span class="cx"> <key>LogRoot</key>
</span><span class="cx"> <string>/var/log/caldavd</string>
</span><span class="cx">
</span><ins>+ <!-- Run-time directory, contains PID files and UNIX socket files -->
</ins><span class="cx"> <key>RunRoot</key>
</span><span class="cx"> <string>/var/run/caldavd</string>
</span><span class="cx">
</span><ins>+ <!-- WebCal directory, contains HTML implementing the web calendar -->
</ins><span class="cx"> <key>WebCalendarRoot</key>
</span><span class="cx"> <string>/Applications/Server.app/Contents/ServerRoot/usr/share/collabd/webcal/public</string>
</span><span class="cx">
</span><span class="lines">@@ -559,15 +569,17 @@
</span><span class="cx"> <key>AccessLogFile</key>
</span><span class="cx"> <string>access.log</string>
</span><span class="cx">
</span><del>- <!-- Server activity log -->
</del><ins>+ <!-- Server activity log (the verbosity is controlled by DefaultLogLevel and
+ LogLevels keys) -->
</ins><span class="cx"> <key>ErrorLogFile</key>
</span><span class="cx"> <string>error.log</string>
</span><span class="cx">
</span><del>- <!-- Agent activity log -->
</del><ins>+ <!-- Agent activity log (only applies to Server.app edition) -->
</ins><span class="cx"> <key>AgentLogFile</key>
</span><span class="cx"> <string>agent.log</string>
</span><span class="cx">
</span><del>- <!-- Utility log - name will be dynamically changed to executable name -->
</del><ins>+ <!-- Utility log (used for command line utilities; the name will be dynamically
+ changed to that of the utility being run) -->
</ins><span class="cx"> <key>UtilityLogFile</key>
</span><span class="cx"> <string>utility.log</string>
</span><span class="cx">
</span><span class="lines">@@ -599,13 +611,18 @@
</span><span class="cx"> <key>EnableExtendedTimingAccessLog</key>
</span><span class="cx"> <false/>
</span><span class="cx">
</span><ins>+ <!-- Controls the verbosity of ErrorLogFile (valid values are error, warn,
+ info, debug; default is info) -->
</ins><span class="cx"> <key>DefaultLogLevel</key>
</span><span class="cx"> <string></string>
</span><span class="cx">
</span><ins>+ <!-- Allows overriding log levels on a per-package, per-module, or even per-
+ class basis -->
</ins><span class="cx"> <key>LogLevels</key>
</span><span class="cx"> <dict>
</span><span class="cx"> </dict>
</span><span class="cx">
</span><ins>+ <!-- Used internally to track which worker process is logging a message -->
</ins><span class="cx"> <key>LogID</key>
</span><span class="cx"> <string></string>
</span><span class="cx">
</span><span class="lines">@@ -652,6 +669,8 @@
</span><span class="cx"> <array>
</span><span class="cx"> </array>
</span><span class="cx">
</span><ins>+ <!-- The parent directory for accounting log directories (by default, relative
+ to LogRoot) -->
</ins><span class="cx"> <key>AccountingLogRoot</key>
</span><span class="cx"> <string>accounting</string>
</span><span class="cx">
</span><span class="lines">@@ -770,7 +789,7 @@
</span><span class="cx"> <true/>
</span><span class="cx"> </dict>
</span><span class="cx">
</span><del>- <!-- Service ACLs -->
</del><ins>+ <!-- If enabled, will honor macOS Server ACLs to control access -->
</ins><span class="cx"> <key>EnableSACLs</key>
</span><span class="cx"> <false/>
</span><span class="cx">
</span></span></pre></div>
<a id="CalendarServertrunktwistedcaldavstdconfigpy"></a>
<div class="modfile"><h4>Modified: CalendarServer/trunk/twistedcaldav/stdconfig.py (15695 => 15696)</h4>
<pre class="diff"><span>
<span class="info">--- 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)
</span><span class="lines">@@ -278,15 +278,15 @@
</span><span class="cx"> #
</span><span class="cx"> # Data store
</span><span class="cx"> #
</span><del>- "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",
</del><ins>+ "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
</ins><span class="cx">
</span><span class="cx"> #
</span><span class="cx"> # Quotas
</span><span class="lines">@@ -413,9 +413,9 @@
</span><span class="cx"> # Logging
</span><span class="cx"> #
</span><span class="cx"> "AccessLogFile" : "access.log", # Apache-style access log
</span><del>- "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
</del><ins>+ "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)
</ins><span class="cx"> "ErrorLogEnabled" : True, # True = use log file, False = stdout
</span><span class="cx"> "ErrorLogRotateMB" : 10, # Rotate error log after so many megabytes
</span><span class="cx"> "ErrorLogMaxRotatedFiles" : 5, # Retain this many error log files
</span><span class="lines">@@ -424,9 +424,9 @@
</span><span class="cx"> "RotateAccessLog" : False,
</span><span class="cx"> "EnableExtendedAccessLog": True,
</span><span class="cx"> "EnableExtendedTimingAccessLog": False,
</span><del>- "DefaultLogLevel" : "",
- "LogLevels" : {},
- "LogID" : "",
</del><ins>+ "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
</ins><span class="cx">
</span><span class="cx"> "AccountingCategories": {
</span><span class="cx"> "HTTP": False, # Log regular HTTP requests
</span><span class="lines">@@ -440,7 +440,7 @@
</span><span class="cx"> "migration": False, # Log cross-pod migration details
</span><span class="cx"> },
</span><span class="cx"> "AccountingPrincipals": [],
</span><del>- "AccountingLogRoot" : "accounting",
</del><ins>+ "AccountingLogRoot" : "accounting", # The parent directory for accounting log directories (by default, relative to LogRoot)
</ins><span class="cx">
</span><span class="cx"> "Stats" : {
</span><span class="cx"> "EnableUnixStatsSocket" : False,
</span><span class="lines">@@ -496,7 +496,7 @@
</span><span class="cx"> "ResidentOnly" : True, # True: only take into account resident memory; False: include virtual memory
</span><span class="cx"> },
</span><span class="cx">
</span><del>- "EnableSACLs": False, # Service ACLs
</del><ins>+ "EnableSACLs": False, # If enabled, will honor macOS Server ACLs to control access
</ins><span class="cx">
</span><span class="cx"> "EnableReadOnlyServer": False, # Make all data read-only
</span><span class="cx">
</span></span></pre>
</div>
</div>
</body>
</html>