Module configuration

We provide the ability to configure the Signal Sciences module. The following attributes are set by default, but may need to be modified to provide support for different environments. In the majority of cases modifying module configuration is not necessary. Contact support if you need assistance or have questions regarding modifying module configuration.

Apache

To modify the Signal Sciences module configuration in Apache you will need to add directives to your Apache configuration file (e.g., for CentOS it is httpd.conf, for Debian or Ubuntu it is apache.conf or apache2.conf). Note, these directives must be set after the Signal Sciences module is loaded.

Starting with release 1.6.0, the following directives replace any earlier ones. These directives are a renaming of the earlier ones but with the addition of the prefix SigSci.

The following directives will be deprecated in favor of the new ones above with the SigSci prefix but are backwards compatible and will continue to work.

The following directives are deprecated and will be ignored.

NGINX C Binary Module

To modify the Signal Sciences NGINX module configuration, you will need to add directives to the NGINX configuration file, located by default at /etc/nginx/nginx.conf.

In the global section, for example after the pid /run/nginx.pid; line:

load_module /etc/nginx/modules/ngx_http_sigsci_module.so;

For the NGINX.org package (nxo) only, add the following line:

load_module /etc/nginx/modules/ndk_http_module.so;

Examples of configuration

Following is an example of setting SignalSciences module parameters in the http section:

1# sigsci module settings
2##
3sigsci_debug         on;
4sigsci_agent_timeout  200;

These examples show using location sections with the sigsci_enabled parameter:

1# sigsci_enabled set to "on"
2location /inspect/ {
3   sigsci_enabled  on;
4   proxy_pass      http://127.0.0.1:80/inspect/;
5}

1# sigsci_enabled set to "off"
2location /noinspect/ {
3   sigsci_enabled  off;
4   proxy_pass      http://127.0.0.1:80/noinspect/;
5}

Detailed example using server and location sections for the sigsci_websocket_enabled parameter:

1http {
2
3    # must be turned on in global section
4    sigsci_websocket_enabled on;
5
6    server {
7        ...
8        # turned off for this server section
9        sigsci_websocket_enabled off;
10
11        # websocket turned on for this location
12        location /websenabled {
13            sigsci_websocket_enabled on;
14            proxy_pass http://websocket;
15            ...
16        }
17
18        # websocket off for this location since it is off in server
19        location /websdisabled {
20            proxy_pass http://websocket;
21            ...
22        }

NGINX Lua Module

To modify the Signal Sciences Lua module for NGINX, changes can be made in the Signal Sciences Lua script, which by default is at /opt/sigsci/nginx/sigsci.conf.

Example configuration

1sigsci.agenthost = "unix:/var/run/sigsci.sock"
2sigsci.agentport = 12345
3sigsci.timeout = 100
4sigsci.maxpost = 1000000

HAProxy

Configuration changes are typically not required for the HAProxy module to work. However, it is possible to override the default settings if needed. To do so, you must create an override.lua file in which to add these configuration directives. Then, update the global section of your HAProxy config file (/usr/local/etc/haproxy/haproxy.cfg) to load this over-ride config file.

Example of configuration

1global
2   ...
3   lua-load /path/to/override.lua
4   ...

Over-ride Directives

These directives may be used in your over-ride config file.

Example of over-ride configuration

1sigsci.agenthost = "192.0.2.243"
2sigsci.agentport = 9090
3sigsci.extra_blocking_resp_hdr = "Access-Control-Allow-Origin: https://example.com"

IIS

You can set the configuration for the IIS module using the MSI installer, the SigsciCtl.exe utility in v2.0.0+, IIS Manager UI, PowerShell, or the appcmd.exe utility. See Configuration Usage for more information on configuring the IIS module.

Language Modules

See language specific module pages for configuration details.

• Java
  • As a Servlet filter
  • As a Jetty handler
  • As a Netty handler
  • With Dropwizard
  • On WebLogic servers
• Node.js
• .NET