improving nodejs README.md

1 files changed, 45 insertions, 48 deletions

diff --git a/Services/nodejs/README.md b/Services/nodejs/README.md
index 0db085b..5a2afee 100644
--- a/Services/nodejs/README.md
+++ b/Services/nodejs/README.md
@@ -1,46 +1,44 @@
 <!--[metadata]>
 +++
-title = "STARTX Docker Services Images : APACHE"
-description = "Docker container with apache service based on latest fedora"
-keywords = ["home, docker, startx, apache, fedora, centos, repository, container, swarm, compose"]
+title = "STARTX Docker Services Images : NODEJS"
+description = "Docker container with nodejs service based on latest fedora"
+keywords = ["home, docker, startx, nodejs, fedora, centos, repository, container, swarm, compose"]
 weight=3
 +++
 <![end-metadata]-->
 
-# Docker OS Images : APACHE
+# Docker OS Images : NODEJS
 
-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 (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.
 
-| [![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-nodejs/) | [Sources](https://github.com/startxfr/docker-images/Services/nodejs)             | [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 + NodeJS 
+* `:fc23` : Fedora core 23 + NodeJS 
+* `:fc22` : Fedora core 22 + NodeJS 
+* `:fc21` : Fedora core 21 + NodeJS 
+* `:centos7` : CentOS 7 + NodeJS 
+* `:centos6` : Centos 6 + NodeJS 
 
 ## 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-nodejs" startx/sv-nodejs` 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-nodejs:latest
+  container_name: "sv-nodejs"
   environment:
     CONTAINER_TYPE: "service"
-    CONTAINER_SERVICE: "apache"
-    CONTAINER_INSTANCE: "service-apache"
-    SERVER_NAME: "localhost"
-    DOC_ROOT: "/data/apache"
+    CONTAINER_SERVICE: "nodejs"
+    CONTAINER_INSTANCE: "service-nodejs"
   volumes:
-    - "/tmp/container/logs/apache:/data/logs/apache"
-    - "/tmp/container/apache:/data/apache"
+    - "/tmp/container/logs/nodejs:/data/logs/nodejs"
+    - "/tmp/container/nodejs:/data/nodejs"
 ```
 
 ## Docker-compose in various situations
@@ -48,20 +46,20 @@ service:
 * sample docker-compose.yml linked to host port 1000
 ```
 service:
-  image: startx/sv-apache:latest
-  container_name: "sv-apache"
+  image: startx/sv-nodejs:latest
+  container_name: "sv-nodejs"
   environment:
-    CONTAINER_INSTANCE: "service-apache"
+    CONTAINER_INSTANCE: "service-nodejs"
   ports:
     - "1000:8000"
 ```
 * sample docker-compose.yml with port exposed only to linked services
 ```
 service:
-  image: startx/sv-apache:latest
-  container_name: "sv-apache"
+  image: startx/sv-nodejs:latest
+  container_name: "sv-nodejs"
   environment:
-    CONTAINER_INSTANCE: "service-apache"
+    CONTAINER_INSTANCE: "service-nodejs"
   expose:
     - "8000"
 ```
@@ -69,14 +67,14 @@ service:
 ```
 data:
   image: startx/fedora:latest
-  container_name: "sv-apache-data"
+  container_name: "sv-nodejs-data"
   environment:
-    CONTAINER_INSTANCE: "service-apache-data"
+    CONTAINER_INSTANCE: "service-nodejs-data"
 service:
-  image: startx/sv-apache:latest
-  container_name: "sv-apache"
+  image: startx/sv-nodejs:latest
+  container_name: "sv-nodejs"
   environment:
-    CONTAINER_INSTANCE: "service-apache"
+    CONTAINER_INSTANCE: "service-nodejs"
   volume_from:
     - data:rw
 ```
@@ -85,7 +83,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-nodejs:latest
 #... your container specifications
 CMD ["/bin/run.sh"]
 ```
@@ -97,28 +95,27 @@ CMD ["/bin/run.sh"]
 | 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
+| APP_MAIN                  | `string` | `no`      | Path to the application entrypoint. default is /data/nodejs/app.js
+| LOG_PATH                  | `auto`   | `auto`    | default set to /data/logs/nodejs and used as a volume mountpoint
+| APP_PATH                  | `auto`   | `auto`    | default set to /data/nodejs and used as a volume mountpoint
+| TMP_APP_PATH              | `auto`   | `auto`    | default set to /tmp/nodejs and used to hold app content and copy to $APP_PATH on startup (if $APP_PATH is empty)
 
 ## Exposed port
 
 | Port  | Description                                                              |
 |-------|--------------------------------------------------------------------------|
-| 8000  | standard httpd network port used for non encrypted http traffic
+| 8000  | network port used to communicate with the running application. Network protocol depend on the running app content.
 
 ## 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
+| /data/logs/nodejs    | log directory used to record container and nodejs logs
+| /data/nodejs         | data directory served by nodejs. If empty will be filled with app on startup. In other case use content from $TMP_APP_PATH directory
 
 ## Testing the service
 
-access to the running webserver with your favorites browser `firefox http://localhost:8000`. Change port and hostname according to your current configuration
+access to the running application accoridn to the protocol(s) used in your application. For webcontent, you can use `firefox http://localhost:8000`. Change port and hostname according to your current configuration
 
 ## For advanced users
 
@@ -132,16 +129,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/nodejs`
+2. Build the container using `docker build -t sv-nodejs .`
 3. Run this container 
-  1. Interactively with `docker run -p 8000:8000 -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 8000:8000 -v /data/logs/apache -d sv-apache`
+  1. Interactively with `docker run -p 8000:8000 -v /data/logs/nodejs -it sv-nodejs`. 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 8000:8000 -v /data/logs/nodejs -d sv-nodejs`
 
 
 ### 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/nodejs`
 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`