956 lines
54 KiB
HTML
956 lines
54 KiB
HTML
<!doctype html>
|
||
|
||
<html lang="en">
|
||
<head>
|
||
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||
|
||
<title>caps — CAPS: Common Acquisition Protocol Server documentation</title>
|
||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||
<link rel="stylesheet" href="../_static/gempa.css" type="text/css" />
|
||
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
|
||
<link rel="stylesheet" type="text/css" href="../_static/gempa.css?v=c960eebf" />
|
||
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
|
||
<script type="text/javascript" src="../_static/gempa.js"></script>
|
||
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=b3ba4146"></script>
|
||
<script src="../_static/doctools.js?v=888ff710"></script>
|
||
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
|
||
<link rel="index" title="Index" href="../genindex.html" />
|
||
<link rel="search" title="Search" href="../search.html" />
|
||
</head>
|
||
<body>
|
||
<div class="header">
|
||
<div class="container">
|
||
<img class="background" src="../_static/icon.png"/>
|
||
<div class="content">
|
||
<span class="title">CAPS: Common Acquisition Protocol Server </span>
|
||
<span class="version">2025.254#f0c77b29e</span></h1>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="nav">
|
||
<div class="container">
|
||
<div class="content"><a class="pull-right" id="sidebar-toggle">TOC</a>
|
||
|
||
<div class="related" role="navigation" aria-label="related navigation">
|
||
<ul>
|
||
<li class="right">
|
||
<a href="../genindex.html" title="General Index"
|
||
accesskey="I">
|
||
index
|
||
</a>
|
||
</li>
|
||
<li class="nav-item nav-item-0">
|
||
<a href="../index.html">Home</a>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="container">
|
||
<div class="fitted content" id="anchors-container">
|
||
<div class="body" role="main">
|
||
|
||
<section id="caps">
|
||
<span id="id1"></span><h1>caps<a class="headerlink" href="#caps" title="Permalink to this heading">¶</a></h1>
|
||
<p><strong>Realtime and archive waveform server</strong></p>
|
||
<section id="module-configuration">
|
||
<h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading">¶</a></h2>
|
||
<div class="line-block">
|
||
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/global.cfg</span></code></div>
|
||
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/caps.cfg</span></code></div>
|
||
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/global.cfg</span></code></div>
|
||
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/caps.cfg</span></code></div>
|
||
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/global.cfg</span></code></div>
|
||
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/caps.cfg</span></code></div>
|
||
</div>
|
||
<p>caps inherits <a class="reference internal" href="global.html#global-configuration"><span class="std std-ref">global options</span></a>.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>Modules/plugins may require a license file. The default path to license
|
||
files is <code class="file docutils literal notranslate"><span class="pre">@DATADIR@/licenses/</span></code> which can be overridden by global
|
||
configuration of the parameter <code class="xref std std-confval docutils literal notranslate"><span class="pre">gempa.licensePath</span></code>. Example:</p>
|
||
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>gempa.licensePath = @CONFIGDIR@/licenses
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
<div class="admonition note" id="as">
|
||
<p class="admonition-title">Note</p>
|
||
<p><strong>AS.*</strong>
|
||
<em>CAPS server control parameters</em></p>
|
||
</div>
|
||
<dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-AS.filebase">
|
||
<span class="sig-name descname"><span class="pre">AS.filebase</span></span><a class="headerlink" href="#confval-AS.filebase" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">@ROOTDIR@/var/lib/caps/archive</span></code></p>
|
||
<p>Type: <em>string</em></p>
|
||
<p>Defines the path to the archive directory.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-AS.port">
|
||
<span class="sig-name descname"><span class="pre">AS.port</span></span><a class="headerlink" href="#confval-AS.port" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">18002</span></code></p>
|
||
<p>Type: <em>int</em></p>
|
||
<p>Defines the server port for client requests.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-AS.clientBufferSize">
|
||
<span class="sig-name descname"><span class="pre">AS.clientBufferSize</span></span><a class="headerlink" href="#confval-AS.clientBufferSize" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">16384</span></code></p>
|
||
<p>Unit: <em>B</em></p>
|
||
<p>Type: <em>int</em></p>
|
||
<p>Size of the client buffer in bytes. In case the client fails to read the buffered data
|
||
in time (buffer overflow) the connection falls back to archive requests.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-AS.minDelay">
|
||
<span class="sig-name descname"><span class="pre">AS.minDelay</span></span><a class="headerlink" href="#confval-AS.minDelay" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">-1</span></code></p>
|
||
<p>Unit: <em>s</em></p>
|
||
<p>Type: <em>int</em></p>
|
||
<p>Limits the retrieval of real-time data. The value
|
||
specifies the maximum relative end time of the time range
|
||
to be requested. The maximum absolute end time is
|
||
now - minDelay. This is only valid for FDSNWS and WWS.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-AS.inventory">
|
||
<span class="sig-name descname"><span class="pre">AS.inventory</span></span><a class="headerlink" href="#confval-AS.inventory" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Type: <em>path</em></p>
|
||
<p>The path to an optional inventory XML file with SeisComP3
|
||
schema. This inventory information is used by WWS to populate
|
||
the channel coordinates. In future possibly more endpoints
|
||
will make use of it.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-AS.logRequests">
|
||
<span class="sig-name descname"><span class="pre">AS.logRequests</span></span><a class="headerlink" href="#confval-AS.logRequests" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
|
||
<p>Type: <em>boolean</em></p>
|
||
<p>Whether to maintain a request log file or not. Each request
|
||
will be logged and partly traced.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-AS.logAnonymousIP">
|
||
<span class="sig-name descname"><span class="pre">AS.logAnonymousIP</span></span><a class="headerlink" href="#confval-AS.logAnonymousIP" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
|
||
<p>Type: <em>boolean</em></p>
|
||
<p>Log only parts of the IP to respect users privacy.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-AS.logPurge">
|
||
<span class="sig-name descname"><span class="pre">AS.logPurge</span></span><a class="headerlink" href="#confval-AS.logPurge" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
|
||
<p>Type: <em>boolean</em></p>
|
||
<p>Whether to maintain a purge log file or not. Each purge
|
||
operation will be logged.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-AS.allow">
|
||
<span class="sig-name descname"><span class="pre">AS.allow</span></span><a class="headerlink" href="#confval-AS.allow" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Type: <em>list:string</em></p>
|
||
<p>List of IPs which are allowed to access the caps(s) port.
|
||
By default access is unrestricted.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-AS.deny">
|
||
<span class="sig-name descname"><span class="pre">AS.deny</span></span><a class="headerlink" href="#confval-AS.deny" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Type: <em>list:string</em></p>
|
||
<p>List of IPs which are not allowed to access the caps(s) port.
|
||
By default access is unrestricted.</p>
|
||
</dd></dl>
|
||
|
||
<div class="admonition note" id="as-filebase">
|
||
<p class="admonition-title">Note</p>
|
||
<p><strong>AS.filebase.*</strong>
|
||
<em>File buffer control parameters</em></p>
|
||
</div>
|
||
<dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-AS.filebase.logFile">
|
||
<span class="sig-name descname"><span class="pre">AS.filebase.logFile</span></span><a class="headerlink" href="#confval-AS.filebase.logFile" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Type: <em>path</em></p>
|
||
<p>The path to the archive log file which contains the
|
||
stream start and end times. By default it is written
|
||
to $filebase/archive.log.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-AS.filebase.keep">
|
||
<span class="sig-name descname"><span class="pre">AS.filebase.keep</span></span><a class="headerlink" href="#confval-AS.filebase.keep" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">*.*.*.*:-1</span></code></p>
|
||
<p>Type: <em>list:string</em></p>
|
||
<p>Number of days to keep data per stream ID before
|
||
"AS.filebase.purge.referenceTime". For
|
||
stream-specific configuration create a list of pairs
|
||
consisting of stream ID : days. Separate pairs by
|
||
comma. The first occurrence in the list takes priority.</p>
|
||
<p>Example keeping all streams but AM.* and GR.* for 14 days:</p>
|
||
<p>GR.*:-1, AM.*.*.*:365, *.*.*.*:14</p>
|
||
<p>Default (empty parameter) or -1: keep all data forever.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-AS.filebase.preallocationSize">
|
||
<span class="sig-name descname"><span class="pre">AS.filebase.preallocationSize</span></span><a class="headerlink" href="#confval-AS.filebase.preallocationSize" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">65535</span></code></p>
|
||
<p>Unit: <em>B</em></p>
|
||
<p>Type: <em>int</em></p>
|
||
<p>Preallocation size of data files in bytes. Some file system allow to reserve
|
||
disk space for files in advance. Especially on spinning disks the read
|
||
performance will be improved if data can be read sequentially. The speed is
|
||
traded for disk space consumed by the file since its size will be a multiple
|
||
of the specified value. Set the value to 0 to disable this feature.</p>
|
||
</dd></dl>
|
||
|
||
<div class="admonition note" id="as-filebase-cache">
|
||
<p class="admonition-title">Note</p>
|
||
<p><strong>AS.filebase.cache.*</strong>
|
||
<em>CAPS does not keep all files of all streams open. It</em>
|
||
<em>tries to keep open the most frequently used files and closes</em>
|
||
<em>all others. The more files CAPS can keep open the faster</em>
|
||
<em>the population of the archive. The limit of open</em>
|
||
<em>files depends on the security settings of the user under</em>
|
||
<em>which CAPS is running.</em></p>
|
||
</div>
|
||
<dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-AS.filebase.cache.openFileLimit">
|
||
<span class="sig-name descname"><span class="pre">AS.filebase.cache.openFileLimit</span></span><a class="headerlink" href="#confval-AS.filebase.cache.openFileLimit" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">250</span></code></p>
|
||
<p>Type: <em>int</em></p>
|
||
<p>The maximum number of open files. Because a stream
|
||
file can have an associated index file this value
|
||
is half of the physically opened files in worst case.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-AS.filebase.cache.unusedFileLimit">
|
||
<span class="sig-name descname"><span class="pre">AS.filebase.cache.unusedFileLimit</span></span><a class="headerlink" href="#confval-AS.filebase.cache.unusedFileLimit" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">1000</span></code></p>
|
||
<p>Type: <em>int</em></p>
|
||
<p>Limit of cached files in total. This value affects also
|
||
files that are actually explicitly closed by the
|
||
application. CAPS will keep them open (respecting
|
||
the openFileLimit parameter) as long as possible and
|
||
preserve a file handle to speed up reopening the
|
||
file later.</p>
|
||
</dd></dl>
|
||
|
||
<span class="target" id="as-filebase-params"></span><dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-AS.filebase.params.writeMetaOnClose">
|
||
<span class="sig-name descname"><span class="pre">AS.filebase.params.writeMetaOnClose</span></span><a class="headerlink" href="#confval-AS.filebase.params.writeMetaOnClose" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
|
||
<p>Type: <em>boolean</em></p>
|
||
<p>This is an optimization to write the datafile meta record only
|
||
on file close and not every time a new record has been added
|
||
to a file. To save IO bandwidth when handling many channels,
|
||
this could be helpful.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-AS.filebase.params.alignIndexPages">
|
||
<span class="sig-name descname"><span class="pre">AS.filebase.params.alignIndexPages</span></span><a class="headerlink" href="#confval-AS.filebase.params.alignIndexPages" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
|
||
<p>Type: <em>boolean</em></p>
|
||
<p>This forces to align index pages in the file at 4k boundaries.
|
||
In order to achieve that, NULL chunks must be inserted to
|
||
allow padding. This will lead to less device page updates
|
||
but slightly larger data files.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-AS.filebase.params.priority">
|
||
<span class="sig-name descname"><span class="pre">AS.filebase.params.priority</span></span><a class="headerlink" href="#confval-AS.filebase.params.priority" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">0</span></code></p>
|
||
<p>Type: <em>int</em></p>
|
||
<p>A value greater than 0 will raise the write thread
|
||
priority to the given value. This value is in
|
||
accordance to the pthread_setschedparam function.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-AS.filebase.params.q">
|
||
<span class="sig-name descname"><span class="pre">AS.filebase.params.q</span></span><a class="headerlink" href="#confval-AS.filebase.params.q" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">1000</span></code></p>
|
||
<p>Type: <em>int</em></p>
|
||
<p>The real-time notification queue size.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-AS.filebase.params.concurrency">
|
||
<span class="sig-name descname"><span class="pre">AS.filebase.params.concurrency</span></span><a class="headerlink" href="#confval-AS.filebase.params.concurrency" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">1</span></code></p>
|
||
<p>Type: <em>int</em></p>
|
||
<p>The number of concurrent writes to the database. The
|
||
higher the value the more concurrent write operations
|
||
are issued distributed across the files. A single file
|
||
can only be updated sequentially. This value is most
|
||
effective if many records of different channels are
|
||
pushed, like the output of scmssort.</p>
|
||
</dd></dl>
|
||
|
||
<div class="admonition note" id="as-filebase-purge">
|
||
<p class="admonition-title">Note</p>
|
||
<p><strong>AS.filebase.purge.*</strong>
|
||
<em>Parameters controlling IO resources occupied by the purge operation.</em>
|
||
<em>The deletion of many data files at once may have a significant impact</em>
|
||
<em>on the server performance. E.g. if the server did not run for a while</em>
|
||
<em>or the keep parameter was reduced significantly, the purge operation</em>
|
||
<em>may slow down the processing of real-time data.</em></p>
|
||
</div>
|
||
<dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-AS.filebase.purge.referenceTime">
|
||
<span class="sig-name descname"><span class="pre">AS.filebase.purge.referenceTime</span></span><a class="headerlink" href="#confval-AS.filebase.purge.referenceTime" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">EndTime</span></code></p>
|
||
<p>Type: <em>string</em></p>
|
||
<p>Values: <code class="docutils literal notranslate"><span class="pre">EndTime,Now</span></code></p>
|
||
<p>The reference time defining the end of the time window
|
||
to keep the data. The window length is set by
|
||
"AS.filebase.keep".
|
||
Data outside the window will be purged. Available values:</p>
|
||
<p>EndTime: The reference time is the end time per stream.
|
||
This keeps older data if no more recent data arrive.</p>
|
||
<p>Now: The reference time is current time. This
|
||
deletes old data even if no recent data arrive.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-AS.filebase.purge.idleTime">
|
||
<span class="sig-name descname"><span class="pre">AS.filebase.purge.idleTime</span></span><a class="headerlink" href="#confval-AS.filebase.purge.idleTime" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">5</span></code></p>
|
||
<p>Unit: <em>s</em></p>
|
||
<p>Type: <em>double</em></p>
|
||
<p>Idle time between two purge runs.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-AS.filebase.purge.initIdleTime">
|
||
<span class="sig-name descname"><span class="pre">AS.filebase.purge.initIdleTime</span></span><a class="headerlink" href="#confval-AS.filebase.purge.initIdleTime" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">0</span></code></p>
|
||
<p>Unit: <em>s</em></p>
|
||
<p>Type: <em>double</em></p>
|
||
<p>Idle time before the first purge run starts. Normally
|
||
after a start the server tries to catch up all data which
|
||
might be an IO intensive operation. In case of a huge archive the purge
|
||
operation slow downs the read/write performace of the system too. To
|
||
reduce the load at start it is a good idea to postpone this operation.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-AS.filebase.purge.maxProcessTime">
|
||
<span class="sig-name descname"><span class="pre">AS.filebase.purge.maxProcessTime</span></span><a class="headerlink" href="#confval-AS.filebase.purge.maxProcessTime" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">1</span></code></p>
|
||
<p>Unit: <em>s</em></p>
|
||
<p>Type: <em>double</em></p>
|
||
<p>Maximum processing time for one purge run. If exceeded the
|
||
purge task will pause for AS.filebase.purge.idleTime
|
||
seconds freeing IO resources.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-AS.filebase.purge.startTime">
|
||
<span class="sig-name descname"><span class="pre">AS.filebase.purge.startTime</span></span><a class="headerlink" href="#confval-AS.filebase.purge.startTime" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">00:30</span></code></p>
|
||
<p>Type: <em>string</em></p>
|
||
<p>Time of the day when to run the daily purge run. Time is in UTC.</p>
|
||
</dd></dl>
|
||
|
||
<div class="admonition note" id="as-ssl">
|
||
<p class="admonition-title">Note</p>
|
||
<p><strong>AS.SSL.*</strong>
|
||
<em>Parameters for SSL-based data requests</em></p>
|
||
</div>
|
||
<dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-AS.SSL.port">
|
||
<span class="sig-name descname"><span class="pre">AS.SSL.port</span></span><a class="headerlink" href="#confval-AS.SSL.port" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Type: <em>int</em></p>
|
||
<p>Defines the SSL server port for client requests. By default
|
||
SSL requests are disabled.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-AS.SSL.certificate">
|
||
<span class="sig-name descname"><span class="pre">AS.SSL.certificate</span></span><a class="headerlink" href="#confval-AS.SSL.certificate" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Type: <em>string</em></p>
|
||
<p>Defines the path to the SSL certificate to use.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-AS.SSL.key">
|
||
<span class="sig-name descname"><span class="pre">AS.SSL.key</span></span><a class="headerlink" href="#confval-AS.SSL.key" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Type: <em>string</em></p>
|
||
<p>Defines the path to the private SSL key to use. This key
|
||
is not shared with clients.</p>
|
||
</dd></dl>
|
||
|
||
<div class="admonition note" id="as-auth">
|
||
<p class="admonition-title">Note</p>
|
||
<p><strong>AS.auth.*</strong>
|
||
<em>Parameters controlling the authentication system for data requests</em>
|
||
<em>based on user ID, IP addresses, access roles and access control lists.</em></p>
|
||
</div>
|
||
<dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-AS.auth.backend">
|
||
<span class="sig-name descname"><span class="pre">AS.auth.backend</span></span><a class="headerlink" href="#confval-AS.auth.backend" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">basic</span></code></p>
|
||
<p>Type: <em>string</em></p>
|
||
<p>The server provides an authentication plug-in interface. An authentication plugin
|
||
implements access control checks. It is free where it gets the access information from e.g
|
||
from a local database/file or a remote server. The option sets which authentication plugin
|
||
should be used for authentication. Don’t forget to load the plugin in the plugin section.
|
||
The basic plugin is built-in.</p>
|
||
</dd></dl>
|
||
|
||
<div class="admonition note" id="as-auth-basic">
|
||
<p class="admonition-title">Note</p>
|
||
<p><strong>AS.auth.basic.*</strong>
|
||
<em>Basic authentication parameters. The configuration can</em>
|
||
<em>be reloaded without restarting the server. Use</em>
|
||
<em>“seiscomp reload caps`” to reload the</em>
|
||
<em>authentication parameters without a restart.</em></p>
|
||
</div>
|
||
<dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-AS.auth.basic.access-list">
|
||
<span class="sig-name descname"><span class="pre">AS.auth.basic.access-list</span></span><a class="headerlink" href="#confval-AS.auth.basic.access-list" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">@SYSTEMCONFIGDIR@/caps/access.cfg</span></code></p>
|
||
<p>Type: <em>file</em></p>
|
||
<p>Path to the access control list controlling access based on rules.
|
||
By default access is unrestricted. Allow rules are evaluated first.</p>
|
||
<p>AM.DENY = 127.0.0.1</p>
|
||
<p>AM.ALLOW = 127.0.0.1</p>
|
||
<p>This example rule set prohibits all AM network stations for localhost because
|
||
the DENY rule is evaluated after the ALLOW rule.</p>
|
||
<p>IP restrictions apply to the guest user only. In addition to IPs the access can
|
||
be also restricted by user or group. In the latter case
|
||
the "%" must be placed in front of the group name. Here an example:</p>
|
||
<p>AM.ALLOW = %users</p>
|
||
<p>AM.R44F5.ALLOW = sysop</p>
|
||
<p>Rules are evaluated on the basis of one another. This can lead to misunderstandings. Here an
|
||
example:</p>
|
||
<p>AM.ALLOW = sysop</p>
|
||
<p>This rule will allow the AM network for sysop only. But</p>
|
||
<p>DENY = %users
|
||
AM.ALLOW = sysop</p>
|
||
<p>will allow the access to the AM network for all users except those are member of the group users.</p>
|
||
</dd></dl>
|
||
|
||
<span class="target" id="as-auth-basic-users"></span><dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-AS.auth.basic.users.shadow">
|
||
<span class="sig-name descname"><span class="pre">AS.auth.basic.users.shadow</span></span><a class="headerlink" href="#confval-AS.auth.basic.users.shadow" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">@SYSTEMCONFIGDIR@/caps/shadow.cfg</span></code></p>
|
||
<p>Type: <em>file</em></p>
|
||
<p>Location of the users authentication file. For each user one line
|
||
of the following format must exist:</p>
|
||
<p>username:encrypted_pwd</p>
|
||
<p>To encrypt the password mkpasswd can be used. It is recommended to
|
||
apply a strong algorithm such as sha-256 or sha-512. The command</p>
|
||
<p>u=sysop pw=`mkpasswd -m sha-512` && echo $u:$pw</p>
|
||
<p>generates one line for user "sysop".
|
||
Add the line to the authentication file.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-AS.auth.basic.users.passwd">
|
||
<span class="sig-name descname"><span class="pre">AS.auth.basic.users.passwd</span></span><a class="headerlink" href="#confval-AS.auth.basic.users.passwd" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">@SYSTEMCONFIGDIR@/caps/passwd.cfg</span></code></p>
|
||
<p>Type: <em>file</em></p>
|
||
<p>Location of the users access control file. Each
|
||
line starts with a user ID (uid) or a group ID (gid)
|
||
and a list of access properties in the form:</p>
|
||
<p>uid:prop1,prop2</p>
|
||
<p>or</p>
|
||
<p>%gid:prop1,prop2</p>
|
||
<p>"%" indicates a gid instead of a uid.
|
||
The properties grant access to certain CAPS
|
||
features. Supported access property values are:
|
||
read, write, admin.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-AS.auth.basic.users.group">
|
||
<span class="sig-name descname"><span class="pre">AS.auth.basic.users.group</span></span><a class="headerlink" href="#confval-AS.auth.basic.users.group" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">@SYSTEMCONFIGDIR@/caps/group.cfg</span></code></p>
|
||
<p>Type: <em>file</em></p>
|
||
<p>Location of the optional group file. Each line maps a group id
|
||
to a list of users in format</p>
|
||
<p>gid:user1,user2,user3</p>
|
||
</dd></dl>
|
||
|
||
<span class="target" id="as-plugins"></span><dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-AS.plugins.port">
|
||
<span class="sig-name descname"><span class="pre">AS.plugins.port</span></span><a class="headerlink" href="#confval-AS.plugins.port" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">18003</span></code></p>
|
||
<p>Type: <em>int</em></p>
|
||
<p>Defines the server port to use for plugin connections.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-AS.plugins.allow">
|
||
<span class="sig-name descname"><span class="pre">AS.plugins.allow</span></span><a class="headerlink" href="#confval-AS.plugins.allow" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Type: <em>list:string</em></p>
|
||
<p>List of IPs which are allowed to access the plugin port.
|
||
By default access is unrestricted.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-AS.plugins.deny">
|
||
<span class="sig-name descname"><span class="pre">AS.plugins.deny</span></span><a class="headerlink" href="#confval-AS.plugins.deny" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Type: <em>list:string</em></p>
|
||
<p>List of IPs which are not allowed to access the plugin port.
|
||
By default access is unrestricted.</p>
|
||
</dd></dl>
|
||
|
||
<span class="target" id="as-plugins-ssl"></span><dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-AS.plugins.SSL.port">
|
||
<span class="sig-name descname"><span class="pre">AS.plugins.SSL.port</span></span><a class="headerlink" href="#confval-AS.plugins.SSL.port" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Type: <em>int</em></p>
|
||
<p>Defines the SSL server port to use for plugin SSL connections.
|
||
The SSL port is disabled by default.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-AS.plugins.SSL.certificate">
|
||
<span class="sig-name descname"><span class="pre">AS.plugins.SSL.certificate</span></span><a class="headerlink" href="#confval-AS.plugins.SSL.certificate" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Type: <em>string</em></p>
|
||
<p>Defines the path to the SSL certificate to use.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-AS.plugins.SSL.key">
|
||
<span class="sig-name descname"><span class="pre">AS.plugins.SSL.key</span></span><a class="headerlink" href="#confval-AS.plugins.SSL.key" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Type: <em>string</em></p>
|
||
<p>Defines the path to the private SSL key to use. This key
|
||
is not shared with clients.</p>
|
||
</dd></dl>
|
||
|
||
<div class="admonition note" id="as-http">
|
||
<p class="admonition-title">Note</p>
|
||
<p><strong>AS.http.*</strong>
|
||
<em>Web interface control parameters</em></p>
|
||
</div>
|
||
<dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-AS.http.port">
|
||
<span class="sig-name descname"><span class="pre">AS.http.port</span></span><a class="headerlink" href="#confval-AS.http.port" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Type: <em>int</em></p>
|
||
<p>Defines the server port for HTTP connections. By default the Web interface is disabled.</p>
|
||
<p>Typical value: 18081</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-AS.http.allow">
|
||
<span class="sig-name descname"><span class="pre">AS.http.allow</span></span><a class="headerlink" href="#confval-AS.http.allow" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Type: <em>list:string</em></p>
|
||
<p>List of IPs which are allowed to access the http(s) port.
|
||
By default access is unrestricted.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-AS.http.deny">
|
||
<span class="sig-name descname"><span class="pre">AS.http.deny</span></span><a class="headerlink" href="#confval-AS.http.deny" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Type: <em>list:string</em></p>
|
||
<p>List of IPs which are not allowed to access the http(s) port.
|
||
By default access is unrestricted.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-AS.http.resolveProxyClient">
|
||
<span class="sig-name descname"><span class="pre">AS.http.resolveProxyClient</span></span><a class="headerlink" href="#confval-AS.http.resolveProxyClient" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
|
||
<p>Type: <em>boolean</em></p>
|
||
<p>Sets if the X-Forwarded-For HTTP header is evaluated to
|
||
retrieve the real client IP address from a proxy server.
|
||
This is important if the web frontend is behind a proxy,
|
||
e.g. Apache. Since data access is configured per IP, the
|
||
real IP is required to grant access to requested channels.
|
||
Enabling this opens a possible security hole as clients
|
||
can then easily spoof their IP if the proxy does not
|
||
correctly maintain this header or if CAPS does not run
|
||
behind a proxy.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-AS.http.disableBasicAuthorization">
|
||
<span class="sig-name descname"><span class="pre">AS.http.disableBasicAuthorization</span></span><a class="headerlink" href="#confval-AS.http.disableBasicAuthorization" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
|
||
<p>Type: <em>boolean</em></p>
|
||
<p>Controls whether basic authorization is enabled or not.
|
||
In case you are running CAPS behind a proxy which already
|
||
configures basic authorization then enable this flag.
|
||
If basic authorization is disabled then the default
|
||
HTTP user should have access without a password.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-AS.http.fdsnws">
|
||
<span class="sig-name descname"><span class="pre">AS.http.fdsnws</span></span><a class="headerlink" href="#confval-AS.http.fdsnws" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Type: <em>string</em></p>
|
||
<p>Sets the optional relative FDSNWS path which is being
|
||
used by the CAPS frontend client. Do not append
|
||
"fdsnws/dataselect/1/query" as this is done
|
||
automatically. Set it to "/" if the CAPS
|
||
frontend is running with a relative path behind e.g.
|
||
Nginx.</p>
|
||
</dd></dl>
|
||
|
||
<div class="admonition note" id="as-http-ssl">
|
||
<p class="admonition-title">Note</p>
|
||
<p><strong>AS.http.SSL.*</strong>
|
||
<em>Use https instead of http when setting the following parameters</em></p>
|
||
</div>
|
||
<dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-AS.http.SSL.port">
|
||
<span class="sig-name descname"><span class="pre">AS.http.SSL.port</span></span><a class="headerlink" href="#confval-AS.http.SSL.port" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Type: <em>int</em></p>
|
||
<p>Defines the server port for HTTPS connections.
|
||
By default the SSL Web interface is disabled.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-AS.http.SSL.certificate">
|
||
<span class="sig-name descname"><span class="pre">AS.http.SSL.certificate</span></span><a class="headerlink" href="#confval-AS.http.SSL.certificate" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Type: <em>string</em></p>
|
||
<p>Defines the path to the SSL certificate to use.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-AS.http.SSL.key">
|
||
<span class="sig-name descname"><span class="pre">AS.http.SSL.key</span></span><a class="headerlink" href="#confval-AS.http.SSL.key" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Type: <em>string</em></p>
|
||
<p>Defines the path to the private SSL key to use. This
|
||
key is not shared with clients.</p>
|
||
</dd></dl>
|
||
|
||
<div class="admonition note" id="as-fdsnws">
|
||
<p class="admonition-title">Note</p>
|
||
<p><strong>AS.FDSNWS.*</strong>
|
||
<em>FDSNWS control parameters for dataselect. The FDSNWS service</em>
|
||
<em>is provided through the “AS.http.port”.</em></p>
|
||
</div>
|
||
<dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-AS.FDSNWS.maxTimeWindow">
|
||
<span class="sig-name descname"><span class="pre">AS.FDSNWS.maxTimeWindow</span></span><a class="headerlink" href="#confval-AS.FDSNWS.maxTimeWindow" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">0</span></code></p>
|
||
<p>Unit: <em>s</em></p>
|
||
<p>Type: <em>int</em></p>
|
||
<p>Maximum length of time window per request. A value
|
||
greater than zero limits the maximum request time window
|
||
including all data. 0 disables the limit.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-AS.FDSNWS.maxRequests">
|
||
<span class="sig-name descname"><span class="pre">AS.FDSNWS.maxRequests</span></span><a class="headerlink" href="#confval-AS.FDSNWS.maxRequests" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">1000</span></code></p>
|
||
<p>Type: <em>int</em></p>
|
||
<p>Maximum number of requests per post. A value greater than
|
||
or equal to zero limits the number
|
||
of request lines per POST request.</p>
|
||
</dd></dl>
|
||
|
||
<div class="admonition note" id="as-wws">
|
||
<p class="admonition-title">Note</p>
|
||
<p><strong>AS.WWS.*</strong>
|
||
<em>Winston waveform server (WWS) control parameters. When set,</em>
|
||
<em>CAPS will also serve WWS.</em></p>
|
||
</div>
|
||
<dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-AS.WWS.port">
|
||
<span class="sig-name descname"><span class="pre">AS.WWS.port</span></span><a class="headerlink" href="#confval-AS.WWS.port" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Type: <em>int</em></p>
|
||
<p>Server port for WWS connections. Please note that
|
||
inventory information (see AS.inventory) is required to
|
||
fully support WWS requests otherwise empty values for
|
||
the channel location and unit will be returned.</p>
|
||
<p>Default (no value): The WWS interface is disabled.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-AS.WWS.maxTimeWindow">
|
||
<span class="sig-name descname"><span class="pre">AS.WWS.maxTimeWindow</span></span><a class="headerlink" href="#confval-AS.WWS.maxTimeWindow" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">90000</span></code></p>
|
||
<p>Unit: <em>s</em></p>
|
||
<p>Type: <em>int</em></p>
|
||
<p>Maximum length of time window in seconds per request.
|
||
A value greater than zero limits the maximum request time window
|
||
including all data. 0 disables the limit.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-AS.WWS.maxRequests">
|
||
<span class="sig-name descname"><span class="pre">AS.WWS.maxRequests</span></span><a class="headerlink" href="#confval-AS.WWS.maxRequests" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">100</span></code></p>
|
||
<p>Type: <em>int</em></p>
|
||
<p>A value greater than or equal to zero limits the number
|
||
of request lines per POST request.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-AS.WWS.allow">
|
||
<span class="sig-name descname"><span class="pre">AS.WWS.allow</span></span><a class="headerlink" href="#confval-AS.WWS.allow" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Type: <em>list:string</em></p>
|
||
<p>List of IPs which are allowed to access the WWS port.
|
||
By default access is unrestricted.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-AS.WWS.deny">
|
||
<span class="sig-name descname"><span class="pre">AS.WWS.deny</span></span><a class="headerlink" href="#confval-AS.WWS.deny" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Type: <em>list:string</em></p>
|
||
<p>List of IPs which are not allowed to access the WWS port.
|
||
By default access is unrestricted.</p>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="command-line-options">
|
||
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this heading">¶</a></h2>
|
||
<p><strong class="program">caps [options]</strong></p>
|
||
<section id="generic">
|
||
<span id="id2"></span><h3>Generic<a class="headerlink" href="#generic" title="Permalink to this heading">¶</a></h3>
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-h">
|
||
<span id="cmdoption-help"></span><span class="sig-name descname"><span class="pre">-h</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--help</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-h" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Show help message.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-V">
|
||
<span id="cmdoption-version"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--version</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-V" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Show version information.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-config-file">
|
||
<span class="sig-name descname"><span class="pre">--config-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-config-file" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Use alternative configuration file. When this option is
|
||
used the loading of all stages is disabled. Only the
|
||
given configuration file is parsed and used. To use
|
||
another name for the configuration create a symbolic
|
||
link of the application or copy it. Example:
|
||
scautopick -> scautopick2.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-plugins">
|
||
<span class="sig-name descname"><span class="pre">--plugins</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-plugins" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Load given plugins.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-D">
|
||
<span id="cmdoption-daemon"></span><span class="sig-name descname"><span class="pre">-D</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--daemon</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-D" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Run as daemon. This means the application will fork itself
|
||
and doesn’t need to be started with &.</p>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="verbosity">
|
||
<span id="id3"></span><h3>Verbosity<a class="headerlink" href="#verbosity" title="Permalink to this heading">¶</a></h3>
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-verbosity">
|
||
<span class="sig-name descname"><span class="pre">--verbosity</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-verbosity" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info,
|
||
4:debug.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-v">
|
||
<span id="cmdoption-v"></span><span class="sig-name descname"><span class="pre">-v</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--v</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-v" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Increase verbosity level (may be repeated, eg. -vv).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-q">
|
||
<span id="cmdoption-quiet"></span><span class="sig-name descname"><span class="pre">-q</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--quiet</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-q" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Quiet mode: no logging output.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-print-component">
|
||
<span class="sig-name descname"><span class="pre">--print-component</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-print-component" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>For each log entry print the component right after the
|
||
log level. By default the component output is enabled
|
||
for file output but disabled for console output.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-component">
|
||
<span class="sig-name descname"><span class="pre">--component</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-component" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Limit the logging to a certain component. This option can
|
||
be given more than once.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-s">
|
||
<span id="cmdoption-syslog"></span><span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--syslog</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-s" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Use syslog logging backend. The output usually goes to
|
||
/var/lib/messages.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-l">
|
||
<span id="cmdoption-lockfile"></span><span class="sig-name descname"><span class="pre">-l</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--lockfile</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-l" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Path to lock file.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-console">
|
||
<span class="sig-name descname"><span class="pre">--console</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-console" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Send log output to stdout.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-debug">
|
||
<span class="sig-name descname"><span class="pre">--debug</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-debug" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Execute in debug mode.
|
||
Equivalent to --verbosity=4 --console=1 .</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-trace">
|
||
<span class="sig-name descname"><span class="pre">--trace</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-trace" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Execute in trace mode.
|
||
Equivalent to --verbosity=4 --console=1 --print-component=1
|
||
--print-context=1 .</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-log-file">
|
||
<span class="sig-name descname"><span class="pre">--log-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-log-file" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Use alternative log file.</p>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="server">
|
||
<span id="id4"></span><h3>Server<a class="headerlink" href="#server" title="Permalink to this heading">¶</a></h3>
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-p">
|
||
<span id="cmdoption-server-port"></span><span class="sig-name descname"><span class="pre">-p</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--server-port</span></span><span class="sig-prename descclassname"> <span class="pre">int</span></span><a class="headerlink" href="#cmdoption-p" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Overrides configuration parameter <a class="reference internal" href="../base/configuration.html#confval-AS.port"><code class="xref std std-confval docutils literal notranslate"><span class="pre">AS.port</span></code></a>.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-server-ssl-port">
|
||
<span class="sig-name descname"><span class="pre">--server-ssl-port</span></span><span class="sig-prename descclassname"> <span class="pre">int</span></span><a class="headerlink" href="#cmdoption-server-ssl-port" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Overrides configuration parameter <a class="reference internal" href="../base/configuration.html#confval-AS.SSL.port"><code class="xref std std-confval docutils literal notranslate"><span class="pre">AS.SSL.port</span></code></a>.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-P">
|
||
<span id="cmdoption-plugin-port"></span><span class="sig-name descname"><span class="pre">-P</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--plugin-port</span></span><span class="sig-prename descclassname"> <span class="pre">int</span></span><a class="headerlink" href="#cmdoption-P" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Overrides configuration parameter <a class="reference internal" href="../base/configuration.html#confval-AS.plugins.port"><code class="xref std std-confval docutils literal notranslate"><span class="pre">AS.plugins.port</span></code></a>.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-http-port">
|
||
<span class="sig-name descname"><span class="pre">--http-port</span></span><span class="sig-prename descclassname"> <span class="pre">int</span></span><a class="headerlink" href="#cmdoption-http-port" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Overrides configuration parameter <a class="reference internal" href="../base/configuration.html#confval-AS.http.port"><code class="xref std std-confval docutils literal notranslate"><span class="pre">AS.http.port</span></code></a>.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-read-only">
|
||
<span class="sig-name descname"><span class="pre">--read-only</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-read-only" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Do not store any packets.</p>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="test">
|
||
<span id="id5"></span><h3>Test<a class="headerlink" href="#test" title="Permalink to this heading">¶</a></h3>
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-configtest">
|
||
<span class="sig-name descname"><span class="pre">--configtest</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-configtest" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Run a configuration file syntax test. It parses the
|
||
configuration files and either reports Syntax Ok or detailed
|
||
information about the particular syntax error.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-print-access">
|
||
<span class="sig-name descname"><span class="pre">--print-access</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-print-access" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Print access information for one or more channels from a
|
||
given IP and a user with password, format: NET.STA.LOC.CHA,
|
||
e.g.,</p>
|
||
<p>IP check</p>
|
||
<p>caps --print-access GE.*.*.* 127.0.0.1</p>
|
||
<p>IP and user:password check</p>
|
||
<p>caps --print-access GE.APE.*.* --user gempa:gempa 127.0.0.1</p>
|
||
<p>The stream ID filter supports wildcards. Use option -v to
|
||
enable the trace mode to get detailed information about the
|
||
rule evaluation.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-u">
|
||
<span id="cmdoption-user"></span><span class="sig-name descname"><span class="pre">-u</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--user</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-u" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Server user and password. Format: user:password .</p>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
</section>
|
||
</section>
|
||
|
||
|
||
<div id="anchors-bottom"></div>
|
||
</div>
|
||
|
||
<div class="sidebar" role="navigation" aria-label="main navigation">
|
||
<div id="anchors-top"></div>
|
||
<div id="anchors" class="content">
|
||
<div id="searchbox" style="display: none" role="search">
|
||
<h3 id="searchlabel">Quick search</h3>
|
||
<div class="searchformwrapper">
|
||
<form class="search" action="../search.html" method="get">
|
||
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
||
<input type="submit" value="Go" />
|
||
</form>
|
||
</div>
|
||
</div>
|
||
<script>document.getElementById('searchbox').style.display = "block"</script>
|
||
<div>
|
||
<h3><a href="../index.html">Table of Contents</a></h3>
|
||
<ul>
|
||
<li><a class="reference internal" href="#">caps</a><ul>
|
||
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
|
||
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a><ul>
|
||
<li><a class="reference internal" href="#generic">Generic</a></li>
|
||
<li><a class="reference internal" href="#verbosity">Verbosity</a></li>
|
||
<li><a class="reference internal" href="#server">Server</a></li>
|
||
<li><a class="reference internal" href="#test">Test</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
|
||
</div>
|
||
<div role="note" aria-label="source link">
|
||
<h3>This Page</h3>
|
||
<ul class="this-page-menu">
|
||
<li><a href="../_sources/apps/caps.rst.txt"
|
||
rel="nofollow">Show Source</a></li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="footer">
|
||
<div class="container">
|
||
<div class="content">
|
||
Release <b></b> version <b>2025.254#f0c77b29e</b>
|
||
<div class="copyright">
|
||
© Copyright <a href="https://www.gempa.de">2013, gempa GmbH.</a>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</body>
|
||
</html> |