summaryrefslogtreecommitdiffstats
path: root/docs/manual/mod/mod_systemd.xml
blob: cf90cd13ff22b53ed21d825c18549beda1b8623c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
<?xml version="1.0"?>
<!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
<?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
<!-- $LastChangedRevision$ -->

<!--
 Licensed to the Apache Software Foundation (ASF) under one or more
 contributor license agreements.  See the NOTICE file distributed with
 this work for additional information regarding copyright ownership.
 The ASF licenses this file to You under the Apache License, Version 2.0
 (the "License"); you may not use this file except in compliance with
 the License.  You may obtain a copy of the License at

     http://www.apache.org/licenses/LICENSE-2.0

 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
-->

<modulesynopsis metafile="mod_systemd.xml.meta">

<name>mod_systemd</name>
<description>Provides better support for systemd integration</description>
<status>Extension</status>
<sourcefile>mod_systemd.c</sourcefile>
<identifier>systemd_module</identifier>

<summary>
    <p>This module provides support for systemd integration. It allows
    starting httpd as a service with systemd <code>Type=notify</code>
    (see systemd.service(5) manual page for more information). It also
    provides statistics in <code>systemctl status</code> output and adds
    various directives useful for systemd integration.
    </p>
</summary>

<directivesynopsis>
<name>IdleShutdown</name>
<description>Enable shutting down the httpd when it is idle for some time.</description>
<syntax>IdleShutdown seconds</syntax>
<default>IdleShutdown 0</default>
<contextlist><context>server config</context></contextlist>

<usage>
    <p>The <directive>IdleShutdown</directive> directive enables shutting
    down the httpd when it is idle for some time. The idleness is based on
    bytes served, so if there are no bytes sent for some time defined by this
    directive, httpd will shutdown. By default, IdleShutdown is set to 0
    meaning this feature is disabled.
    </p>

    <p>This feature is useful in a combination with systemd socket activation
    (see systemd.socket(5) manual page). When httpd is started by systemd on
    some request, using this directive you can stop the httpd automatically
    when all the requests are served.
    </p>

    <note type="warning"><title>Implementation warning</title><p>
    Because of implementation details, idleness is checked only every 10
    seconds. That means that if you specify <code>IdleShutdown 14</code>,
    httpd will stop itself after 20 seconds of idleness.
    </p></note>
</usage>
</directivesynopsis>


</modulesynopsis>