From 65cce5013dad6a77e2f66bde26df45d4432e6e2c Mon Sep 17 00:00:00 2001 From: startxfr Date: Fri, 4 Dec 2015 03:11:38 +0100 Subject: improving general README.md --- OS/README.md | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) (limited to 'OS') diff --git a/OS/README.md b/OS/README.md index 938d20e..82b96c6 100644 --- a/OS/README.md +++ b/OS/README.md @@ -9,7 +9,7 @@ weight=3 # Fedora OS container's -Simple container used for all startx based services and application published in [Dockerhub registry](https://github.com/startxfr/docker-images). +Simple and extralight (110Mo) container used for all startx based services and application published in [Dockerhub registry](https://github.com/startxfr/docker-images). This container contain updated core OS rpm (kernel, libs,...) as well as usefull tools like pwgen, tar, zip, psmisc, procps, coreutils, findutils, wget | [![Build Status](https://travis-ci.org/startxfr/docker-images.svg)](https://travis-ci.org/startxfr/docker-images) | [Dockerhub Registry](https://hub.docker.com/r/startx/fedora) | [Sources](https://github.com/startxfr/docker-images/OS/) | [STARTX Profile](https://github.com/startxfr) | @@ -26,7 +26,7 @@ This container contain updated core OS rpm (kernel, libs,...) as well as usefull ## Running from dockerhub registry -* with `docker` you can run `docker run -it --name="fedora" startx/fedora` from every docker host +* with `docker` you can run `docker run -it --name="fedora" startx/fedora` from any docker host * with `docker-compose` you can create a docker-compose.yml file with the following content ``` fedora: @@ -40,13 +40,23 @@ fedora: ## Using this image in your own container -You can use this Dockerfile template to start a new prsonalized container based on this container +You can use this Dockerfile template to start a new personalized container based on this container ``` FROM startx/fedora:latest #... your container specifications CMD ["/bin/run.sh"] ``` +## Environment variable + +| Variable | Type | Mandatory | Description | +|---------------------------|----------|-----------|--------------------------------------------------------------------------| +| CONTAINER_TYPE | `string` | `no` | Container family (os, service, application. could be enhanced +| CONTAINER_SERVICE | `string` | `no` | Define the type of service or application provided +| CONTAINER_INSTANCE | `string` | `yes` | Container name. Should be uning to get fine grained log and application reporting +| HOSTNAME | `auto` | `auto` | Container unique id automatically assigned by docker daemon at startup + + ## For advanced users You you want to use this container and code to build and create locally this container. You can follow theses instructions to setup and working environment. -- cgit v1.2.1