Realtime and archive waveform server caps [options] generic#help generic#version generic#config-file generic#plugins generic#daemon verbosity#verbosity verbosity#v verbosity#quiet verbosity#print-component verbosity#print-context verbosity#component verbosity#syslog verbosity#lockfile verbosity#console verbosity#debug verbosity#trace verbosity#log-file Do not store any packets. Run a configuration file syntax test. It parses the configuration files and either reports Syntax Ok or detailed information about the particular syntax error. Print access information for one or more channels from a given IP and a user with password, format: NET.STA.LOC.CHA, e.g., IP check caps --print-access GE.*.*.* 127.0.0.1 IP and user:password check caps --print-access GE.APE.*.* --user gempa:gempa 127.0.0.1 The stream ID filter supports wildcards. Use option -v to enable the trace mode to get detailed information about the rule evaluation. Server user and password. Format: user:password . CAPS server control parameters Defines the path to the archive directory. Defines the server port for client requests. 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. 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. 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. Whether to maintain a request log file or not. Each request will be logged and partly traced. Log only parts of the IP to respect users privacy. Whether to maintain a purge log file or not. Each purge operation will be logged. List of IPs which are allowed to access the caps(s) port. By default access is unrestricted. List of IPs which are not allowed to access the caps(s) port. By default access is unrestricted. File buffer control parameters The path to the archive log file which contains the stream start and end times. By default it is written to $filebase/archive.log. CAPS does not keep all files of all streams open. It tries to keep open the most frequently used files and closes all others. The more files CAPS can keep open the faster the population of the archive. The limit of open files depends on the security settings of the user under which CAPS is running. 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. 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. 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. 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. 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. The real-time notification queue size. 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. 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. Example keeping all streams but AM.* and GR.* for 14 days: GR.*:-1, AM.*.*.*:365, *.*.*.*:14 Default (empty parameter) or -1: keep all data forever. Parameters controlling IO resources occupied by the purge operation. The deletion of many data files at once may have a significant impact on the server performance. E.g. if the server did not run for a while or the keep parameter was reduced significantly, the purge operation may slow down the processing of real-time data. 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: EndTime: The reference time is the end time per stream. This keeps older data if no more recent data arrive. Now: The reference time is current time. This deletes old data even if no recent data arrive. Idle time between two purge runs. 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. Maximum processing time for one purge run. If exceeded the purge task will pause for AS.filebase.purge.idleTime seconds freeing IO resources. Time of the day when to run the daily purge run. Time is in UTC. 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. Parameters for SSL-based data requests Defines the SSL server port for client requests. By default SSL requests are disabled. Defines the path to the SSL certificate to use. Defines the path to the private SSL key to use. This key is not shared with clients. Parameters controlling the authentication system for data requests based on user ID, IP addresses, access roles and access control lists. 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. Basic authentication parameters. The configuration can be reloaded without restarting the server. Use "seiscomp reload caps`" to reload the authentication parameters without a restart. Path to the access control list controlling access based on rules. By default access is unrestricted. Allow rules are evaluated first. AM.DENY = 127.0.0.1 AM.ALLOW = 127.0.0.1 This example rule set prohibits all AM network stations for localhost because the DENY rule is evaluated after the ALLOW rule. 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: AM.ALLOW = %users AM.R44F5.ALLOW = sysop Rules are evaluated on the basis of one another. This can lead to misunderstandings. Here an example: AM.ALLOW = sysop This rule will allow the AM network for sysop only. But DENY = %users AM.ALLOW = sysop will allow the access to the AM network for all users except those are member of the group users. Location of the users authentication file. For each user one line of the following format must exist: username:encrypted_pwd 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 u=sysop pw=`mkpasswd -m sha-512` && echo $u:$pw generates one line for user "sysop". Add the line to the authentication file. 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: uid:prop1,prop2 or %gid:prop1,prop2 "%" indicates a gid instead of a uid. The properties grant access to certain CAPS features. Supported access property values are: read, write, admin. Location of the optional group file. Each line maps a group id to a list of users in format gid:user1,user2,user3 Defines the server port to use for plugin connections. List of IPs which are allowed to access the plugin port. By default access is unrestricted. List of IPs which are not allowed to access the plugin port. By default access is unrestricted. Defines the SSL server port to use for plugin SSL connections. The SSL port is disabled by default. Defines the path to the SSL certificate to use. Defines the path to the private SSL key to use. This key is not shared with clients. Web interface control parameters Defines the server port for HTTP connections. By default the Web interface is disabled. Typical value: 18081 List of IPs which are allowed to access the http(s) port. By default access is unrestricted. List of IPs which are not allowed to access the http(s) port. By default access is unrestricted. 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. 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. 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. Use https instead of http when setting the following parameters Defines the server port for HTTPS connections. By default the SSL Web interface is disabled. Defines the path to the SSL certificate to use. Defines the path to the private SSL key to use. This key is not shared with clients. FDSNWS control parameters for dataselect. The FDSNWS service is provided through the "AS.http.port". 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. Maximum number of requests per post. A value greater than or equal to zero limits the number of request lines per POST request. Winston waveform server (WWS) control parameters. When set, CAPS will also serve WWS. 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. Default (no value): The WWS interface is disabled. 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. A value greater than or equal to zero limits the number of request lines per POST request. List of IPs which are allowed to access the WWS port. By default access is unrestricted. List of IPs which are not allowed to access the WWS port. By default access is unrestricted.