Skip to content

Commit a0f4025

Browse files
committed
Update, add new container image and document purpose of them
Signed-off-by: Joachim Wiberg <[email protected]>
1 parent 638fb27 commit a0f4025

File tree

1 file changed

+17
-10
lines changed

1 file changed

+17
-10
lines changed

README.md

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,34 @@
11
# curiOS — a slim curated container OS
22

3-
curiOS, pronounced curious, is a slim curated base of system containers.
4-
5-
curiOS is a wrapper around [Buildroot][0] for creating container images for
6-
uploading to Docker Hub or similar. Buildroot is an SDK for building embedded
7-
Linux distributions. It handles the removal of man pages, shared files, and
8-
many pieces not germane to running on an embedded platform, and, as it turns
9-
out, containers.
3+
curiOS, pronounced curious, is a slim curated base of containers.
104

115

126
## AppStore
137

148
The [KernelKit AppStore][2] on GHCR provides the following readily available
159
container images for both AMD64 and ARM64 hosts:
1610

17-
- [curiOS system][3]: Dropbear SSH daemon, mini-snmpd, netopeer-cli
11+
- [curiOS system][3]: A system container, example of how to run multiple
12+
services: Dropbear SSH daemon, mini-snmpd, netopeer-cli, ntpd, nftables
1813
- [curiOS ntpd][4]: ISC ntpd supports [multicasting NTP][10] to a subnet
19-
- [curiOS nftables][5]: Set up advanced netfilter rules
14+
- [curiOS nftables][5]: Useful for advanced netfilter setups. At startup
15+
loads `/etc/netfilter.conf` and calls `nft flush ruleset` at shutdown
16+
- [curiOS httpd][6]: Tiny web server container based on BusyBox httpd,
17+
suitable for embedding in a firmware image as an example container
2018

21-
> All images contain the same [BusyBox][1] toolset.
19+
> **Note:** the system container is very useful for staging/development
20+
> before deploying any of the slim application containers, because they
21+
> can be very difficult to debug (none or little tooling in image).
2222
2323

2424
## Origin & References
2525

26+
curiOS is a wrapper around [Buildroot][0] for creating container images for
27+
uploading to Docker Hub or similar. Buildroot is an SDK for building embedded
28+
Linux distributions. It handles the removal of man pages, shared files, and
29+
many pieces not germane to running on an embedded platform, and, as it turns
30+
out, containers.
31+
2632
curiOS is a fork of https://github.com/brianredbeard/coreos_buildroot
2733

2834
[0]: https://buildroot.org
@@ -31,4 +37,5 @@ curiOS is a fork of https://github.com/brianredbeard/coreos_buildroot
3137
[3]: https://github.com/orgs/kernelkit/packages/container/package/curios
3238
[4]: https://github.com/orgs/kernelkit/packages/container/package/curios-ntpd
3339
[5]: https://github.com/orgs/kernelkit/packages/container/package/curios-nftables
40+
[6]: https://github.com/orgs/kernelkit/packages/container/package/curios-httpd
3441
[10]: https://www.ntp.org/documentation/4.2.8-series/discover/

0 commit comments

Comments
 (0)