Skip to content

Environment Variables

Jump to bottom
Ultibo edited this page Apr 20, 2026 · 1 revision

Many units in Ultibo core allow passing command line parameters to modify their behavior during boot. These parameters become environment variables during startup and are checked during the initialization of the particular unit.

The parameters refer to either global variables defined in the GlobalConfig unit or to variables defined locally, not all are currently implemented, the ones that have been are documented below.

Filesystem parameters

  • FILESYS_REGISTER_LOGGING
  • FILESYS_LOGGING_DEFAULT
  • FILESYS_LOGGING_FILE
  • FILESYS_LOGGING_MAXSIZE
  • FILESYS_LOGGING_MAXCOPIES

Logging parameters

  • CONSOLE_REGISTER_LOGGING
  • CONSOLE_LOGGING_DEFAULT
  • CONSOLE_LOGGING_POSITION

Network parameters

  • HOST_NAME
  • HOST_DOMAIN

Platform parameters

  • TIMER_THREAD_COUNT

Determines how many timer threads are created during startup to service registered timer events.

Example: TIMER_THREAD_COUNT=8

  • WORKER_THREAD_COUNT

Determines how many worker threads are created during startup to service registered worker events or timer events marked with the worker flag.

Example: WORKER_THREAD_COUNT=15

Services parameters

  • NTP_SERVER_DEFAULT
  • NTP_PORT_DEFAULT
  • NTP_POLLING_INTERVAL
  • NTP_POLLING_TIMEOUT
  • NTP_POLLING_RETRIES
  • NTP_RETRY_TIMEOUT
  • NTP_AUTOSTART
  • SYSLOG_BOUND_PORT
  • SYSLOG_SERVER_DEFAULT
  • SYSLOG_PORT_DEFAULT
  • SYSLOG_PROTOCOL_DEFAULT
  • SYSLOG_OCTET_COUNTING
  • SYSLOG_REGISTER_LOGGING
  • SYSLOG_LOGGING_DEFAULT
  • SYSLOG_AUTOSTART

Timezone parameters

  • TIMEZONE_DEFAULT_NAME

Shell Update parameters

  • SHELL_UPDATE_HTTP_SERVER
  • SHELL_UPDATE_HTTP_PATH
  • SHELL_UPDATE_LOCAL_PATH
  • SHELL_UPDATE_KERNEL_IMAGE
  • SHELL_UPDATE_KERNEL_CONFIG
  • SHELL_UPDATE_KERNEL_COMMAND

Web Status parameters

  • WEBSTATUS_HEAP_FREE_COUNT
  • WEBSTATUS_HEAP_USED_COUNT

Clone this wiki locally