summaryrefslogtreecommitdiffstats
path: root/OS/README.md
diff options
context:
space:
mode:
authorstartxfr <clarue@startx.fr>2015-12-04 02:35:23 +0100
committerstartxfr <clarue@startx.fr>2015-12-04 02:35:23 +0100
commitcb3d01d012d3b4d1fc24a5719ec13acdf2de60b1 (patch)
treee626f8589d0555c791949133fa98f5349ef86424 /OS/README.md
parenta77cdec9428949c2027b3cbe78f1ec3c73c3e453 (diff)
downloadphpmyadmin-cb3d01d012d3b4d1fc24a5719ec13acdf2de60b1.tar.gz
phpmyadmin-cb3d01d012d3b4d1fc24a5719ec13acdf2de60b1.tar.bz2
phpmyadmin-cb3d01d012d3b4d1fc24a5719ec13acdf2de60b1.tar.xz
phpmyadmin-cb3d01d012d3b4d1fc24a5719ec13acdf2de60b1.zip
improving general README.md
Diffstat (limited to 'OS/README.md')
-rw-r--r--OS/README.md97
1 files changed, 60 insertions, 37 deletions
diff --git a/OS/README.md b/OS/README.md
index eda12f5..938d20e 100644
--- a/OS/README.md
+++ b/OS/README.md
@@ -1,51 +1,74 @@
-# STARTX OS docker-images : Fedora
-Fedora image builded with minimal and updated rpm and core-utils loaded (utils like ps, top, find, wget)
-All other images on this repository are build on top of this container image
+<!--[metadata]>
++++
+title = "STARTX Docker Images Repository"
+description = "Docker container repository based on fedora or CentOS and deliverying main opensource project as container"
+keywords = ["home, docker, startx, repository, container, swarm, compose, howto, "]
+weight=3
++++
+<![end-metadata]-->
-## Running from docker registry
+# Fedora OS container's
- docker run -it --name="fedora" startx/fedora
+Simple 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 and run from local Dockerfile
-1. Building docker image
+| [![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) |
+|-------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------|----------------------------------------------------------------------|-----------------------------------------------|
- # Step 1 : Copy sources in your docker host
- mkdir startx-docker-images;
- cd startx-docker-images;
- git clone https://github.com/startxfr/docker-images.git .
- # Step 2 : Build the container
- docker build -t fedora OS/
-2. Running local image
+## Available flavours
- docker run -it --name="fedora" fedora bash
+* `:latest` : Fedora core 23 at this time
+* `:23` : Fedora core 23
+* `:22` : Fedora core 22
+* `:21` : Fedora core 21
+* `:21` : Fedora core 21
+## Running from dockerhub registry
-## Building and running using docker-compose
-1. Building from source
+* with `docker` you can run `docker run -it --name="fedora" startx/fedora` from every docker host
+* with `docker-compose` you can create a docker-compose.yml file with the following content
+```
+fedora:
+ image: startx/fedora
+ container_name: "os-fedora"
+ environment:
+ CONTAINER_TYPE: "os"
+ CONTAINER_SERVICE: "fedora"
+ CONTAINER_INSTANCE: "os-fedora"
+```
- # Step 1 : Copy sources in your docker host
- mkdir startx-docker-images;
- git clone https://github.com/startxfr/docker-images.git startx-docker-images;
- cd startx-docker-images/OS;
- # Step 2 : Build the container
- docker-compose build;
+## Using this image in your own container
-2. Running this service
+You can use this Dockerfile template to start a new prsonalized container based on this container
+ ```
+FROM startx/fedora:latest
+#... your container specifications
+CMD ["/bin/run.sh"]
+```
- docker-compose up -d;
- docker-compose logs;
+## For advanced users
-## Accessing server
+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.
- # Start interactive shell
- docker run -it startx/fedora bash
- # Start as a daemon
- docker run -d startx/fedora bash
- docker exec -it fedora /bin/bash
+This section will help you if you want to :
+* Get latest version of this container OS
+* Enhance container content by adding instruction in Dockefile before build step
-## Related Resources
-* [Sources files](https://github.com/startxfr/docker-images/tree/master/Services/fedora)
-* [Github STARTX profile](https://github.com/startxfr/docker-images)
-* [Docker registry for this container](https://registry.hub.docker.com/u/startx/fedora/)
-* [Docker registry for Fedora](https://registry.hub.docker.com/u/fedora/) \ No newline at end of file
+You must have a working environment with the source code of this repository. Read and follow [how to setup your working environment](https://github.com/startxfr/docker-images#setup-your-working-environment-mandatory) to get a working directory. The following instructions assume you are at the top level of your working directory.
+
+### Build & run a container using `docker`
+
+1. Jump into the container directory with `cd OS`
+2. Build the container using `docker build -t fedora .`
+3. Run this container
+ 1. Interactively with `docker run -it fedora`. If you add a second parameter (like `/bin/bash`) to will run this command instead of the default entrypoint. Usefull to interact with this container (ex: `/bin/bash`, `/bin/ps -a`, `/bin/df -h`,...)
+ 2. As a daemon with `docker run -d fedora`
+
+
+### Build & run a container using `docker-compose`
+
+1. Jump into the container directory with `cd OS`
+2. Run this container
+ 1. Interactively with `docker-compose up` Startup logs appears and escaping this command stop the container
+ 2. As a daemon with `docker-compose up -d`. Container startup and behaviour can be read using `docker-compose logs`