diff --git a/README.md b/README.md index 0ff52d3..77ba49d 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,69 @@ # docker-images -based images for Docker +based images for Docker + + +## Available Images + +- __pluie/alpine__ ( < 10 MB) Alpine/3.2 +- __pluie/alpine-apache__ ( ~ 37 MB) Apache/2.4.16 +- __pluie/alpine-mysql__ ( ~ 160 MB) Mysql/5.5.47 [MariaDB] + +## Base Image Structure + +``` +project/ + | + |-- install.d/ # deployed in /scripts on target container + | | # launch on docker image building process + | | # XX-name.sh - low XX are run first + | |-- 00-util.sh + | |-- 40-fix.sh + | + |-- pre-init.d/ # deployed in /scripts on target container + | | # launch on docker container running process + | |-- 50-example.sh + | + |-- build # build docker image : ./build [TAG] + |-- common.sh # don't modify - sourced by main.sh to execute pre-init.d scripts first + |-- install.sh # don't modify - execute install.d scripts on docker building process + |-- main.sh # source common.sh then execute entry point instruction + |-- util.sh # sourced by common.sh +``` + +## Extended Image Structure + +``` +project/ + | + |-- install.d/ + |-- pre-init.d/ + | + |-- build # same as based image + |-- main.sh # source based common.sh then execute entry point instruction +``` + +## Extended Image Dockerfile + +in any case, keep that : +``` +FROM $baseImage + +MAINTAINER $author $url + +ADD files.tar /scripts + +RUN bash /scripts/install.sh +``` + +then define only +__EXPOSE VOLUME__ & __ENV__ instructions + +## Building Process + +__build__ script archive project files in __files.tar__ then execute the __Docker build__ command. +``` +./build [optionalTag] +``` + +no need to worry about pwd, docker repository and image name depends on directory structure. +you can keep same __build__ script in any project