Document s2i functionality

container-images · Oct 11, 2017 · e121b9b · e121b9b
1 parent 222528b
commit e121b9b
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -62,6 +62,19 @@ For more information about Postfix TLS support see `http://www.postfix.org/TLS_R
 
 The page [POSTFIX_CERTS_GENERATION.md](/POSTFIX_CERTS_GENERATION.md) will help you with generation self signed certificate used by postfix.
 
+## S2I extensibility
+You can configure this container to adhere your needs using [Source-to-Image](https://github.com/openshift/source-to-image) and shell scripts. To create a new Docker image named  `postfix-app`, that will be configured by your needs, just setup this directory: `./app-name/postfix-pre-init` that will contain `*.sh` scripts that will be executed right before postfix will start, so you can use `postconf` and other tools to configure postfix. Then just excute the s2i build:
+```
+s2i build file://path/to/app-name docker.io/modularitycontainers/postfix postfix-app
+```
+You can execute such image as you would non-s2i one:
+```
+docker run -it -e MYHOSTNAME=localhost \
+    -p 25:10025\
+    -v /var/spool/postfix:/var/spool/postfix \
+    -v /var/spool/mail:/var/spool/mail postfix
+    -d postfix-app
+```
 ## How to test the postfix mail server
 
 See `help/help.md` file.
diff --git a/README.md.template b/README.md.template
@@ -62,6 +62,19 @@ For more information about Postfix TLS support see `http://www.postfix.org/TLS_R
 
 The page [POSTFIX_CERTS_GENERATION.md](/POSTFIX_CERTS_GENERATION.md) will help you with generation self signed certificate used by {{ spec.envvars.name }}.
 
+## S2I extensibility
+You can configure this container to adhere your needs using [Source-to-Image](https://github.com/openshift/source-to-image) and shell scripts. To create a new Docker image named  `postfix-app`, that will be configured by your needs, just setup this directory: `./app-name/postfix-pre-init` that will contain `*.sh` scripts that will be executed right before postfix will start, so you can use `postconf` and other tools to configure postfix. Then just excute the s2i build:
+```
+s2i build file://path/to/app-name {{ spec.image_repository }} postfix-app
+```
+You can execute such image as you would non-s2i one:
+```
+docker run -it -e MYHOSTNAME=localhost \
+    -p 25:10025\
+    -v /var/spool/postfix:/var/spool/postfix \
+    -v /var/spool/mail:/var/spool/mail {{ spec.envvars.name }}
+    -d postfix-app
+```
 ## How to test the postfix mail server
 
 See `help/help.md` file.
diff --git a/help/help.md b/help/help.md
@@ -13,6 +13,10 @@ To get the {{ spec.envvars.name }} container image on your local system, run the
 
     docker pull {{ spec.image_repository }}
 
+You can further configure this image using Source-to-Image. The application only needs to contain a postfix-pre-init directory with your `.sh` scripts that will be executed right before postfix starts. You can build this image named `postfix-app` by using this commnad:
+
+    s2i build file://path/to/app-name {{ spec.image_repository }} postfix-app
+
 Commands for testing {{ spec.envvars.name }} docker container:
 
 ```$ telnet localhost 25```