From cbc3313f78a1a5e52e2edbe8c5c67df10796b5af Mon Sep 17 00:00:00 2001 From: "Hongli Lai (Phusion)" Date: Tue, 12 Nov 2013 11:53:14 +0100 Subject: [PATCH] Work on README --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index 6cab8b1..841f595 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,21 @@ +# A minimal Docker base image with a correct and usable system + +Baseimage-docker is a [Docker](http://www.docker.io) image meant to serve as a good base for any other Docker container. It contains a minimal base system with the most important things already installed and set up correctly. + +Included in the image are: + +| Component | Why is it included? | Remarks | +| ------------- | ------------------- | ------- | +| An Ubuntu 12.04 LTS base system. | | | +| syslog-ng | A syslog daemon is necessary so that many services - including the kernel itself - can correctly log to /var/log/syslog. If no syslog daemon is running, a lot of important messages are silently swallowed. | Only listens locally. | +| ssh server | | | +| [runit](http://smarden.org/runit/) | For service supervision and management. Much easier to use than SysV init and supports restarting daemons when they crash. Much easier to use and more lightweight than Upstart. | | + + * The SSH server, so that you can easily login to your container to inspect or administer things. + * Password and challenge-response authentication are disabled by default. Only key authentication is allowed. + * It allows an predefined key by default to make debugging easy. You should replace this ASAP. See instructions. + +Why use baseimage-docker instead of doing everything yourself in Dockerfile? # Use phusion/baseimage as base image. To make your builds reproducible, make # sure you lock down to a specific version, not to `latest`!