Skip to content

Latest commit

 

History

History
102 lines (78 loc) · 3.38 KB

README.md

File metadata and controls

102 lines (78 loc) · 3.38 KB
Raw

tklx/base

A super slim root filesystem specifically designed to be used as a base image for application container images.

Based on Debian GNU/Linux, the rootfs.tar.xz weighs in at only 12MB, and has access to largest GNU/Linux software repository with over 56,800 packages.

Features

  • Based on Debian GNU/Linux (why debian?).
  • Runtime agnostic (use with Docker, CoreOS rkt, etc.).
  • Built from scratch specifically for container usage.
  • Smallest Debian based image as far as we know.
  • Comfortable interactive terminal (colorized, promptpath).
  • Convenience apt-clean script to clean cache and optionally docs/locales.

Usage (Docker)

docker pull tklx/base:0.1.1
docker run -it tklx/base:0.1.1 /bin/bash
FROM tklx/base:0.1.1
RUN apt-get update && apt-get -y install PACKAGES && apt-clean --aggressive
ENTRYPOINT ["something"]

Usage (CoreOS rkt)

rkt trust --prefix=tklx.org/base
rkt fetch tklx.org/base:0.1.1
rkt run tklx.org/base:0.1.1 --interactive --exec /bin/bash
acbuild begin
acbuild set-name example.com/test
acbuild dep add tklx.org/base:0.1.1
acbuild run apt-get update && apt-get -y install PACKAGES && apt-clean --aggressive
acbuild set-exec something
acbuild write test-latest-linux-amd64.aci
acbuild end

Status

Currently on major version zero (0.y.z). Per Semantic Versioning, major version zero is for initial development, and should not be considered stable. Anything may change at any time.

Release files are available here.

Versioning

Releases are based on Semantic Versioning, and use the format of MAJOR.MINOR.PATCH. In a nutshell, the version will be incremented based on the following:

  • MAJOR: incompatible and/or major changes, upgraded OS release
  • MINOR: backwards-compatible new features and functionality
  • PATCH: backwards-compatible bugfixes and package updates

Issue Tracker

TKLX uses a central issue tracker on GitHub for reporting and tracking of bugs, issues and feature requests.

About

In case you're interested, TKLX is pronounced /tickle-ex/.

TKLX is a project by TurnKey GNU/Linux. TurnKey GNU/Linux is a Debian based library of system images that pre-integrates and polishes the best free software components into ready-to-use solutions.

TurnKey was started in 2008 by Alon Swartz and Liraz Siri who were inspired by a belief in the power of free software, like science, to promote the progress of a free & humane society.