Skip to content

Device configuration

The device configuration consists of the container configuration and the optional host configuration.

Warning

The yaml file format is formatting sensitive, make sure the indentation of the example files is kept.

Container configuration

The container is configured in a file called container-config.yaml placed under the /container directory in the USB mass storage device alongside the rootfs.tar.xz file to create a container definition.

Format

The /container/container-config.yaml file contents follow the format below:

name: my-hostname-%S
interfaces:
    - eth0
    - mlan0
    - mmlan0
users:
    root:
        password: root
# More than one password can be configured. Note: The ubuntu user usually
# only exist in an Ubuntu container, for other distros remove the following
# lines.
    ubuntu:
        password: ubuntu

The name field supports template strings which can be used to generate a host name dynamically.

Format string Replacement
%S The device serial number
%E The device full EAN string
%e The last 7 characters of the EAN string

The name field is used as the host name and the users with passwords fields must be configured to be able to use the console login.

If the name field is left out, edge-%e-%S is used as a default name.

The interfaces section defines which interfaces are available in the container. The available interfaces depend on the device. The table below lists the available interfaces for each device type.

Device Available interfaces
wl400s eth0, mlan0, mmlan0
wl420s eth0, eth1, mlan0, mmlan0

The mlan0 and mmlan0 are special cases, as the corresponding AP and WiFi-Direct interfaces are also added to the user container. The table below shows which interfaces are related.

Client AP WiFi-Direct
mlan0 uap0 wfd0
mmlan0 muap0 mwfd0

The users section is for setting passwords for the different users.

Warning

Only users already available in the container can be used. A configuration file with a user name not already set up in the image will cause the whole installation to fail.

The /container directory can optionally contain a meta.tar.xz file which is used for configuration if it exists. The meta.tar.xz file is created during the image build process. Currently only templating information is used, typically for replacing hostname in the user containers system configuration.

Host configuration

An optional host configuration can be defined in a file called host-config.yaml placed under the /host directory.

Note

The host configuration only takes effect on a container installation, so if host-config.yaml is added during a host upgrade but a container is later installed separately without it, the device might end up misconfigured.

Format

The /host/host-config.yaml file contents follow the format given below:

can_driver: socketcan

The supported inputs for the can_driver field are:

  • socketcan
  • linuxcan

socketcan is used as the default if no host-config.yaml file is provided.