Skip to content

Commit 8866439

Browse files
committed
Clean up a bit and link to our other projects
Signed-off-by: Joachim Wiberg <[email protected]>
1 parent 8084e89 commit 8866439

File tree

1 file changed

+43
-13
lines changed

1 file changed

+43
-13
lines changed

README.md

Lines changed: 43 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,53 @@
22

33
# curiOS -- a slim curated container OS
44

5-
curiOS, pronounced curious, is a slim curated base of containers.
5+
curiOS, pronounced curious, is a project by the [same team][8] of developers
6+
that created and maintain the [Infix operating system][7]. If you like the
7+
idea of modeling an entire OS with YANG, have a look at Infix.
8+
9+
This project provides a set of *defconfigs* for 64-bit ARM and x86 systems
10+
that can be used with Infix or any other [OCI](https://opencontainers.org/)
11+
compatible runtime.
12+
13+
> [!NOTE]
14+
> The system container is very useful for staging/development before deploying
15+
> any of the slim application containers, because they can be very difficult
16+
> to debug (none or little tooling in image).
617
718

819
## AppStore
920

10-
The [KernelKit AppStore][2] on GHCR provides the following readily available
11-
container images for both AMD64 and ARM64 hosts:
21+
The [KernelKit AppStore][2] on GHCR provides the following pre-built images.
22+
23+
### [curiOS system][3]
24+
25+
A system container, example of how to run multiple services. Comes with the
26+
following services and tools:
27+
28+
- Dropbear SSH daemon
29+
- mini-snmpd
30+
- netopeer-cli
31+
- nftables
32+
- ntpd
33+
34+
### [curiOS ntpd][4]
35+
36+
ISC ntpd supports [multicasting NTP][10] to a subnet.
37+
38+
### [curiOS nftables][5]
39+
40+
Useful for advanced netfilter setups when the container runs in host network
41+
mode. At startup it loads `/etc/nftables.conf` and then waits for a signal.
42+
At shutdown `nft flush ruleset` is called.
43+
44+
This container comes with a minimal set of BusyBox tools, including a shell,
45+
so the `nftables.conf` file can be modified from inside the container (vi).
46+
Although the most common use-case is to mount a file from the host system.
1247

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

21-
> **Note:** the system container is very useful for staging/development
22-
> before deploying any of the slim application containers, because they
23-
> can be very difficult to debug (none or little tooling in image).
50+
Tiny web server container based on BusyBox httpd, suitable for embedding in a
51+
firmware image as an example container.
2452

2553

2654
## Origin & References
@@ -40,4 +68,6 @@ curiOS is a fork of https://github.com/brianredbeard/coreos_buildroot
4068
[4]: https://github.com/orgs/kernelkit/packages/container/package/curios-ntpd
4169
[5]: https://github.com/orgs/kernelkit/packages/container/package/curios-nftables
4270
[6]: https://github.com/orgs/kernelkit/packages/container/package/curios-httpd
71+
[7]: https://github.com/kernelkit/infix
72+
[8]: https://kernelkit.org
4373
[10]: https://www.ntp.org/documentation/4.2.8-series/discover/

0 commit comments

Comments
 (0)