From cfd0715d0543a3554b8a94b079d35b2022b2fe4c Mon Sep 17 00:00:00 2001
From: startxfr <clarue@startx.fr>
Date: Sat, 5 Dec 2015 02:06:41 +0100
Subject: improving general README.md
---
OS/Dockerfile | 4 +-
OS/README.md | 16 ++--
README.md | 4 +
Services/apache/README.md | 198 +++++++++++++++++++++++++++++++++-----------
Services/apache/sx-httpd.sh | 6 +-
5 files changed, 168 insertions(+), 60 deletions(-)
diff --git a/OS/Dockerfile b/OS/Dockerfile
index dba7035..769a43e 100644
--- a/OS/Dockerfile
+++ b/OS/Dockerfile
@@ -8,6 +8,8 @@ RUN dnf -y install deltarpm pwgen tar python-dnf-plugins-extras-migrate && \
dnf -y install psmisc procps coreutils findutils wget logrotate zip && \
dnf clean all
COPY *.sh /bin/
-RUN chmod 775 /bin/sx-lib.sh /bin/run.sh
+RUN chmod 775 /bin/sx-lib.sh /bin/run.sh && \
+ mkdir /data && \
+ mkdir /data/logs
CMD ["/bin/run.sh"]
diff --git a/OS/README.md b/OS/README.md
index 82b96c6..268285a 100644
--- a/OS/README.md
+++ b/OS/README.md
@@ -1,15 +1,15 @@
<!--[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, "]
+title = "STARTX Docker OS Images : FEDORA"
+description = "Docker container repository based on latest fedora"
+keywords = ["home, docker, startx, fedora, repository, container, swarm, compose, howto, "]
weight=3
+++
<![end-metadata]-->
-# Fedora OS container's
+# Docker OS Images : FEDORA
-Simple and extralight (110Mo) container used for all startx based services and application published in [Dockerhub registry](https://github.com/startxfr/docker-images).
+Simple and lightweight (110Mo) container used for all startx based services and applications 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
| [](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) |
@@ -22,7 +22,7 @@ This container contain updated core OS rpm (kernel, libs,...) as well as usefull
* `:23` : Fedora core 23
* `:22` : Fedora core 22
* `:21` : Fedora core 21
-* `:21` : Fedora core 21
+* `:20` : Fedora core 20
## Running from dockerhub registry
@@ -30,7 +30,7 @@ This container contain updated core OS rpm (kernel, libs,...) as well as usefull
* with `docker-compose` you can create a docker-compose.yml file with the following content
```
fedora:
- image: startx/fedora
+ image: startx/fedora:latest
container_name: "os-fedora"
environment:
CONTAINER_TYPE: "os"
@@ -51,9 +51,9 @@ CMD ["/bin/run.sh"]
| Variable | Type | Mandatory | Description |
|---------------------------|----------|-----------|--------------------------------------------------------------------------|
+| CONTAINER_INSTANCE | `string` | `yes` | Container name. Should be uning to get fine grained log and application reporting
| 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
diff --git a/README.md b/README.md
index 28fc907..9a7b410 100644
--- a/README.md
+++ b/README.md
@@ -16,6 +16,10 @@ or as a parent container in your own container's.
Each container is provided with various underlying OS version based on CentOS or
Fedora Linux distribution.
+If you're used to work with redhat like and distribution, you would prefer start working
+from a container based on this distribution rather than ubuntu or debian like distributions.
+OS, services and application you will find here will be closer to your favorite distrbution
+
Please **read each container manual** for more information on how you can use it in
your project and start using stable or experimental services in your applications
diff --git a/Services/apache/README.md b/Services/apache/README.md
index eb4fdec..23a83b5 100644
--- a/Services/apache/README.md
+++ b/Services/apache/README.md
@@ -1,47 +1,151 @@
-# STARTX Services docker-images : Simple Webserver
-
-Container running apache httpd daemon under a fedora server
-
-## Running from docker registry
-
- docker run -d -p 80:80 --name="apache" startx/sv-apache
- # when used with a volume container (run data container, then run service)
- docker run -d -v /var/www/html -v /var/logs/apache --name apache-data startx/sv-apache echo "Data container for apache"
- docker run -d -p 80:80 --volumes-from apache-data --name="apache" startx/sv-apache
- # when used in a linked container
- docker run -d --name="apache" startx/sv-apache
- docker run -d -p 80:80 --name="apache2" --link apache:apache startx/sv-apache
-
-## Build and run from local Dockerfile
-### Building docker image
-Copy sources in your docker host
-
- mkdir startx-docker-images;
- cd startx-docker-images;
- git clone https://github.com/startxfr/docker-images.git .
-
-Change configuration and personalize your base image. you can change file httpd.conf if you want to add some config into http server
-
-Build the container
-
- docker build -t sv-apache Services/apache/
-
-### Running local image
-
- docker run -d -p 80:80 --name="apache" sv-apache
-
-## Accessing server
-access to the running webserver
-
- firefox http://localhost:80
-
-access to the container itself
-
- docker exec -it apache /bin/bash
-
-## Related Resources
-* [Sources files](https://github.com/startxfr/docker-images/tree/master/Services/apache)
-* [Github STARTX profile](https://github.com/startxfr/docker-images)
-* [Docker registry for this container](https://registry.hub.docker.com/u/startx/sv-apache/)
-* [Docker registry for Fedora](https://registry.hub.docker.com/u/fedora/)
-
+<!--[metadata]>
++++
+title = "STARTX Docker Services Images : APACHE"
+description = "Docker container repository based on latest fedora"
+keywords = ["home, docker, startx, apache, fedora, centos, repository, container, swarm, compose"]
+weight=3
++++
+<![end-metadata]-->
+
+# Docker OS Images : APACHE
+
+Simple and lightweight (120Mo) container used to deliver static http content include all aache module but no externa languages engines (like php). For dynamic content, you should use our [sv-php service container](https://hub.docker.com/r/startx/sv-php)
+This container contain updated core OS rpm (kernel, libs,...) as well as usefull tools like pwgen, tar, zip, psmisc, procps, coreutils, findutils, wget
+
+| [](https://travis-ci.org/startxfr/docker-images) | [Dockerhub Registry](https://hub.docker.com/r/startx/sv-apache/) | [Sources](https://github.com/startxfr/docker-images/Services/apache) | [STARTX Profile](https://github.com/startxfr) |
+|-------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------|----------------------------------------------------------------------------------|-----------------------------------------------|
+
+
+## Available flavours
+
+* `:latest` : Fedora core 23 + Apache
+* `:fc23` : Fedora core 23 + Apache
+* `:fc22` : Fedora core 22 + Apache
+* `:fc21` : Fedora core 21 + Apache
+* `:centos7` : CentOS 7 + Apache
+* `:centos6` : Centos 6 + Apache
+
+## Running from dockerhub registry
+
+* with `docker` you can run `docker run -it --name="startx_apache" startx/sv-apache` from any docker host
+* with `docker-compose` you can create a docker-compose.yml file with the following content
+```
+service:
+ image: startx/sv-apache:latest
+ container_name: "sv-apache"
+ environment:
+ CONTAINER_TYPE: "service"
+ CONTAINER_SERVICE: "apache"
+ CONTAINER_INSTANCE: "service-apache"
+ SERVER_NAME: "localhost"
+ DOC_ROOT: "/data/apache"
+ volumes:
+ - "/tmp/container/logs/apache:/data/logs/apache"
+ - "/tmp/container/apache:/data/apache"
+```
+
+## Docker-compose in various situations
+
+* sample docker-compose.yml linked to host port 1000
+```
+service:
+ image: startx/sv-apache:latest
+ container_name: "sv-apache"
+ environment:
+ CONTAINER_INSTANCE: "service-apache"
+ ports:
+ - "1000:80"
+```
+* sample docker-compose.yml with port exposed only to linked services
+```
+service:
+ image: startx/sv-apache:latest
+ container_name: "sv-apache"
+ environment:
+ CONTAINER_INSTANCE: "service-apache"
+ expose:
+ - "80"
+```
+* sample docker-compose.yml using data container
+```
+data:
+ image: startx/fedora:latest
+ container_name: "sv-apache-data"
+ environment:
+ CONTAINER_INSTANCE: "service-apache-data"
+service:
+ image: startx/sv-apache:latest
+ container_name: "sv-apache"
+ environment:
+ CONTAINER_INSTANCE: "service-apache"
+ volume_from:
+ - data:rw
+```
+
+## Using this image in your own 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_INSTANCE | `string` | `yes` | Container name. Should be uning to get fine grained log and application reporting
+| CONTAINER_TYPE | `string` | `no` | Container family (os, service, application. could be enhanced
+| CONTAINER_SERVICE | `string` | `no` | Define the type of service or application provided
+| SERVER_NAME | `string` | `no` | Server name for this container. If no name localhost will be assigned
+| HOSTNAME | `auto` | `auto` | Container unique id automatically assigned by docker daemon at startup
+| DOC_ROOT | `auto` | `auto` | document root, will use the $APP_PATH variable
+| LOG_PATH | `auto` | `auto` | is set to /data/logs/apache and used as a volume mountpoint
+| APP_PATH | `auto` | `auto` | is set to /data/apache and used as a volume mountpoint
+
+## Exposed port
+
+| Port | Description |
+|-------|--------------------------------------------------------------------------|
+| 80 | standard httpd network port used for non encrypted http traffic
+| 443 | SSL enabeled http port used for encrypted traffic (certificate not actually implemented)
+
+## Exposed volumes
+
+| Container directory | Description |
+|----------------------|--------------------------------------------------------------------------|
+| /data/logs/apache | log directory used to record container and apache logs
+| /data/apache | data directory served by apache. If empty will be filled with app on startup. In other case use content from mountpoint or data volumes
+
+## Testing the service
+
+access to the running webserver with your favorites browser `firefox http://localhost:80`. Change port and hostname according to your current configuration
+
+## 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.
+
+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
+
+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 -p 80:80 -v /data/logs/apache -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 -p 80:80 -v /data/logs/apache -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`
+
+If you experience trouble with port already used, edit docker-compose.yml file and change port mapping
diff --git a/Services/apache/sx-httpd.sh b/Services/apache/sx-httpd.sh
index 57a6e32..ec8c6bb 100644
--- a/Services/apache/sx-httpd.sh
+++ b/Services/apache/sx-httpd.sh
@@ -8,13 +8,11 @@ function check_httpd_environment {
echo "! WARNING : environment var SERVER_NAME is missing..."
echo "! WARNING : auto-assigned value : $SERVER_NAME"
fi
- if [ ! -v DOC_ROOT ]; then
- DOC_ROOT="/data/apache"
- export DOC_ROOT
- fi
if [ ! -v APP_PATH ]; then
APP_PATH="/data/apache"
export APP_PATH
+ DOC_ROOT=$APP_PATH
+ export DOC_ROOT
fi
if [ ! -v LOG_PATH ]; then
LOG_PATH="/data/logs/apache"
--
cgit v1.2.3