File: socklog-conf.8.html

package info (click to toggle)
socklog 2.1.2%2Brepack-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,056 kB
  • sloc: ansic: 3,356; sh: 388; makefile: 316
file content (131 lines) | stat: -rw-r--r-- 6,191 bytes parent folder | download
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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">


<html>
<head>
<title>socklog-conf(8) manual page</title>
</head>
<body bgcolor='white'>
<a href='https://smarden.org/pape/'>G. Pape</a><br><a href='index.html'>socklog</A><hr><p>

<h2><a name='sect0'>Name</a></h2>
socklog-conf - sets up a <i>socklog(8)</i> service. 
<h2><a name='sect1'>Synopsis</a></h2>
<b>socklog-conf</b> unix|inet|klog|ucspi-tcp
<i>acct</i> <i>logacct</i> <br>
<b>socklog-conf</b> notify <i>acct</i> <i>grp</i> 
<h2><a name='sect2'>Description</a></h2>
<b>socklog-conf</b> creates <i>/etc/sv</i> if necessary
and a subdirectory that runs the <b>unix</b>, <b>inet</b>, <b>ucspi-tcp</b> or <b>notify</b> service
(see below for each service). Except for the notify service, <b>socklog-conf</b>
also creates a log directory with subdirectories. <p>
<i>acct</i>, <i>logacct</i> and <i>grp</i>
must not contain any special characters. 
<h2><a name='sect3'>UNIX Service</a></h2>
<b>socklog-conf</b> unix <i>acct</i>
<i>logacct</i> <p>
Running <b>socklog-conf</b> with the 1st argument <i>unix</i>, <b>socklog-conf</b> creates
the service directory <i>/etc/sv/socklog-unix</i> and the log directory <i>/var/log/socklog</i>.
<p>
<b>socklog-conf</b> arranges for <i><b>socklog</b>(8)</i> to run under the uid and gid of <i>acct</i>
and to listen for syslog messages on <i>/dev/log</i>. <p>
It also creates automatically
rotated log directories in <i>/var/log/socklog</i>. The logs are owned by <i>logacct</i>.
The corresponding <i><b>svlogd</b>(8)</i> process runs under the uid and gid of <i>logacct</i>.
<p>
You can run the service under <i><b>runsvdir</b>(8)</i> by creating a symbolic link in
the service directory: <p>
ln -s /etc/sv/socklog-unix /var/service/ <p>

<h2><a name='sect4'>Inet Service</a></h2>
<b>socklog-conf</b>
inet <i>acct</i> <i>logacct</i> <p>
Running <b>socklog-conf</b> with the 1st argument <i>inet</i>, <b>socklog-conf</b>
creates the service directory <i>/etc/sv/socklog-inet</i> and the log directory
<i>/var/log/socklog-inet</i>. <p>
<b>socklog-conf</b> arranges for <i><b>socklog</b>(8)</i> to run under the
uid and gid of <i>acct</i> and to listen for syslog messages on the UDP socket
<i>0.0.0.0:514</i>. <p>
It also creates automatically rotated log directories in <i>/var/log/socklog-inet</i>.
The logs are owned by <i>logacct</i>. The corresponding <i><b>svlogd</b>(8)</i> process runs
under the uid and gid of <i>logacct</i>. <p>
You can run the service under <i><b>runsvdir</b>(8)</i>
by creating a symbolic link in the service directory: <p>
ln -s /etc/sv/socklog-inet
/var/service/ <p>

<h2><a name='sect5'>Klog Service</a></h2>
<b>socklog-conf</b> klog <i>acct</i> <i>logacct</i> <p>
Running <b>socklog-conf</b>
with the 1st argument <i>klog</i>, <b>socklog-conf</b> creates the service directory <i>/etc/sv/socklog-klog</i>
and the log directory <i>/var/log/socklog-klog</i>. <p>
<b>socklog-conf</b> arranges for <i><b>socklog</b>(8)</i>
to run under the uid and gid of <i>acct</i> and to read kernel messages from <i>/proc/kmsg</i>
on Linux, or <i>/dev/socklog-klog</i> on BSD. <p>
It also creates automatically rotated
log directories in <i>/var/log/socklog-klog</i>. The logs are owned by <i>logacct</i>. The
corresponding <i><b>svlogd</b>(8)</i> process runs under the uid and gid of <i>logacct</i>. <p>
You
can run the service under <i><b>runsvdir</b>(8)</i> by creating a symbolic link in the
service directory: <p>
ln -s /etc/sv/socklog-klog /var/service/ <p>

<h2><a name='sect6'>Ucspi-tcp Service</a></h2>
<b>socklog-conf</b>
ucspi-tcp <i>acct</i> <i>logacct</i> <p>
Running <b>socklog-conf</b> with the 1st argument <i>ucspi-tcp</i>,
<b>socklog-conf</b> creates the service directory <i>/etc/sv/socklog-ucspi-tcp</i> and the
log directory <i>/var/log/socklog-ucspi-tcp</i>. <p>
<b>socklog-conf</b> arranges for <i><b>tcpsvd</b>(1)</i>
to run <i><b>socklog</b>(8)</i> under the uid and gid of <i>acct</i> and to listen on the TCP
socket <i>0.0.0.0:10116</i>. <p>
It also creates automatically rotated log directories
in <i>/var/log/socklog-ucspi-tcp</i>. The logs are owned by <i>logacct</i>. The corresponding
<i><b>svlogd</b>(8)</i> process runs under the uid and gid of <i>logacct</i>. <p>
You can run the
service under <i><b>runsvdir</b>(8)</i> by creating a symbolic link in the service directory:
<p>
ln -s /etc/sv/socklog-ucspi-tcp /var/service/ <p>

<h2><a name='sect7'>Notify Service</a></h2>
<b>socklog-conf</b> notify
<i>acct</i> <i>grp</i> <p>
Running <b>socklog-conf</b> with the 1st argument <i>notify</i>, <b>socklog-conf</b>
creates the service directory <i>/etc/sv/socklog-notify</i>. <p>
<b>socklog-conf</b> arranges
for <i><b>uncat</b>(1)</i> to run under the uid and gid of <i>acct</i> and to listen on the
named pipe <i>/var/log/socklog/.notify</i>. The named pipe will have mode 0620,
the uid of <i>acct</i> and the gid of <i>grp</i>. <p>
All uids running a log service that
is configured to push log events to the socklog-notify service must be member
of the group <i>grp</i>. <p>
You can run the service under <i><b>runsvdir</b>(8)</i> by creating
a symbolic link in the service directory: <p>
ln -s /etc/sv/socklog-notify /var/service/
<p>

<h2><a name='sect8'>See Also</a></h2>
<i>socklog(8)</i>, <i>svlogd(8)</i>, <i>nc(1)</i>, <i>tryto(1)</i>, <i>uncat(1)</i>, <i>socklog-check(8)</i>,
<i>tcpsvd(8)</i>, <i>sv(8)</i>, <i>runsv(8)</i>, <i>runsvdir(8)</i> <p>
 <i>https://smarden.org/socklog/</i><br>
  <i>https://smarden.org/runit/</i><br>
 
<h2><a name='sect9'>Author</a></h2>
Gerrit Pape &lt;pape@smarden.org&gt; <p>

<hr><p>
<a name='toc'><b>Table of Contents</b></a><p>
<ul>
<li><a name='toc0' href='#sect0'>Name</a></li>
<li><a name='toc1' href='#sect1'>Synopsis</a></li>
<li><a name='toc2' href='#sect2'>Description</a></li>
<li><a name='toc3' href='#sect3'>UNIX Service</a></li>
<li><a name='toc4' href='#sect4'>Inet Service</a></li>
<li><a name='toc5' href='#sect5'>Klog Service</a></li>
<li><a name='toc6' href='#sect6'>Ucspi-tcp Service</a></li>
<li><a name='toc7' href='#sect7'>Notify Service</a></li>
<li><a name='toc8' href='#sect8'>See Also</a></li>
<li><a name='toc9' href='#sect9'>Author</a></li>
</ul>
</body>
</html>