/usr/share/doc/socklog/configuration.html is in socklog 2.1.0-8.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 | <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
<html>
<head>
<title>socklog - configuration</title>
</head>
<body>
<a href="http://smarden.org/pape/">G. Pape</a><br>
<a href="index.html">socklog</a><br>
<hr>
<h1>socklog - configuration</h1>
<hr>
The <i>socklog-unix</i> service listens on the unix domain socket
<tt>/dev/log</tt>. Usually this service replaces the <i>syslogd</i>
system log daemon.
<p>
The <i>socklog-inet</i> service listens on the UDP port
<tt>0.0.0.0:514</tt>. Usually this service replaces <i>syslogd</i>'s
support for remote logging.
<p>
The <i>socklog-klog</i> service reads kernel messages from
<tt>/proc/kmsg</tt> on Linux or <tt>/dev/klog</tt> on BSD. Usually this
service replaces <i>klogd</i> on Linux or <i>syslogd</i> on BSD.
<p>
The <i>socklog-ucspi-tcp</i> service listens on the TCP port
<tt>0.0.0.0:10116</tt>, this is a server for
<a href="network.html">socklog network logging</a>, a different remote
logging concept.
<p>
The <i>socklog-notify</i> handles
<a href="notify.html">log event notification</a>, scheduled notification
of specified log entries.
<hr>
<h2>How to configure the socklog services</h2>
<a href="#unix">The socklog-unix service</a><br>
<a href="#inet">The socklog-inet service</a><br>
<a href="#klog">The socklog-klog service</a><br>
<a href="#ucspi-tcp">The socklog-ucspi-tcp service</a><br>
<a href="#notify">The socklog-notify service</a><br><br>
<a href="http://cr.yp.to/daemontools/faq/create.html#remove">
Removing socklog services</a>
<hr>
<h3><a name="unix">The socklog-unix service</a></h3>
Before starting the <i>socklog-unix</i> service, you will have to make two
decisions:
<ul>
<li>The <i>socklog-unix</i> account name, normally <tt>nobody</tt>. The
<tt>socklog</tt> program runs under this account. If this account does not
exist, create it now.
<li>The <i>socklog</i> account name, normally <tt>log</tt>. Logging
programs run under this account. If this account does not exist, create
it now.
</ul>
Create the service directory and log directories by running the
<a href="socklog-conf.8.html"><tt>socklog-conf</tt></a> program:
<pre>
# socklog-conf unix nobody log
</pre>
If you are replacing another service providing system logging through the
socket <tt>/dev/log</tt>, such as <i>syslogd</i>, stop this service now and
ensure that it will not be restarted on runlevel change or system reboot.
<p>
Tell <a href="http://smarden.org/runit/runsvdir.8.html">runsvdir</a> about
the new service:
<pre>
# ln -s /etc/sv/socklog-unix /var/service/
</pre>
Wait five seconds for the service to start and then check the log
directories, e.g.:
<pre>
# less /var/log/socklog/main/current
</pre>
Optionally configure the <i>socklog-unix</i> service by
<a href="http://cr.yp.to/daemontools/faq/create.html#upgrade">editing</a>
the corresponding <tt>run</tt> scripts and <tt>config</tt> files:
<ul>
<li>/var/service/socklog-unix/run
<li>/var/service/socklog-unix/log/run
<li>/var/log/socklog/*/config
</ul>
<hr>
<h3><a name="inet">The socklog-inet service</a></h3>
Before starting the <i>socklog-inet</i> service, you will have to make two
decisions:
<ul>
<li>The <i>socklog-inet</i> account name, normally <tt>nobody</tt>. The
<tt>socklog</tt> program runs under this account. If this account does not
exist, create it now.
<li>The <i>socklog</i> account name, normally <tt>log</tt>. Logging
programs run under this account. If this account does not exist, create
it now.
</ul>
Create the service directory and log directories by running the
<a href="socklog-conf.8.html"><tt>socklog-conf</tt></a> program:
<pre>
# socklog-conf inet nobody log
</pre>
If you are replacing another service providing system logging through the
syslog UDP port 514, such as <i>syslogd</i>, stop this service now and ensure
that it will not be restarted on runlevel change or system reboot.
<p>
Tell <a href="http://smarden.org/runit/runsvdir.8.html">runsvdir</a> about
the new service:
<pre>
# ln -s /etc/sv/socklog-inet /var/service/
</pre>
Wait five seconds for the service to start and then check the log
directory:
<pre>
# less /var/log/socklog-inet/main/current
</pre>
Optionally configure the <i>socklog-inet</i> service by
<a href="http://cr.yp.to/daemontools/faq/create.html#upgrade">editing</a>
the corresponding <tt>run</tt> scripts and <tt>config</tt> file:
<ul>
<li>/var/service/socklog-inet/run
<li>/var/service/socklog-inet/log/run
<li>/var/log/socklog-inet/main/config
</ul>
<hr>
<h3><a name="klog">The socklog-klog service</a></h3>
Before starting the <i>socklog-klog</i> service, you will have to make two
decisions:
<ul>
<li>The <i>socklog-klog</i> account name, normally <tt>nobody</tt>. The
<tt>socklog</tt> program runs under this account. If this account does not
exist, create it now.
<li>The <i>socklog</i> account name, normally <tt>log</tt>. Logging
programs run under this account. If this account does not exist, create
it now.
</ul>
Create the service directory and log directories by running the
<a href="socklog-conf.8.html"><tt>socklog-conf</tt></a> program:
<pre>
# socklog-conf klog nobody log
</pre>
If you are replacing another service providing kernel logging, such as
<i>klogd</i> on Linux or <i>syslogd</i> on BSD, stop this service now and
ensure that it will not be restarted on runlevel change or system reboot.
<p>
Tell <a href="http://smarden.org/runit/runsvdir.8.html">runsvdir</a> about
the new service:
<pre>
# ln -s /etc/sv/socklog-klog /var/service/
</pre>
Wait five seconds for the service to start and then check the log
directory:
<pre>
# less /var/log/socklog-klog/main/current
</pre>
Optionally configure the <i>socklog-klog</i> service by
<a href="http://cr.yp.to/daemontools/faq/create.html#upgrade">editing</a>
the corresponding <tt>run</tt> scripts and <tt>config</tt> file:
<ul>
<li>/var/service/socklog-klog/run
<li>/var/service/socklog-klog/log/run
<li>/var/log/socklog-klog/config
</ul>
<hr>
<h3><a name="ucspi-tcp">The socklog-ucspi-tcp service</a></h3>
Before starting the <i>socklog-ucspi-tcp</i> service</a>, you will have
to make two decisions:
<ul>
<li>The <i>socklog-ucspi-tcp</i> account name, normally <tt>nobody</tt>.
The <tt>socklog</tt> program runs under this account. If this account
does not exist, create it now.
<li>The <i>socklog</i> account name, normally <tt>log</tt>. Logging
programs run under this account. If this account does not exist, create
it now.
</ul>
Make sure that you have the <a href="http://smarden.org/ipsvd/">ipsvd</a>
package installed.
Then create the service directory and log directories by running the
<a href="socklog-conf.8.html"><tt>socklog-conf</tt></a> program:
<pre>
# socklog-conf ucspi-tcp nobody log
</pre>
Tell <a href="http://smarden.org/runit/runsvdir.8.html">runsvdir</a> about
the new service:
<pre>
# ln -s /etc/sv/socklog-ucspi-tcp /var/service/
</pre>
Wait five seconds for the service to start and then check the log
directory:
<pre>
# less /var/log/socklog-ucspi-tcp/main/current
</pre>
Optionally configure the <i>socklog-ucspi-tcp</i> service by
<a href="http://cr.yp.to/daemontools/faq/create.html#upgrade">editing</a>
the corresponding <tt>run</tt> scripts and <tt>config</tt> file:
<ul>
<li>/var/service/socklog-ucspi-tcp/run
<li>/var/service/socklog-ucspi-tcp/log/run
<li>/var/log/socklog-ucspi-tcp/main/config
</ul>
Refer to <a href="network.html">Network logging</a> for setting up clients.
<hr>
<h3><a name="notify">The socklog-notify service</a></h3>
Before starting the <i>socklog-notify</i> service</a>, you will have to
make two decisions:
<ul>
<li>The <i>socklog</i> account name, normally <tt>log</tt>. The
<tt>uncat</tt> program runs under this account. If this account does not
exist, create it now.
<li>The <i>socklog</i> group name, normally <tt>adm</tt>. Logging
programs that report <a href="notify.html">log events</a> to the
<i>socklog-notify</i> service must run under an account that is member
of this group. If this group does not exist, create it now.
</ul>
Create the service directory by running the
<a href="socklog-conf.8.html"><tt>socklog-conf</tt></a> program:
<pre>
# socklog-conf notify log adm
</pre>
Tell <a href="http://smarden.org/runit/runsvdir.8.html">runsvdir</a> about
the new service:
<pre>
# ln -s /etc/sv/socklog-notify /var/service/
</pre>
Wait five seconds for the service to start, you can test the service with:
<pre>
# echo test | tai64n > /var/log/socklog/.notify
</pre>
Optionally configure the <i>socklog-notify</i> service by
<a href="http://cr.yp.to/daemontools/faq/create.html#upgrade">editing</a>
the corresponding <tt>run</tt> script:
<ul>
<li>/var/service/socklog-notify/run
</ul>
Read <a href="notify.html">Log events notification</a> before disabling this
service and for configuring arbitrary log services to notify events.
<hr>
<address><a href="mailto:pape@smarden.org">
Gerrit Pape <pape@smarden.org>
</a></address>
<small>$Id: configuration.html,v 1.26 2006/03/06 12:56:33 pape Exp $</small>
</body>
</html>
|