LEDE relies on UCI, the Unified Configuration Interface, to configure its core services. UCI Defaults provides a way to preconfigure your images, using UCI.
To set some system defaults the first time the device boots, create a script in the folder /etc/uci-defaults/
All scripts in that folder are automatically executed by /etc/init.d/boot
In a live router you can see the existing uci-defaults scripts in /rom/etc/uci-defaults , as /etc/uci-defaults itself is typically empty (after all scripts have been run ok and have been deleted).
uci-defaults scripts can be created by packages or they can be inserted into the build manually as custom files.
You can preload custom settings by adding batch scripts containing UCI commands into the
/files/etc/uci-defaults directory. The path is identical for the buildroot and the image generator. The scripts will be run after the flashing process - in case of upgrading, that also includes appending the existing configuration to the JFFS2 partition (mounted as
/overlay). Scripts should not be executable. To ensure your scripts are not interfering with any other scripts, make sure they get executed last by giving them a high prefix (e.g. zzzz_customisations). A basic script could look like this:
$ cat zzzz_customisations #!/bin/sh uci -q batch <<-EOT add dhcp host set dhcp.@host.name='bellerophon' set network.@host.ip='192.168.2.100' set network.@host.mac='a1:b2:c3:d4:e5:f6' EOT
Once the script has run successfully and exited cleanly (exit status 0), it will be removed from
etc/uci-defaults. You can still consult the original in
/rom/etc/uci-defaults if needed.
/etc/uci-defaults will get executed at every first boot (i.e. after a clean install or an upgrade), possibly overwriting already existing values. If this behaviour is undesired, we recommend you implement a test at the top of your script - e.g. probe for a custom setting your script would normally configure:
[ "$(uci -q get system.@system.zonename)" = "America/New York" ] && exit 0
This will make sure, when the key has the correct value set, that the script exits cleanly and gets removed from
/etc/uci-defaults as explained above.