signalk-server

<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Runtime Environment & Options | Signal K</title><meta name="description" content="Documentation for Signal K"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css?cache=1767726585343"/><link rel="stylesheet" href="../assets/highlight.css?cache=1767726585343"/><script defer src="../assets/main.js?cache=1767726585343"></script><script async src="../assets/icons.js?cache=1767726585343" id="tsd-icons-script"></script><script async src="../assets/search.js?cache=1767726585343" id="tsd-search-script"></script><script async src="../assets/navigation.js?cache=1767726585343" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js?cache=1767726585343" id="tsd-hierarchy-script"></script><link rel="stylesheet" href="../assets/theme.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title"><img src="../assets/logo.svg" alt="Signal K"/></a><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg><span class="visible@s">Search</span></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><div id="tsd-toolbar-links"><a href="https://discord.gg/uuZrwz4dCS" target="_blank" rel="noopener" class="toolbar-icon visible@s" aria-label="Discord"><svg width="24" height="24" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 512"><path d="M524.5 69.8a1.5 1.5 0 0 0 -.8-.7A485.1 485.1 0 0 0 404.1 32a1.8 1.8 0 0 0 -1.9 .9 337.5 337.5 0 0 0 -14.9 30.6 447.8 447.8 0 0 0 -134.4 0 309.5 309.5 0 0 0 -15.1-30.6 1.9 1.9 0 0 0 -1.9-.9A483.7 483.7 0 0 0 116.1 69.1a1.7 1.7 0 0 0 -.8 .7C39.1 183.7 18.2 294.7 28.4 404.4a2 2 0 0 0 .8 1.4A487.7 487.7 0 0 0 176 479.9a1.9 1.9 0 0 0 2.1-.7A348.2 348.2 0 0 0 208.1 430.4a1.9 1.9 0 0 0 -1-2.6 321.2 321.2 0 0 1 -45.9-21.9 1.9 1.9 0 0 1 -.2-3.1c3.1-2.3 6.2-4.7 9.1-7.1a1.8 1.8 0 0 1 1.9-.3c96.2 43.9 200.4 43.9 295.5 0a1.8 1.8 0 0 1 1.9 .2c2.9 2.4 6 4.9 9.1 7.2a1.9 1.9 0 0 1 -.2 3.1 301.4 301.4 0 0 1 -45.9 21.8 1.9 1.9 0 0 0 -1 2.6 391.1 391.1 0 0 0 30 48.8 1.9 1.9 0 0 0 2.1 .7A486 486 0 0 0 610.7 405.7a1.9 1.9 0 0 0 .8-1.4C623.7 277.6 590.9 167.5 524.5 69.8zM222.5 337.6c-29 0-52.8-26.6-52.8-59.2S193.1 219.1 222.5 219.1c29.7 0 53.3 26.8 52.8 59.2C275.3 311 251.9 337.6 222.5 337.6zm195.4 0c-29 0-52.8-26.6-52.8-59.2S388.4 219.1 417.9 219.1c29.7 0 53.3 26.8 52.8 59.2C470.7 311 447.5 337.6 417.9 337.6z"></path></svg></a><a href="https://github.com/SignalK/signalk-server" target="_blank" rel="noopener" class="toolbar-icon visible@s" aria-label="Discord"><svg width="24" height="24" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3 .3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5 .3-6.2 2.3zm44.2-1.7c-2.9 .7-4.9 2.6-4.6 4.9 .3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3 .7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3 .3 2.9 2.3 3.9 1.6 1 3.6 .7 4.3-.7 .7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3 .7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3 .7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z"></path></svg></a><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../Installation.html">Installation</a></li><li><a href="" aria-current="page">Runtime Environment & Options</a></li></ul></div><div class="tsd-panel tsd-typography"><h1 id="runtime-environment--options" class="tsd-anchor-link">Runtime Environment & Options<a href="#runtime-environment--options" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h1><p>Signal K Server provides the following command line options and environment variables to configure your implementation.</p> <h2 id="command-line-options" class="tsd-anchor-link">Command line options<a href="#command-line-options" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><table> <thead> <tr> <th>Option</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>-s</code></td> <td>Override path to the settings file. <em>(same as <code>SIGNALK_NODE_SETTINGS</code> environment variable)</em></td> </tr> <tr> <td><code>-c</code></td> <td>Override the path to find server configuration. <em>(same as <code>SIGNALK_NODE_CONFIG_DIR</code> environment variable)</em></td> </tr> <tr> <td><code>--sample-nmea0183-data</code></td> <td>Starts signalk-server with sample NMEA0183 data.</td> </tr> <tr> <td><code>--sample-n2k-data</code></td> <td>Starts signalk-server with sample NMEA2000 data.</td> </tr> <tr> <td><code>--override-timestamps</code></td> <td>Override timestamps in the sample NMEA2000 data with current date and time. Doesn't apply nor makes a difference to NMEA0183 sample data.</td> </tr> <tr> <td><code>--securityenabled</code></td> <td>Enable 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 <a href="../Security.html#enabling-security">Security</a> for further details.</td> </tr> </tbody> </table> <h2 id="environment-variables" class="tsd-anchor-link">Environment variables<a href="#environment-variables" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><table> <thead> <tr> <th>Variable</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>PORT</code></td> <td>Override the port for http/ws service (default is 3000).</td> </tr> <tr> <td><code>SSLPORT</code></td> <td>Override the port for https/wss service. If defined forces ssl as default protocol <em>(default port is 3443)</em>.</td> </tr> <tr> <td><code>PROTOCOL</code></td> <td>Override http/https where the server is accessed via https but the server sees http <em>(e.g. when Heroku handles https termination)</em></td> </tr> <tr> <td><code>EXTERNALPORT</code></td> <td>The port used in /signalk response and Bonjour advertisement. Has precedence over configuration file.</td> </tr> <tr> <td><code>EXTERNALHOST</code></td> <td>The host used in /signalk response and Bonjour advertisement. Has precedence over configuration file.</td> </tr> <tr> <td><code>FILEUPLOADSIZELIMIT</code></td> <td>Override the file upload size limit <em>(default is '10mb')</em>.</td> </tr> <tr> <td><code>NMEA0183PORT</code></td> <td>Override the port for the NMEA 0183 over tcp service <em>(default is 10110)</em>.</td> </tr> <tr> <td><code>TCPSTREAMPORT</code></td> <td>Override the port for the Signal K Streaming (deltas) over TCP.</td> </tr> <tr> <td><code>TCPSTREAMADDRESS</code></td> <td>Override the address the Signal K Stream (deltas) over TCP is listening on.</td> </tr> <tr> <td><code>DISABLEPLUGINS</code></td> <td>Disable all plugins so that they can not be enabled <em>(default is false)</em>.</td> </tr> <tr> <td><code>DEFAULTENABLEDPLUGINS</code></td> <td>A comma separated list of plugin ids that are overridden to be enabled by default if no setttings exist. Lower preference than <code>DISABLEPLUGINS</code>.</td> </tr> <tr> <td><code>PLUGINS_WITH_UPDATE_DISABLED</code></td> <td>A comma separated list of plugin that will not be updated.</td> </tr> <tr> <td><code>SECURITYSTRATEGY</code></td> <td>Override the security strategy module name.</td> </tr> <tr> <td><code>WSCOMPRESSION</code></td> <td>Compress websocket messages <em>(default is false)</em>.</td> </tr> <tr> <td><code>MAXSENDBUFFERSIZE</code></td> <td>The 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 <em>(default is 512 * 1024 bytes)</em>.</td> </tr> <tr> <td><code>MAXSENDBUFFERCHECKTIME</code></td> <td>The 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 <em>(default is 512 * 1024 bytes)</em>.</td> </tr> <tr> <td><code>SIGNALK_SERVER_IS_UPDATABLE</code></td> <td>Allows the server to be updated through the GUI even if it is not installed in the standard paths <em>(default is false)</em>. If set to true, the server must have been installed with <code>npm install -g signalk-server</code>.</td> </tr> <tr> <td><code>SIGNALK_DISABLE_SERVER_UPDATES</code></td> <td>Disables server updates in the GUI <em>(default is false)</em>.</td> </tr> <tr> <td><code>DEBUG</code></td> <td>A comma-separated list of tags for debugging the specified module <em>(e.g signalk-server*,signalk-provider-tcp)</em>. Can now be defined directly in the graphical interface. More help on how to use the debug here: <code>https://www.npmjs.com/package/debug#wildcards</code></td> </tr> <tr> <td><code>IS_IN_DOCKER</code></td> <td>Used to tell the server it is in Docker and not normally updateable <em>(default is false)</em>.</td> </tr> <tr> <td><code>NPMREGISTRYTIMEOUT</code></td> <td>How long to wait for the registry when retrieving the App Store listing <em>(default is 20s)</em>.</td> </tr> <tr> <td><code>SECRETKEY</code></td> <td>A secret string used to generate an authentication token <em>(the internal default autogenerated is a string of 512 hex chars like 'ef8307a4c7a4bd7...309d947bca3')</em></td> </tr> <tr> <td><code>ALLOW_DEVICE_ACCESS_REQUESTS</code></td> <td>Used when a device needs to gain access to a secured Signal K server <em>(default is true)</em> (<a href="https://signalk.org/specification/1.4.0/doc/access_requests.html">https://signalk.org/specification/1.4.0/doc/access_requests.html</a>).</td> </tr> <tr> <td><code>ALLOW_NEW_USER_REGISTRATION</code></td> <td><em>(default is true)</em>.</td> </tr> <tr> <td><code>ADMINUSER</code></td> <td>Force an account for admin user <em>(username:password format)</em>.</td> </tr> <tr> <td><code>PRESERIALCOMMAND</code></td> <td>Command to run before opening a serial port.</td> </tr> <tr> <td><code>SIGNALK_NODE_SETTINGS</code></td> <td>Override the path to the settings file.</td> </tr> <tr> <td><code>SIGNALK_NODE_CONFIG_DIR</code></td> <td>Override the path to find server configuration. Includes all run-time changing content: configuration files, plugins, plugin configuration files, webapps, and so forth.</td> </tr> <tr> <td><code>SKIP_NODE_VERSION_CHECK</code></td> <td>Skip the Node.js minimum version check. This is not recommended, but allows you to attempt to run the server on unsuppported versions of Node. (Added in v2.14.1)</td> </tr> <tr> <td><code>HTTP_RATE_LIMITS</code></td> <td>Override HTTP rate limits. Provide overrides like <code>api=1000,loginStatus=1000,login=1000</code> (optionally <code>windowMs=600000</code>). Useful for tests and unusual deployments.</td> </tr> </tbody> </table> </div></div><div class="col-sidebar"><div class="page-menu"><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#command-line-options"><span>Command line options</span></a><a href="#environment-variables"><span>Environment variables</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Signal K</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>