Skip to content

Commit 1e6cce1

Browse files
committed
add using details
1 parent 17aa6d6 commit 1e6cce1

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

README.md

+17-2
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,33 @@
11
# Patch OpenBSD bsd.rd with auto_install.conf & rc.firsttime
22

3+
This is a very simple script that is used to create custom installation cd's and bsd.rd images for OpenBSD to be used with online provides (such as Vultr) to deploy fully configured instances.
4+
35
The script does the following:
46
* Downloads a bsd.rd image from an openbsd mirror
57
* Extracts the filesystem portion of the ramdisk
68
* Mount the filesystem
79
* Patch the filesystem with auto_install
810
* Put the filesystem back into bsd.rd
911
* Create a `siteXX.tgz` with `rc.firsttime`
10-
* Create a bootable cd with the modified `bsd.rd` and `siteXX.tgz`
12+
* Create a bootable ISO with the modified `bsd.rd` and `siteXX.tgz`
1113

1214
In order to preserve size the auto install configuration uses the 1st http
13-
mirror and then uses the siteXX.tgz from the created CD. This way our CD and
15+
mirror and then uses the `siteXX.tgz` from the created CD. This way our CD and
1416
`bsd.rd` are almost the same size.
1517

18+
NOTE: The script is really at its infantry and there is no error checking implemented currently.
19+
20+
## Using
21+
* Clone the repo
22+
* Change into the cloned repo and create a folder `fs/`
23+
* Update `auto_install.conf` with a desired information about your specific install
24+
* Place any files you want included into your images (usually `install.site` and `rc.firsttime`)
25+
```sh
26+
cp install.site fs/
27+
mkdir fs/etc
28+
cp rc.firsttime fs/etc
29+
```
30+
1631
## Refs
1732
* https://www.openbsd.org/faq/faq4.html#site
1833
* https://github.com/ajacoutot/aws-openbsd

0 commit comments

Comments
 (0)