diff options
Diffstat (limited to 'Services/nodejs')
| -rw-r--r-- | Services/nodejs/README.md | 165 |
1 files changed, 135 insertions, 30 deletions
diff --git a/Services/nodejs/README.md b/Services/nodejs/README.md index de276b4..0db085b 100644 --- a/Services/nodejs/README.md +++ b/Services/nodejs/README.md @@ -1,44 +1,149 @@ -# STARTX Services docker-images : NodeJS Server +<!--[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"] +weight=3 ++++ +<![end-metadata]--> -Container running nodejs daemon under a fedora server +# Docker OS Images : APACHE -## Running from docker registry +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) - docker run -d -p 8000:8000 --name="nodejs" startx/sv-nodejs - # when used with a volume container (run data container, then run service) - docker run -d -v /var/nodejs/app --name nodejs-data startx/sv-nodejs echo "Data container for nodejs" - docker run -d -p 8000:8000 --volumes-from nodejs-data --name="nodejs" startx/sv-nodejs - when linked to another container - docker run -d --name="mongo" startx/sv-mongo - docker run -d -p 8000:8000 --name="nodejs" --link mongo:mongo startx/sv-nodejs +| [](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 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 + Apache +* `:fc23` : Fedora core 23 + Apache +* `:fc22` : Fedora core 22 + Apache +* `:fc21` : Fedora core 21 + Apache +* `:centos7` : CentOS 7 + Apache +* `:centos6` : Centos 6 + Apache -Build the container +## Running from dockerhub registry - docker build -t sv-nodejs Services/nodejs/ +* with `docker` you can run `docker run -it --name="sv-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" +``` -### Running local image +## Docker-compose in various situations - docker run -d -p 8000:8000 --name="nodejs" sv-nodejs +* 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:8000" +``` +* 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: + - "8000" +``` +* 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 +``` -## Accessing server -access to the running webserver +## Using this image in your own container - firefox http://localhost:8000 +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 +#... your container specifications +CMD ["/bin/run.sh"] +``` -access to the container itself +## Environment variable - docker exec -it nodejs /bin/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 +| 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 -## Related Resources -* [Sources files](https://github.com/startxfr/docker-images/tree/master/Services/nodejs) -* [Github STARTX profile](https://github.com/startxfr/docker-images) -* [Docker registry for this container](https://registry.hub.docker.com/u/startx/sv-nodejs/) -* [Docker registry for Fedora](https://registry.hub.docker.com/u/fedora/)
\ No newline at end of file +## Exposed port + +| Port | Description | +|-------|--------------------------------------------------------------------------| +| 8000 | standard httpd network port used for non encrypted http traffic + +## 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:8000`. 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/apache` +2. Build the container using `docker build -t sv-apache .` +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` + + +### Build & run a container using `docker-compose` + +1. Jump into the container directory with `cd Services/apache` +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 |