granicus.if.org Git - apache/blob - docs/manual/mod/mod_systemd.xml

   1 <?xml version="1.0"?>
   2 <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
   3 <?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
   4 <!-- $LastChangedRevision$ -->
   5
   6 <!--
   7  Licensed to the Apache Software Foundation (ASF) under one or more
   8  contributor license agreements.  See the NOTICE file distributed with
   9  this work for additional information regarding copyright ownership.
  10  The ASF licenses this file to You under the Apache License, Version 2.0
  11  (the "License"); you may not use this file except in compliance with
  12  the License.  You may obtain a copy of the License at
  13
  14      http://www.apache.org/licenses/LICENSE-2.0
  15
  16  Unless required by applicable law or agreed to in writing, software
  17  distributed under the License is distributed on an "AS IS" BASIS,
  18  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  19  See the License for the specific language governing permissions and
  20  limitations under the License.
  21 -->
  22
  23 <modulesynopsis metafile="mod_systemd.xml.meta">
  24
  25 <name>mod_systemd</name>
  26 <description>Provides better support for systemd integration</description>
  27 <status>Extension</status>
  28 <sourcefile>mod_systemd.c</sourcefile>
  29 <identifier>systemd_module</identifier>
  30
  31 <summary>
  32     <p>This module provides support for systemd integration. It allows
  33     starting httpd as a service with systemd <code>Type=notify</code>
  34     (see systemd.service(5) manual page for more information). It also
  35     provides statistics in <code>systemctl status</code> output and adds
  36     various directives useful for systemd integration.
  37     </p>
  38 </summary>
  39
  40 <directivesynopsis>
  41 <name>IdleShutdown</name>
  42 <description>Enable shutting down the httpd when it is idle for some time.</description>
  43 <syntax>IdleShutdown seconds</syntax>
  44 <default>IdleShutdown 0</default>
  45 <contextlist><context>server config</context></contextlist>
  46
  47 <usage>
  48     <p>The <directive>IdleShutdown</directive> directive enables shutting
  49     down the httpd when it is idle for some time. The idleness is based on
  50     bytes served, so if there are no bytes sent for some time defined by this
  51     directive, httpd will shutdown. By default, IdleShutdown is set to 0
  52     meaning this feature is disabled.
  53     </p>
  54
  55     <p>This feature is useful in a combination with systemd socket activation
  56     (see systemd.socket(5) manual page). When httpd is started by systemd on
  57     some request, using this directive you can stop the httpd automatically
  58     when all the requests are served.
  59     </p>
  60
  61     <note type="warning"><title>Implementation warning</title><p>
  62     Because of implementation details, idleness is checked only every 10
  63     seconds. That means that if you specify <code>IdleShutdown 14</code>,
  64     httpd will stop itself after 20 seconds of idleness.
  65     </p></note>
  66 </usage>
  67 </directivesynopsis>
  68
  69
  70 </modulesynopsis>