Runtime Environment & Options

Signal K Server provides the following command line options and environment variables to configure your implementation.

Command line options

OptionDescription
-sOverride path to the settings file. (same as SIGNALK_NODE_SETTINGS environment variable)
-cOverride the path to find server configuration. (same as SIGNALK_NODE_CONFIG_DIR environment variable)
--sample-nmea0183-dataStarts signalk-server with sample NMEA0183 data.
--sample-n2k-dataStarts signalk-server with sample NMEA2000 data.
--override-timestampsOverride timestamps in the sample NMEA2000 data with current date and time. Doesn't apply nor makes a difference to NMEA0183 sample data.
--securityenabledEnable security. For a fresh install this makes the Admin UI force the user to create an admin account before he/she can continue further into the UI. See Security for further details.

Environment variables

VariableDescription
PORTOverride the port for http/ws service (default is 3000).
SSLPORTOverride the port for https/wss service. If defined forces ssl as default protocol (default port is 3443).
PROTOCOLOverride http/https where the server is accessed via https but the server sees http (e.g. when Heroku handles https termination)
EXTERNALPORTThe port used in /signalk response and Bonjour advertisement. Has precedence over configuration file.
EXTERNALHOSTThe host used in /signalk response and Bonjour advertisement. Has precedence over configuration file.
FILEUPLOADSIZELIMITOverride the file upload size limit (default is '10mb').
NMEA0183PORTOverride the port for the NMEA 0183 over tcp service (default is 10110).
TCPSTREAMPORTOverride the port for the Signal K Streaming (deltas) over TCP.
TCPSTREAMADDRESSOverride the address the Signal K Stream (deltas) over TCP is listening on.
DISABLEPLUGINSDisable all plugins so that they can not be enabled (default is false).
DEFAULTENABLEDPLUGINSA comma separated list of plugin ids that are overridden to be enabled by default if no setttings exist. Lower preference than DISABLEPLUGINS.
PLUGINS_WITH_UPDATE_DISABLEDA comma separated list of plugin that will not be updated.
SECURITYSTRATEGYOverride the security strategy module name.
WSCOMPRESSIONCompress websocket messages (default is false).
MAXSENDBUFFERSIZEThe maximum number of bytes allowed in the server's send buffer of a WebSocket connection. The connection will be terminated if this is exceeded for MAXSENDBUFFERCHECKTIME milliseconds. Guards against slow or dysfunctional clients that can not cope with the message volume (default is 512 * 1024 bytes).
MAXSENDBUFFERCHECKTIMEThe maximum number of bytes allowed in the server's send buffer of a WebSocket connection. The connection will be terminated if this is exceeded. Guards against slow or dysfunctional clients that can not cope with the message volume (default is 512 * 1024 bytes).
SIGNALK_SERVER_IS_UPDATABLEAllows the server to be updated through the GUI even if it is not installed in the standard paths (default is false). If set to true, the server must have been installed with npm install -g signalk-server.
SIGNALK_DISABLE_SERVER_UPDATESDisables server updates in the GUI (default is false).
DEBUGA comma-separated list of tags for debugging the specified module (e.g signalk-server*,signalk-provider-tcp). Can now be defined directly in the graphical interface. More help on how to use the debug here: https://www.npmjs.com/package/debug#wildcards
IS_IN_DOCKERUsed to tell the server it is in Docker and not normally updateable (default is false).
NPMREGISTRYTIMEOUTHow long to wait for the registry when retrieving the App Store listing (default is 20s).
SECRETKEYA secret string used to generate an authentication token (the internal default autogenerated is a string of 512 hex chars like 'ef8307a4c7a4bd7...309d947bca3')
ALLOW_DEVICE_ACCESS_REQUESTSUsed when a device needs to gain access to a secured Signal K server (default is true) (https://signalk.org/specification/1.4.0/doc/access_requests.html).
ALLOW_NEW_USER_REGISTRATION(default is true).
ADMINUSERForce an account for admin user (username:password format).
PRESERIALCOMMANDCommand to run before opening a serial port.
SIGNALK_NODE_SETTINGSOverride the path to the settings file.
SIGNALK_NODE_CONFIG_DIROverride the path to find server configuration. Includes all run-time changing content: configuration files, plugins, plugin configuration files, webapps, and so forth.