.. highlight:: rst

.. _scwfas:

######
scwfas
######

**Waveform archive server**


Description
===========

The waveform archive server is a small application that serves a local
SDS archive via different protocols. Currently there are two implementations:

* :ref:`fdsnws dataselect <sec-dataSelect>`

  * dataselect/1/query
  * dataselect/1/version
  * dataselect/1/application.wadl

All data are forwarded unrestricted. There are no options to add restriction
checks or user authentication.


.. _scwfas_configuration:

Module Configuration
====================

| :file:`etc/defaults/global.cfg`
| :file:`etc/defaults/scwfas.cfg`
| :file:`etc/global.cfg`
| :file:`etc/scwfas.cfg`
| :file:`~/.seiscomp/global.cfg`
| :file:`~/.seiscomp/scwfas.cfg`

scwfas inherits :ref:`global options<global-configuration>`.



.. confval:: handlerSDS

   Type: *string*

   Defines an alternative SDS archive handler. This is the name
   of an RecordStream interface that can be loaded via a plugin.
   If not given, an internal implementation will be used.


.. confval:: filebase

   Default: ``@ROOTDIR@/var/lib/archive``

   Type: *string*

   The filebase of the SDS archive. If an alternative archive
   handler is defined by \"handlerSDS\", this value serves
   as input to setSource\(\).


.. confval:: fdsnws.port

   Default: ``8080``

   Type: *int*

   The server port for FDSNWS connections. \-1
   deactivates the FDSN Web server.


.. confval:: fdsnws.baseURL

   Default: ``http://localhost:8080/fdsnws``

   Type: *string*

   The base URL of the FDSN Web service that is
   given in the WADL document.


.. confval:: fdsnws.maxTimeWindow

   Default: ``0``

   Type: *int*

   Unit: *s*

   The aggregated maximum time window \(seconds\)
   for all requested streams. A value of 0 will deactive
   any restriction.



Command-Line Options
====================

.. program:: scwfas

:program:`scwfas [options]`


Generic
-------

.. option:: -h, --help

   Show help message.

.. option:: -V, --version

   Show version information.

.. option:: --config-file arg

   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.

.. option:: --plugins arg

   Load given plugins.

.. option:: -D, --daemon

   Run as daemon. This means the application will fork itself
   and doesn't need to be started with \&.


Verbosity
---------

.. option:: --verbosity arg

   Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info,
   4:debug.

.. option:: -v, --v

   Increase verbosity level \(may be repeated, eg. \-vv\).

.. option:: -q, --quiet

   Quiet mode: no logging output.

.. option:: --print-component arg

   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.

.. option:: --component arg

   Limit the logging to a certain component. This option can
   be given more than once.

.. option:: -s, --syslog

   Use syslog logging backend. The output usually goes to
   \/var\/lib\/messages.

.. option:: -l, --lockfile arg

   Path to lock file.

.. option:: --console arg

   Send log output to stdout.

.. option:: --debug

   Execute in debug mode.
   Equivalent to \-\-verbosity\=4 \-\-console\=1 .

.. option:: --trace

   Execute in trace mode.
   Equivalent to \-\-verbosity\=4 \-\-console\=1 \-\-print\-component\=1
   \-\-print\-context\=1 .

.. option:: --log-file arg

   Use alternative log file.


Server
------

.. option:: --arclink-port int

   Overrides configuration parameter :confval:`arclink.port`.


.. option:: --fdsnws-port int

   Overrides configuration parameter :confval:`fdsnws.port`.


.. option:: --fdsnws-baseurl string

   Overrides configuration parameter :confval:`fdsnws.baseURL`.


