This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

OS configuration

Device configuration settings, image settings, and persistent paths.

Settings and paths for SPEKTRA Edge OS devices.

For the task-oriented material — provisioning a device, configuring networking, or upgrading the OS — see Devices under Learn.

In this section

  • Configuration reference — an index of every device setting, grouped by area, with a pointer to where each one is documented.
  • Image settings — the choices baked into an install image when you create it.
  • Persistent paths — the file-based settings that survive a reboot or an OS upgrade.

1 - Configuration reference

This is an index of the device settings you can manage, grouped by area. Most are set from the dashboard or the API once a device is online; a few are chosen at image creation. For exact API field names and types, see the Devices API reference.

Runtime settings (dashboard / API)

These are reconciled to the device while it is online — change them at any time.

Setting Area Documented in
OS version Lifecycle OS upgrades
Network configuration (and merge/replace mode) Networking Network configuration
Disable network configuration fallback Networking Connection fallback
Proxy (HTTP/HTTPS/no-proxy, interfaces) Networking Proxy configuration
SSH server enable/disable Security SSH access
SSH authentication (password/key) and authorized keys Security SSH access
SSH source allow / deny lists Security SSH access
SSH brute-force ban duration and ignore list Security SSH access
USB device control and allow rules Security USB device control
Attestation expectations Security TPM & device attestation
Logging (severity, components, container logs) Operations Logging
Health checks Operations Health checks
Device discovery (mDNS) on/off Networking Connectivity & ports
Location / placement metadata Inventory Manage devices

Image-creation settings

These are chosen when you create an install image; most can also be adjusted later through the runtime settings above.

Setting Documented in
Device type (hardware + architecture) Supported platforms
OS version to install OS upgrades
Disk encryption (and recovery passphrase) Disk encryption
Storage mapping Storage
Network configuration Network configuration
Time / NTP Time synchronization
Proxy Proxy configuration
Administrator password User accounts
Provisioning credentials Onboarding methods

On-device files

A few settings are provided as files on the device’s configuration storage — see Persistent paths.

2 - Image settings

When you create an install image from the dashboard, you choose the device type, the OS version, and a set of defaults that are embedded in the image so a device is useful the moment it boots. This page summarizes those choices.

Setting Purpose More detail
Device type Target hardware family and CPU architecture. Supported platforms
OS version The OS version installed by the image. OS upgrades
Disk encryption Encrypt the configuration and data areas. Disk encryption
Recovery passphrase Break-glass passphrase for encrypted devices. Disk encryption
Storage mapping Partitions and mounts to ensure on the device. Storage
Network configuration Initial network settings (the fallback baseline). Networking
Time / NTP Initial time sources. Time synchronization
Proxy Initial proxy settings. Proxy configuration
Administrator password Initial local administrator password. User accounts
Provisioning credentials Allow the device to onboard automatically. Onboarding methods

3 - Persistent paths

Most configuration is applied through the dashboard or API. A few things, however, are provided as files on the device’s configuration storage — the persistent area that survives reboots and OS upgrades. This page lists the file-based settings you may need to place on a device.

File-based settings

Purpose What to place Documented in
Storage mapping A storage mapping document defining partitions and mounts. Storage
Network configuration A Netplan-format network configuration. Networking
Time / NTP A custom NTP configuration. Time synchronization
Boot / shutdown hooks Executable scripts run at boot, after the agent starts, and on shutdown. Boot & shutdown hooks

Notes

  • Files on configuration storage persist across reboots and OS upgrades; this is why they are the right place for durable, file-based settings.
  • Do not place durable settings on the read-only system image — changes there do not survive a reboot. See how persistence works.
  • When disk encryption is enabled, files on configuration storage are protected at rest.