From 39b6d51215a88861caf57b0df9d34280a519a048 Mon Sep 17 00:00:00 2001 From: startxfr Date: Sat, 5 Dec 2015 03:57:20 +0100 Subject: improving php README.md --- Services/memcache/README.md | 2 +- Services/mongo/README.md | 2 +- Services/nodejs/README.md | 2 +- Services/php/Dockerfile | 3 +- Services/php/README.md | 86 +++++++++++----------- Services/php/read | 2 - Services/postgres/README.md | 170 ++++++++++++++++++++++++++++++++++++-------- 7 files changed, 187 insertions(+), 80 deletions(-) delete mode 100644 Services/php/read (limited to 'Services') diff --git a/Services/memcache/README.md b/Services/memcache/README.md index 66f3b17..c712fb0 100644 --- a/Services/memcache/README.md +++ b/Services/memcache/README.md @@ -10,7 +10,7 @@ weight=3 # Docker OS Images : MEMCACHE Simple and lightweight (130Mo) container used to deliver distributed memory object caching system -Run [memcached daemon](https://httpd.memcached.org/) under a container based on [startx/fedora container](https://hub.docker.com/r/startx/fedora) +Run [memcached daemon](https://www.memcached.org/) under a container based on [startx/fedora container](https://hub.docker.com/r/startx/fedora) | [![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/sv-memcache/) | [Sources](https://github.com/startxfr/docker-images/Services/memcache) | [STARTX Profile](https://github.com/startxfr) | |-------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------|------------------------------------------------------------------------------------|-----------------------------------------------| diff --git a/Services/mongo/README.md b/Services/mongo/README.md index 1f3f9ce..d34e8db 100644 --- a/Services/mongo/README.md +++ b/Services/mongo/README.md @@ -10,7 +10,7 @@ weight=3 # Docker OS Images : MONGO Simple and lightweight (150Mo) container used to deliver document-oriented database -Run [mongodb daemon](https://httpd.mongodb.org/) under a container based on [startx/fedora container](https://hub.docker.com/r/startx/fedora) +Run [mongodb daemon](https://www.mongodb.org/) under a container based on [startx/fedora container](https://hub.docker.com/r/startx/fedora) | [![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/sv-mongo/) | [Sources](https://github.com/startxfr/docker-images/Services/mongo) | [STARTX Profile](https://github.com/startxfr) | |-------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------|---------------------------------------------------------------------------------|-----------------------------------------------| diff --git a/Services/nodejs/README.md b/Services/nodejs/README.md index ca782e6..282df94 100644 --- a/Services/nodejs/README.md +++ b/Services/nodejs/README.md @@ -10,7 +10,7 @@ weight=3 # Docker OS Images : NODEJS Simple and lightweight (190Mo) container used to run server side executed javascript content. include all nodejs and npm dependency. -Run [nodejs main app.js](https://httpd.nodejs.org/) under a container based on [startx/fedora container](https://hub.docker.com/r/startx/fedora). Could use various network protocol (like http, websocket, smtp, telnet) according to the content of the running app. +Run [nodejs main app.js](https://www.nodejs.org/) under a container based on [startx/fedora container](https://hub.docker.com/r/startx/fedora). Could use various network protocol (like http, websocket, smtp, telnet) according to the content of the running app. | [![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/sv-nodejs/) | [Sources](https://github.com/startxfr/docker-images/Services/nodejs) | [STARTX Profile](https://github.com/startxfr) | |-------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------|----------------------------------------------------------------------------------|-----------------------------------------------| diff --git a/Services/php/Dockerfile b/Services/php/Dockerfile index ee02d89..51085e9 100644 --- a/Services/php/Dockerfile +++ b/Services/php/Dockerfile @@ -24,7 +24,6 @@ RUN rm -f $APP_PATH/Dockerfile $APP_PATH/httpd.conf $APP_PATH/run.sh && \ chown -R apache:apache $APP_PATH $LOG_PATH && \ chmod ug+r -R $APP_PATH -EXPOSE 80 -EXPOSE 443 +EXPOSE 80 443 VOLUME [$APP_PATH,$LOG_PATH] CMD ["/bin/run.sh"] \ No newline at end of file diff --git a/Services/php/README.md b/Services/php/README.md index 858a923..6aa51ad 100644 --- a/Services/php/README.md +++ b/Services/php/README.md @@ -1,46 +1,46 @@ -# Docker OS Images : APACHE +# Docker OS Images : APACHE + PHP -Simple and lightweight (120Mo) container used to deliver static http content include all apache's modules but no external languages engines (like php). For dynamic content, you should use our [sv-php service container](https://hub.docker.com/r/startx/sv-php) -Run [apache httpd daemon](https://httpd.apache.org/) under a container based on [startx/fedora container](https://hub.docker.com/r/startx/fedora) +Simple and lightweight (145Mo) container used to deliver dynamic http content using apache associated with PHP engine +Run [PHP engine](https://www.php.net) under a container based on [startx/sv-apache container](https://hub.docker.com/r/startx/sv-apache) -| [![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/sv-apache/) | [Sources](https://github.com/startxfr/docker-images/Services/apache) | [STARTX Profile](https://github.com/startxfr) | -|-------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------|----------------------------------------------------------------------------------|-----------------------------------------------| +| [![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/sv-php/) | [Sources](https://github.com/startxfr/docker-images/Services/php) | [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 +* `:latest` : Fedora core 23 + Apache + PHP +* `:fc23` : Fedora core 23 + Apache + PHP +* `:fc22` : Fedora core 22 + Apache + PHP +* `:fc21` : Fedora core 21 + Apache + PHP +* `:centos7` : CentOS 7 + Apache + PHP +* `:centos6` : Centos 6 + Apache + PHP ## Running from dockerhub registry -* with `docker` you can run `docker run -it --name="sv-apache" startx/sv-apache` from any docker host +* with `docker` you can run `docker run -it --name="sv-php" startx/sv-php` 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" + image: startx/sv-php:latest + container_name: "sv-php" environment: CONTAINER_TYPE: "service" - CONTAINER_SERVICE: "apache" - CONTAINER_INSTANCE: "service-apache" + CONTAINER_SERVICE: "php" + CONTAINER_INSTANCE: "service-php" SERVER_NAME: "localhost" - DOC_ROOT: "/data/apache" + DOC_ROOT: "/data/apache_php" volumes: - - "/tmp/container/logs/apache:/data/logs/apache" - - "/tmp/container/apache:/data/apache" + - "/tmp/container/logs/php:/data/logs/apache_php" + - "/tmp/container/php:/data/apache_php" ``` ## Docker-compose in various situations @@ -48,20 +48,20 @@ service: * sample docker-compose.yml linked to host port 1000 ``` service: - image: startx/sv-apache:latest - container_name: "sv-apache" + image: startx/sv-php:latest + container_name: "sv-php" environment: - CONTAINER_INSTANCE: "service-apache" + CONTAINER_INSTANCE: "service-php" ports: - "1000:80" ``` * sample docker-compose.yml with port exposed only to linked services ``` service: - image: startx/sv-apache:latest - container_name: "sv-apache" + image: startx/sv-php:latest + container_name: "sv-php" environment: - CONTAINER_INSTANCE: "service-apache" + CONTAINER_INSTANCE: "service-php" expose: - "80" ``` @@ -69,14 +69,14 @@ service: ``` data: image: startx/fedora:latest - container_name: "sv-apache-data" + container_name: "sv-php-data" environment: - CONTAINER_INSTANCE: "service-apache-data" + CONTAINER_INSTANCE: "service-php-data" service: - image: startx/sv-apache:latest - container_name: "sv-apache" + image: startx/sv-php:latest + container_name: "sv-php" environment: - CONTAINER_INSTANCE: "service-apache" + CONTAINER_INSTANCE: "service-php" volume_from: - data:rw ``` @@ -85,7 +85,7 @@ service: You can use this Dockerfile template to start a new personalized container based on this container. Create a file named Dockerfile in your project directory and copy this content inside. See [docker guide](http://docs.docker.com/engine/reference/builder/) for instructions on how to use this file. ``` -FROM startx/sv-apache:latest +FROM startx/sv-php:latest #... your container specifications CMD ["/bin/run.sh"] ``` @@ -100,8 +100,8 @@ CMD ["/bin/run.sh"] | 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` | default set to /data/logs/apache and used as a volume mountpoint -| APP_PATH | `auto` | `auto` | default set to /data/apache and used as a volume mountpoint +| LOG_PATH | `auto` | `auto` | default set to /data/logs/apache_php and used as a volume mountpoint +| APP_PATH | `auto` | `auto` | default set to /data/apache_php and used as a volume mountpoint ## Exposed port @@ -114,8 +114,8 @@ CMD ["/bin/run.sh"] | 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 +| /data/logs/apache_php | log directory used to record container and php logs +| /data/apache_php | data directory served by php. If empty will be filled with app on startup. In other case use content from mountpoint or data volumes ## Testing the service @@ -133,16 +133,16 @@ You must have a working environment with the source code of this repository. Rea ### Build & run a container using `docker` -1. Jump into the container directory with `cd Services/apache` -2. Build the container using `docker build -t sv-apache .` +1. Jump into the container directory with `cd Services/php` +2. Build the container using `docker build -t sv-php .` 3. Run this container - 1. Interactively with `docker run -p 80:80 -v /data/logs/apache -it sv-apache`. 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 sv-apache` + 1. Interactively with `docker run -p 80:80 -v /data/logs/apache_php -it sv-php`. 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_php -d sv-php` ### Build & run a container using `docker-compose` -1. Jump into the container directory with `cd Services/apache` +1. Jump into the container directory with `cd Services/php` 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 logs can be read using `docker-compose logs` diff --git a/Services/php/read b/Services/php/read deleted file mode 100644 index 3cd6763..0000000 --- a/Services/php/read +++ /dev/null @@ -1,2 +0,0 @@ -Server version: Apache/2.4.16 (Fedora) -Server built: Jul 17 2015 08:02:56 diff --git a/Services/postgres/README.md b/Services/postgres/README.md index 06605ec..d605de4 100644 --- a/Services/postgres/README.md +++ b/Services/postgres/README.md @@ -1,44 +1,154 @@ -# STARTX Services docker-images : PostgreSQL Server + -Container running postgres daemon under a fedora server. +# Docker OS Images : MARIADB -## Running from docker registry +Simple and lightweight (170Mo) container used to deliver mysql like database service using [mariadb project](https://mariadb.org/). +Run [mariadb daemon](https://mariadb.org/) under a container based on [startx/fedora container](https://hub.docker.com/r/startx/fedora) - docker run -d -p 5432:5432 --name="postgres" startx/sv-postgres - # when used with a volume container (run data container, then run service) - docker run -d -v /var/log/pgsql -v /var/lib/pgsql --name postgres-data startx/sv-postgres echo "Data container for postgresql" - docker run -d -p 5432:5432 --volumes-from postgres-data --name="postgres" startx/sv-postgres - when linked to another container - docker run -d --name="postgres" startx/sv-postgres - docker run -d --name="php" --link postgres:postgres startx/sv-php +| [![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/sv-mariadb/) | [Sources](https://github.com/startxfr/docker-images/Services/mariadb) | [STARTX Profile](https://github.com/startxfr) | +|-------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------|-----------------------------------------------------------------------------------|-----------------------------------------------| -## Build and run from local Dockerfile -### Building docker image -Copy sources in your docker host +## Available flavours - mkdir startx-docker-images; - cd startx-docker-images; - git clone https://github.com/startxfr/docker-images.git . +* `:latest` : Fedora core 23 + MariaDB +* `:fc23` : Fedora core 23 + MariaDB +* `:fc22` : Fedora core 22 + MariaDB +* `:fc21` : Fedora core 21 + MariaDB +* `:centos7` : CentOS 7 + MariaDB +* `:centos6` : Centos 6 + MariaDB -Build the container +## Running from dockerhub registry - docker build -t sv-postgres Services/postgres/ +* with `docker` you can run `docker run -it --name="sv-mariadb" startx/sv-mariadb` from any docker host +* with `docker-compose` you can create a docker-compose.yml file with the following content +``` +service: + image: startx/sv-mariadb:latest + container_name: "sv-mariadb" + environment: + CONTAINER_TYPE: "service" + CONTAINER_SERVICE: "mariadb" + CONTAINER_INSTANCE: "service-mariadb" + MYSQL_ROOT_PASSWORD: "rootpassword" + MYSQL_USER: "user-test" + MYSQL_PASSWORD: "pwd-test" + MYSQL_DATABASE: "db_test" + volumes: + - "/tmp/container/logs/mariadb:/data/logs/mariadb" + - "/tmp/container/mariadb:/data/mariadb" +``` -### Running local image +## Docker-compose in various situations - docker run -d -p 5432:5432 --name="postgres" sv-postgres +* sample docker-compose.yml linked to host port 1000 +``` +service: + image: startx/sv-mariadb:latest + container_name: "sv-mariadb" + environment: + CONTAINER_INSTANCE: "service-mariadb" + ports: + - "1001:3306" +``` +* sample docker-compose.yml with port exposed only to linked services +``` +service: + image: startx/sv-mariadb:latest + container_name: "sv-mariadb" + environment: + CONTAINER_INSTANCE: "service-mariadb" + expose: + - "3306" +``` +* sample docker-compose.yml using data container +``` +data: + image: startx/fedora:latest + container_name: "sv-mariadb-data" + environment: + CONTAINER_INSTANCE: "service-mariadb-data" +service: + image: startx/sv-mariadb:latest + container_name: "sv-mariadb" + environment: + CONTAINER_INSTANCE: "service-mariadb" + volume_from: + - data:rw +``` -## Accessing server -access to the running database +## Using this image in your own container - psql -U postgres -h localhost -p 5432 +You can use this Dockerfile template to start a new personalized container based on this container. Create a file named Dockerfile in your project directory and copy this content inside. See [docker guide](http://docs.docker.com/engine/reference/builder/) for instructions on how to use this file. + ``` +FROM startx/sv-mariadb:latest +#... your container specifications +CMD ["/bin/run.sh"] +``` -access to the container itself +## Environment variable - docker exec -it mongo bash +| 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 +| MYSQL_ROOT_PASSWORD | `string` | `no` | Root password used for this instance. Default will use an auto generated password displayed on startup +| MYSQL_USER | `string` | `no` | If present, add a new user with this name +| MYSQL_PASSWORD | `string` | `no` | Password associated to the new user declared with $MYSQL_USER +| MYSQL_DATABASE | `string` | `no` | If present, add a new database with this name +| LOADSQL_PATH | `string` | `auto` | Path used to find sql dump to import at startup +| HOSTNAME | `auto` | `auto` | Container unique id automatically assigned by docker daemon at startup +| LOG_PATH | `auto` | `auto` | default set to /data/logs/mariadb and used as a volume mountpoint +| DATA_PATH | `auto` | `auto` | default set to /data/mariadb and used as a volume mountpoint -## Related Resources -* [Sources files](https://github.com/startxfr/docker-images/tree/master/Services/postgres) -* [Github STARTX profile](https://github.com/startxfr/docker-images) -* [Docker registry for this container](https://registry.hub.docker.com/u/startx/sv-postgres/) -* [Docker registry for Fedora](https://registry.hub.docker.com/u/fedora/) +## Exposed port + +| Port | Description | +|-------|--------------------------------------------------------------------------| +| 3306 | standard mariadb network port used for sql communication + +## Exposed volumes + +| Container directory | Description | +|----------------------|--------------------------------------------------------------------------| +| /data/logs/mariadb | log directory used to record container and mariadb logs +| /data/mariadb | data directory served by mariadb. If empty will be filled with database files on startup. In other case use content from mountpoint or data volumes + +## Testing the service + +access to the running service with mysql terminal `mysql --host=localhost --port=3306 --user= --password=`. Change port and hostname according to your current configuration + +## For advanced users + +You want to use this container and code to build and create locally this container, follow theses instructions. + +This section will help you if you want to : +* Get latest version of this service container +* 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 Services/mariadb` +2. Build the container using `docker build -t sv-mariadb .` +3. Run this container + 1. Interactively with `docker run -p 3306:3306 -v /data/logs/mariadb -it sv-mariadb`. 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 3306:3306 -v /data/logs/mariadb -d sv-mariadb` + + +### Build & run a container using `docker-compose` + +1. Jump into the container directory with `cd Services/mariadb` +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 logs can be read using `docker-compose logs` + +If you experience trouble with port already used, edit docker-compose.yml file and change port mapping -- cgit v1.2.3