Skip to content

Commit 80be236

Browse files
authored
Document first user configuration file usage
Added information about the first user configuration file and its functionality.
1 parent 7263b2c commit 80be236

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

docs/Developer-Guide_User-Configurations.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,12 @@ Patches with the same file name and path in the `userpatches` directory tree ove
1313

1414
A configuration file named `userpatches/config-<something>.conf.sh` (`.conf` also allowed) is a bash script that is sourced during the build if `./compile.sh something` is issued. All parameters which normally are passed via command line can be used (`PARAM1=value1` `PARAM2=value`) by using the same syntax, one separate line per `PARAM`. Command-line parameters still can override what is in the config file. More advanced use cases can use conditionals, define functions to implement hooks, source other/common config files, etc. A few, quite complex, examples can be found [here](https://github.com/lanefu/armbian-userpatches-example-indiedroid-nova).
1515

16+
## User provided first config
17+
18+
userpatches/firstboot.conf
19+
20+
When detected, the system displays an informational alert and applies the [first config configuration](https://docs.armbian.com/User-Guide_Autoconfig/).
21+
1622
## Legacy user provided configuration (deprecated, support for this will be removed at some point)
1723

1824
If the file `userpatches/lib.config` exists, it will be called and can override the particular kernel and u-boot versions. For a comprehensive list of available variables, look through `lib/functions/configuration/main-config.sh`. Some examples of what you can change:

0 commit comments

Comments
 (0)