man(1)

NAME
nymead - An open source IoT (Internet of Things) server

SYNOPSIS
nymead [OPTION]

DESCRIPTION
The nymea daemon is a plugin based IoT (Internet of Things) server. The server works like a translator for devices, things and services and allows them to interact. With the powerful rule engine you are able to connect any device available in the system and create individual scenes and behaviors for your environment.

OPTIONS

-h, --help
    Displays this help.

-v, --version
    Displays version information.

-n, --no-daemon
    Run nymead in the foreground, not as daemon.

-q, --quiet
    Disables logging all debug, info and warning categories.

-p, --print-all
    Enables all info and debug categories except *Traffic and *Debug categories.

-l, --log, <logfile>
    Specify a log file to write to, if this option is not specified, logs will be printed to the standard output.

--no-colors
    Log output is colorized by default. Use this option to disable colors.

--session
    If specified, all D-Bus interfaces will be bound to the session bus instead of the system bus.

-d, --debug-category, <[No]DebugCategory[Warnings|Info]>
    Debug categories to enable. Prefix with "No" to disable. Suffix with "Info" or "Warnings" to address info and warning messages. Enabling a debug category will implicitly enable the according info category.

    Built-in debug categories:

        Thing, ThingManager, System, Platform, PlatformUpdate, PlatformZeroConf, Experiences, TimeManager, Hardware, ServerManager, TcpServer, TcpServerTraffic, WebServer, WebServerTraffic, DebugServer, WebSocketServer, WebSocketServerTraffic, JsonRpc, JsonRpcTraffic, Rest, OAuth2, UPnP, Bluetooth, Cloud, CloudTraffic, NetworkManager, UserManager, BluetoothServer, BluetoothServerTraffic, Mqtt, Translations, Coap, I2C, JsIntegrations, Transfer, TransferTraffic, TransportRouter

-i, --interface, <interfaceString>
    Additional interfaces to listen on. In nymea URI format (for example nymeas://127.0.0.2:7777). Such interfaces will not require any authentication as they are intended to be used for automated testing only.

-m, --no-logengine
    Disable the influx DB log engine.

-c, --configuration, <path>
    Use the given path for storing configurations. This option overrides the NYMEA_CONFIG_PATH environment variable.

Debug categories for plugins:
    Since nymea loads the plugins dynamically, the list of supported plugin debug categories depends on your plugin installation. Please use the -h command to see which categories are available for your system.

EXAMPLES

To start nymead in the foreground and read the debug messages from the Hardware:

    $ nymead -n -d Hardware

To start nymead in the foreground, disable debug messages from the ThingManager and enable debug messages for JsonRpc and Rest:

    $ nymead -n -d NoThingManager -d JsonRpc -d Rest

To start nymead in the foreground, enable all debug messages except WebSocketServerTraffic and TcpServerTraffic:

    $ nymead -n -p -d NoWebSocketServerTraffic -d NoTcpServerTraffic

FILES
The server config file: /var/lib/nymea/nymead.conf
The things config file: /var/lib/nymea/things.conf
The rules config file: /var/lib/nymea/rules.conf
The plugins config file: /var/lib/nymea/plugins.conf
The packaged default config directory: /usr/share/nymea/defaults
The log file if enabled: /var/log/nymead.log
The systemd unit file: /lib/systemd/system/nymead.service
The plugins directory: /usr/lib/<arch-triplet>/nymea/plugins/

ENVIRONMENT

NYMEA_CONFIG_PATH
    Overrides the runtime configuration directory. This is the directory where nymead reads and writes its live configuration files. The --configuration option overrides this variable.

NYMEA_DEFAULT_CONFIG_PATH
    Overrides the read-only default configuration directory used to seed missing configuration files.

NYMEA_TRANSLATIONS_PATH
    Overrides the directory used to load translation files.

NYMEA_INSECURE_INTERFACES_DISABLED
    If set to a value other than 0, nymead disables insecure core interfaces, including unauthenticated or unencrypted interfaces.

NYMEA_PLUGINS_PATH
    Colon-separated list of integration plugin directories. If set, it replaces the built-in default integration plugin search path.

NYMEA_PLUGINS_EXTRA_PATH
    Colon-separated list of additional integration plugin directories searched before the default integration plugin path.

NYMEA_PLATFORM_PLUGINS_PATH
    Colon-separated list of platform plugin directories. If set, it replaces the built-in default platform plugin search path.

NYMEA_PLATFORM_PLUGINS_EXTRA_PATH
    Colon-separated list of additional platform plugin directories searched before the default platform plugin path.

NYMEA_APIKEYS_PLUGINS_PATH
    Colon-separated list of API keys provider plugin directories. If set, it replaces the built-in default API keys provider search path.

NYMEA_APIKEYS_PLUGINS_EXTRA_PATH
    Colon-separated list of additional API keys provider plugin directories searched before the default API keys provider path.

NYMEA_EXPERIENCE_PLUGINS_PATH
    Colon-separated list of experience plugin directories. If set, it replaces the built-in default experience plugin search path.

NYMEA_EXPERIENCE_PLUGINS_EXTRA_PATH
    Colon-separated list of additional experience plugin directories searched before the default experience plugin path.

NYMEA_ZWAVE_PLUGIN_PATH
    Colon-separated list of Z-Wave backend plugin directories searched before the built-in default Z-Wave backend locations.

DEVICE_SERIAL
    Provides a fallback device serial number if the active platform plugin does not implement one.

SEE ALSO
Full developer documentation at: <https://nymea.io>

REPORTING BUGS
Issue tracker on github: <https://github.com/nymea/nymea/issues>

AUTHOR
Mainly written by Simon Stürz and Michael Zanetti

COPYRIGHT
Copyright © 2013-2024 nymea GmbH.
Copyright © 2024-2026 chargebyte austria GmbH.
License GPLv3+: GNU GPL version 3 or later <https://www.gnu.org/licenses/gpl-3.0.html>.
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.