mirror of
https://github.com/optim-enterprises-bv/secureblue.git
synced 2025-11-08 14:23:38 +00:00
cc90a91733
* feat: add files and systemd module * fix: yaml formatting * fix: yaml formatting * fix: remove comment completely * fix: yaml formatting * docs: add back inline comment * reformat: rename variables * fix: fix systemd escaped string * fix: fix systemd service formatting with printf * fix: attempting to fix systemd module problems * chore: remove debug config and code from systemd module * docs: added WIP docs for systemd, reworked files README * docs: added more detail for systemd module * docs: update READMEs to be more consistent * docs: remove unneeded sentence * docs: remove unneeded sentence * chore: fix issues described in PR review * docs: fix markdown formatting * docs: fix markdown formatting * docs: better markdown
27 lines
1.1 KiB
Markdown
27 lines
1.1 KiB
Markdown
# `script` Module for Startingpoint
|
|
|
|
The `script` module can be used to run arbitrary scripts at image build time that take no or minimal external configuration (in the form of command line arguments).
|
|
The scripts, which are run from the `config/scripts` directory, are declared under `scripts:`.
|
|
|
|
## Example Configuration
|
|
|
|
```yml
|
|
type: script
|
|
scripts:
|
|
- signing.sh
|
|
```
|
|
|
|
## Creating a Script
|
|
|
|
Look at `example.sh` for an example shell script. You can rename and copy the file for your own purposes. In order for the script to be executed, declare it in the recipe
|
|
|
|
When creating a script, please make sure
|
|
|
|
- ...its filename ends with `.sh`.
|
|
- This follows convention for (especially bash) shell scripts.
|
|
- `autorun.sh` only executes files that match `*.sh`.
|
|
- ...it starts with a [shebang](<https://en.wikipedia.org/wiki/Shebang_(Unix)>) like `#!/usr/bin/env bash`.
|
|
- This ensures the script is ran with the correct interpreter / shell.
|
|
- ...it contains the command `set -oue pipefail` near the start.
|
|
- This will make the image build fail if your script fails. If you do not care if your script works or not, you can omit this line.
|