Skip to content

Commit

Permalink
Simplify README and split out build instructions
Browse files Browse the repository at this point in the history
Signed-off-by: Joachim Wiberg <[email protected]>
  • Loading branch information
troglobit committed Jan 22, 2024
1 parent a0efa49 commit 1634106
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 17 deletions.
31 changes: 14 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,34 @@
# curiOS — a slim curated container OS

curiOS, pronounced curious, is a slim curated base for system containers.
curiOS, pronounced curious, is a slim curated base of system containers.

curiOS is a wrapper around [Buildroot][0] for creating container images for
uploading to Docker Hub or similar. Buildroot is an SDK for building embedded
Linux distributions. It handles the removal of man pages, shared files, and
many pieces not germane to running on an embedded platform, and, as it turns
out, containers.

## Quick Start

1. Clone this repo
## AppStore

$ git clone https://github.com/kernelkit/curiOS
$ cd curiOS/
$ git submodule update --init
The [KernelKit AppStore][2] on GHCR provides the following readily available
container images for both AMD64 and ARM64 hosts:

2. Configure & Build
- [curiOS system][3]: Dropbear SSH daemon, mini-snmpd, netopeer-cli
- [curiOS ntpd][4]: ISC ntpd supports [multicasting NTP][10] to a subnet
- [curiOS nftables][5]: Set up advanced netfilter rules

$ make curious_amd64_defconfig
$ make
> All images contain the same [BusyBox][1] toolset.
3. Upload your OCI image

$ cd output/images
$ ls rootfs-oci/
blobs index.json oci-layout

$ skopeo copy --dest-creds <user>:<pass> \
oci:rootfs-oci:<tag> docker://<user>/<image>[:tag]

## Origin & References

curiOS is a fork of https://github.com/brianredbeard/coreos_buildroot

[0]: https://buildroot.org
[1]: https://busybox.net
[2]: https://github.com/orgs/kernelkit/packages?repo_name=curiOS
[3]: https://github.com/orgs/kernelkit/packages/container/package/curios
[4]: https://github.com/orgs/kernelkit/packages/container/package/curios-ntpd
[5]: https://github.com/orgs/kernelkit/packages/container/package/curios-nftables
[10]: https://www.ntp.org/documentation/4.2.8-series/discover/
31 changes: 31 additions & 0 deletions developers.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Developer's Guide

## Idea

The founding idea behind this project is to provide small container
images for embedded systems using [Buildroot][0].

## Quick Start

1. Clone this repo

$ git clone https://github.com/kernelkit/curiOS
$ cd curiOS/
$ git submodule update --init

2. Configure & Build

$ make curious_amd64_defconfig
$ make

3. Upload your OCI image

$ cd output/images
$ ls rootfs-oci/
blobs index.json oci-layout

$ skopeo copy --dest-creds <user>:<pass> \
oci:rootfs-oci:<tag> docker://<user>/<image>[:tag]


[0]: https://buildroot.org

0 comments on commit 1634106

Please sign in to comment.