summaryrefslogtreecommitdiffstats
path: root/OS/README.md
diff options
context:
space:
mode:
authorstartxfr <clarue@startx.fr>2015-12-04 03:11:38 +0100
committerstartxfr <clarue@startx.fr>2015-12-04 03:11:38 +0100
commit65cce5013dad6a77e2f66bde26df45d4432e6e2c (patch)
treed3dccc7502d10d9e360d70729c4cc2693c0189f7 /OS/README.md
parentcb3d01d012d3b4d1fc24a5719ec13acdf2de60b1 (diff)
downloadphpmyadmin-65cce5013dad6a77e2f66bde26df45d4432e6e2c.tar.gz
phpmyadmin-65cce5013dad6a77e2f66bde26df45d4432e6e2c.tar.bz2
phpmyadmin-65cce5013dad6a77e2f66bde26df45d4432e6e2c.tar.xz
phpmyadmin-65cce5013dad6a77e2f66bde26df45d4432e6e2c.zip
improving general README.md
Diffstat (limited to 'OS/README.md')
-rw-r--r--OS/README.md16
1 files changed, 13 insertions, 3 deletions
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.