294 lines
11 KiB
XML
294 lines
11 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<seiscomp>
|
|
<module name="fdsnws" category="Utilities">
|
|
<description>
|
|
Provide FDSN Web Services.
|
|
</description>
|
|
<command-line>
|
|
<synopsis>
|
|
fdsnws [options]
|
|
</synopsis>
|
|
<group name="Generic">
|
|
<optionReference>generic#help</optionReference>
|
|
<optionReference>generic#version</optionReference>
|
|
<optionReference>generic#config-file</optionReference>
|
|
<optionReference>generic#plugins</optionReference>
|
|
<optionReference>generic#daemon</optionReference>
|
|
<optionReference>generic#auto-shutdown</optionReference>
|
|
<optionReference>generic#shutdown-master-module</optionReference>
|
|
<optionReference>generic#shutdown-master-username</optionReference>
|
|
</group>
|
|
<group name="Verbosity">
|
|
<optionReference>verbosity#verbosity</optionReference>
|
|
<optionReference>verbosity#v</optionReference>
|
|
<optionReference>verbosity#quiet</optionReference>
|
|
<optionReference>verbosity#component</optionReference>
|
|
<optionReference>verbosity#syslog</optionReference>
|
|
<optionReference>verbosity#lockfile</optionReference>
|
|
<optionReference>verbosity#console</optionReference>
|
|
<optionReference>verbosity#debug</optionReference>
|
|
<optionReference>verbosity#log-file</optionReference>
|
|
</group>
|
|
<group name="Database">
|
|
<optionReference>database#db-driver-list</optionReference>
|
|
<optionReference>database#database</optionReference>
|
|
<optionReference>database#config-module</optionReference>
|
|
<optionReference>database#inventory-db</optionReference>
|
|
<optionReference>database#db-disable</optionReference>
|
|
</group>
|
|
<group name="Records">
|
|
<optionReference>records#record-driver-list</optionReference>
|
|
<optionReference>records#record-url</optionReference>
|
|
<optionReference>records#record-file</optionReference>
|
|
<optionReference>records#record-type</optionReference>
|
|
</group>
|
|
</command-line>
|
|
<configuration>
|
|
<parameter name="listenAddress" type="IP" default="0.0.0.0">
|
|
<description>
|
|
Define the bind address of the server. "0.0.0.0" allows
|
|
any interface to connect to this server whereas "127.0.0.0"
|
|
only allows connections from localhost.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="port" type="int" default="8080">
|
|
<description>
|
|
Server port to listen for incoming requests. Note: The FDSN Web
|
|
service specification defines the service port 80. Please refer
|
|
to the documentation on how to serve on privileged ports.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="connections" type="int" default="5">
|
|
<description>
|
|
Number of maximum simultaneous requests.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="queryObjects" type="int" default="10000">
|
|
<description>
|
|
Maximum number of objects per query, used in fdsnws-station and
|
|
fdsnws-event to limit main memory consumption.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="realtimeGap" type="int" unit="s">
|
|
<description>
|
|
Restrict end time of requests to current time - realtimeGap
|
|
seconds. Negative values allowed. Used in fdsnws-dataselect.
|
|
WARNING: If this value is unset and a realtime recordsource
|
|
(e.g. slink) is used, requests may block if end time in future
|
|
is requested.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="samplesM" type="float">
|
|
<description>
|
|
Maximum number of samples (in units of million) per query, used
|
|
in fdsnws-dataselect to prevent a single user to block one
|
|
connection with a large request.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="recordBulkSize" type="int" default="102400" unit="bytes">
|
|
<description>
|
|
Set the number of bytes to buffer for each chunk of waveform data
|
|
served to the client. The lower the buffer the higher the overhead
|
|
of Python Twisted. The higher the buffer the higher the memory
|
|
usage per request. 100kB seems to be a good trade-off.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="htpasswd" type="string" default="@CONFIGDIR@/fdsnws.htpasswd">
|
|
<description>
|
|
Path to password file used in fdsnws-dataselect/queryauth. The
|
|
format is 'username:password' separated by lines. Because of the
|
|
HTTP digest authentication method required by the FDSN
|
|
specification, the passwords have to be stored in plain text.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="accessLog" type="string">
|
|
<description>
|
|
Path to access log file. If unset no access log is created.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="requestLog" type="string">
|
|
<description>
|
|
Path to request log file. If unset no request log is created.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="userSalt" type="string">
|
|
<description>
|
|
Secret salt for calculating userID.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="corsOrigins" type="list:string:" default="*">
|
|
<description>
|
|
List of domain names Cross-Origin Resource Sharing (CORS)
|
|
request may originate from. A value of '*' allows any web page
|
|
to embed your service. An empty value will switch of CORS
|
|
requests entirely. An example of multiple domains might be:
|
|
'https://test.domain.de, https://production.domain.de'.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="allowRestricted" type="boolean" default="true">
|
|
<description>
|
|
Enable/disable access to restricted inventory data.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="handleConditionalRequests" type="boolean" default="false">
|
|
<description>
|
|
Enable/disable handling of time-based conditional requests (RFC
|
|
7232) by the fdsnws-station resource.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="useArclinkAccess" type="boolean" default="false">
|
|
<description>
|
|
If enabled, then access to restricted waveform data is
|
|
controlled by arclink-access bindings. By default authenticated
|
|
users have access to all data.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="hideAuthor" type="boolean" default="false">
|
|
<description>
|
|
If enabled, author information is removed from any event
|
|
creationInfo element.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="hideComments" type="boolean" default="false">
|
|
<description>
|
|
If enabled, event comment elements are no longer accessible.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="evaluationMode" type="string">
|
|
<description>
|
|
If set, the event service will only return events having a
|
|
preferred origin with a matching evaluationMode property.
|
|
</description>
|
|
</parameter>
|
|
<group name="eventType">
|
|
<parameter name="whitelist" type="list:string">
|
|
<description>List of enabled event types</description>
|
|
</parameter>
|
|
<parameter name="blacklist" type="list:string">
|
|
<description>List of disabled event types</description>
|
|
</parameter>
|
|
</group>
|
|
<parameter name="eventFormats" type="list:string">
|
|
<description>
|
|
List of enabled event formats. If unspecified, all supported
|
|
formats are enabled.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="serveDataSelect" type="boolean" default="true">
|
|
<description>
|
|
Enable/disable the DataSelect service.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="serveEvent" type="boolean" default="true">
|
|
<description>
|
|
Enable/disable the Event service.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="serveStation" type="boolean" default="true">
|
|
<description>
|
|
Enable/disable the Station service.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="serveAvailability" type="boolean" default="false">
|
|
<description>
|
|
Enable/disable the Availability service. Note: This is a non
|
|
standard FDSNWS extension served under fdsnws/ext/availability.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="stationFilter" type="string">
|
|
<description>
|
|
Path to station inventory filter file.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="dataSelectFilter" type="string">
|
|
<description>
|
|
Path to dataselect inventory filter file.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="debugFilter" type="boolean" default="false">
|
|
<description>
|
|
If enabled, a debug line is written for each stream ID explaining
|
|
why a stream was added/removed by a inventory filter.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="inventoryCoordinatePrecision" type="int">
|
|
<description>
|
|
Number of decimal places used for station and sensor location
|
|
coordinates. If specified, the coordinates are obfuscated
|
|
when the inventory is read on service startup or reload.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="fileNamePrefix" type="string" default="fdsnws">
|
|
<description>
|
|
Define the prefix for the default filenames if downloading and
|
|
saving data from within a browser.
|
|
For data loaded using dataselect, it is thus fdsnws.mseed by default.
|
|
</description>
|
|
</parameter>
|
|
<group name="dataAvailability">
|
|
<description>
|
|
Provide access to waveform data availability information stored
|
|
in the SeisComP database. In case of a SDS archive, this
|
|
information may be collected by scardac (SeisComP archive
|
|
data availability collector).
|
|
</description>
|
|
<parameter name="enable" type="boolean" default="false">
|
|
<description>
|
|
Enable loading of data availabilty information from
|
|
SeisComP database. Availability information is used by
|
|
station and ext/availability service.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="cacheDuration" type="int" default="300" unit="s">
|
|
<description>
|
|
Number of seconds data availabilty information is considered
|
|
valid. If the duration time is exceeded, the information is
|
|
fetched again from the database.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="dccName" type="string" default="DCC">
|
|
<description>
|
|
Name of the archive use in sync format of dataavailability
|
|
extent service.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="repositoryName" type="string" default="primary">
|
|
<description>
|
|
Name of the archive use in some format of data availability
|
|
extent service.
|
|
</description>
|
|
</parameter>
|
|
</group>
|
|
<group name="trackdb">
|
|
<parameter name="enable" type="boolean" default="false">
|
|
<description>
|
|
Save request log to database.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="defaultUser" type="string" default="fdsnws">
|
|
<description>
|
|
Default user.
|
|
</description>
|
|
</parameter>
|
|
</group>
|
|
<group name="auth">
|
|
<parameter name="enable" type="boolean" default="false">
|
|
<description>
|
|
Enable auth extension.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="gnupgHome" type="string" default="@ROOTDIR@/var/lib/gpg">
|
|
<description>
|
|
GnuPG home directory.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="blacklist" type="list:string">
|
|
<description>
|
|
List of revoked token IDs.
|
|
</description>
|
|
</parameter>
|
|
</group>
|
|
</configuration>
|
|
</module>
|
|
</seiscomp>
|