Skip to content

Commit 72c05f6

Browse files
committed
Add conf & overlay readmes
1 parent 368e976 commit 72c05f6

2 files changed

Lines changed: 54 additions & 0 deletions

File tree

conf/turnkey.d/README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
Common TurnKey configuration scripts
2+
====================================
3+
4+
These configuration scripts will be applied to all TurnKey appliances.
5+
6+
Architechture family specific conf scripts
7+
------------------------------------------
8+
9+
Architecture family specific conf scripts can be put in a relevant
10+
subdirectory here.
11+
12+
Supported architechture families are:
13+
- x86 (amd64 aka x86_64)
14+
- arm (arm64 aka aarch64)
15+
16+
E.g. to run a new 'amd64-only' configuration script on amd64 builds (only):
17+
18+
```
19+
cd common
20+
mkdir -p conf/turnkey.d/x86.d
21+
cat > conf/turnkey.d/x86.d/amd64-only <<EOF
22+
# configuration script only for amd64 builds
23+
#
24+
# ...
25+
EOF
26+
chmod +x conf/turnkey.d/x86.d/amd64-only
27+
```

overlays/turnkey.d/README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
Common TurnKey overlays
2+
=======================
3+
4+
These overlays will be applied to all TurnKey appliances.
5+
6+
Architechture family specific overlays
7+
--------------------------------------
8+
9+
Architecture family specific overlays can be put in a relevant
10+
subdirectory here.
11+
12+
Supported architechture families are:
13+
- x86 (amd64 aka x86_64)
14+
- arm (arm64 aka aarch64)
15+
16+
E.g. to add a new /etc/some-app/amd64-only.conf overlay that should only be
17+
added to amd64 builds:
18+
19+
```
20+
cd common
21+
mkdir -p overlays/turnkey.d/x86.d/etc/some-app
22+
cat > overlays/turnkey.d/x86.d/etc/some-app/amd64-only.conf <<EOF
23+
# config only for amd64 builds
24+
#
25+
# ...
26+
EOF
27+
```

0 commit comments

Comments
 (0)