mirror of
https://github.com/bitnami/containers.git
synced 2026-03-14 06:48:11 +08:00
Improve README
This commit is contained in:
Adnan Abdulhussein
@@ -1,45 +1,292 @@
|
||||
# Bitnami Node.js Docker Container
|
||||
# What is node.js?
|
||||
|
||||
## Introduction to Bitnami containers
|
||||
Bitnami provides easy-to-use, consistently configured, and always up-to-date container images. [Click here](https://bitnami.com) for more information on our packaging approach.
|
||||
node.js allows developers to build scalable, real-time web applications with two-way connections
|
||||
between the client and server.
|
||||
|
||||
## What is Node.js?
|
||||
Node.js allows developers to build scalable, real-time web applications with two-way connections between the client and server.
|
||||
# TLDR
|
||||
|
||||
## Usage
|
||||
You can instantiate a Bitnami Node.js container by doing:
|
||||
|
||||
```
|
||||
HOST_NODE_APP_DIR=`pwd`/node_app
|
||||
HOST_NODE_SERVER_PORT=8080
|
||||
CONTAINER_NODE_SERVER_NAME=node-app
|
||||
docker run -it \
|
||||
-p $HOST_NODE_SERVER_PORT:80 \
|
||||
-v $HOST_NODE_APP_DIR:/node_app \
|
||||
--name $CONTAINER_NODE_SERVER_NAME
|
||||
bitnami/node
|
||||
```bash
|
||||
docker run -it --name node bitnami/node
|
||||
```
|
||||
|
||||
## Linking
|
||||
## Docker Compose
|
||||
|
||||
You can link the Node.js to a container running your application, e.g., using the Bitnami nginx container:
|
||||
|
||||
```
|
||||
CONTAINER_NODE_LINK_NAME=node-app
|
||||
docker run --rm -it \
|
||||
--link $CONTAINER_NODE_SERVER_NAME:$CONTAINER_NODE_LINK_NAME \
|
||||
-v $HOST_NODE_APP_DIR:/app bitnami/nginx
|
||||
```yaml
|
||||
node:
|
||||
image: bitnami/node
|
||||
command: node script.js
|
||||
volumes:
|
||||
- path/to/node/app:/app
|
||||
```
|
||||
|
||||
Inside your application, use the value of $CONTAINER_NODE_LINK_NAME when setting up your virtual host.
|
||||
The Bitnami nginx container comes with an example virtual host for connecting to this Node.js container.
|
||||
# Get this image
|
||||
|
||||
## Logging
|
||||
The recommended way to get the Bitnami node.js Docker Image is to pull the prebuilt image from the
|
||||
[Docker Hub Registry](https://hub.docker.com).
|
||||
|
||||
The container is set up to log to stdout, which means logs can be obtained as follows:
|
||||
|
||||
```
|
||||
docker logs $CONTAINER_NODE_SERVER_NAME
|
||||
```bash
|
||||
docker pull bitnami/node:0.12.4-1
|
||||
```
|
||||
|
||||
If you would like to log to a file instead, you can mount a volume at `/logs`.
|
||||
To always get the latest version, pull the `latest` tag.
|
||||
|
||||
```bash
|
||||
docker pull bitnami/node:latest
|
||||
```
|
||||
|
||||
If you wish, you can also build the image yourself.
|
||||
|
||||
```bash
|
||||
git clone https://github.com/bitnami/bitnami-docker-node.git
|
||||
cd docker-node.js
|
||||
docker build -t bitnami/node
|
||||
```
|
||||
|
||||
# Entering the REPL
|
||||
|
||||
By default, running this image will drop you into the node.js REPL, where you can interactively test
|
||||
and try things out in node.js.
|
||||
|
||||
```bash
|
||||
docker run -it --name node bitnami/node
|
||||
```
|
||||
|
||||
**Further Reading:**
|
||||
|
||||
- <a href="https://nodejs.org/api/repl.html" target="_blank">nodejs.org/api/repl.html</a>
|
||||
|
||||
# Running your node.js script
|
||||
|
||||
The default work directory for the node.js image is `/app`. You can mount a folder from your host
|
||||
here that includes your node.js script, and run it normally using the `node` command.
|
||||
|
||||
```bash
|
||||
docker run -it --name node -v /path/to/node/app:/app bitnami/node \
|
||||
node script.js
|
||||
```
|
||||
|
||||
# Running a node.js app with npm dependencies
|
||||
|
||||
If your node.js app has a `package.json` defining your app's dependencies and start script, you can
|
||||
install the dependencies before running your app.
|
||||
|
||||
```bash
|
||||
docker run --rm -v /path/to/node/app:/app bitnami/node npm install
|
||||
docker run -it --name node -v /path/to/node/app:/app bitnami/node npm start
|
||||
```
|
||||
|
||||
or using Docker Compose:
|
||||
|
||||
```yaml
|
||||
node:
|
||||
image: bitnami/node
|
||||
command: "sh -c 'npm install && npm start'"
|
||||
```
|
||||
|
||||
**Further Reading:**
|
||||
|
||||
- <a href="https://docs.npmjs.com/files/package.json" target="_blank">package.json documentation</a>
|
||||
- <a href="https://docs.npmjs.com/misc/scripts#default-values" target="_blank">npm start script</a>
|
||||
|
||||
# Accessing a node.js app running a web server
|
||||
|
||||
This image exposes port `3000` in the container, so you should ensure that your web server is
|
||||
binding to port `3000`, as well as accepting remote connections.
|
||||
|
||||
Below is an example of an [express.js](http://expressjs.com/) app listening to remote connections on
|
||||
port `3000`:
|
||||
|
||||
```js
|
||||
var express = require('express');
|
||||
var app = express();
|
||||
|
||||
app.get('/', function (req, res) {
|
||||
res.send('Hello World!');
|
||||
});
|
||||
|
||||
var server = app.listen(3000, '0.0.0.0', function () {
|
||||
|
||||
var host = server.address().address;
|
||||
var port = server.address().port;
|
||||
|
||||
console.log('Example app listening at http://%s:%s', host, port);
|
||||
|
||||
});
|
||||
```
|
||||
|
||||
To access your web server from your host machine you can ask Docker to map a random port on your
|
||||
host to port `3000` inside the container.
|
||||
|
||||
```bash
|
||||
docker run -it --name node -P bitnami/node
|
||||
```
|
||||
|
||||
Run `docker port` to determine the random port Docker assigned.
|
||||
|
||||
```bash
|
||||
$ docker port node
|
||||
3000/tcp -> 0.0.0.0:32769
|
||||
```
|
||||
|
||||
You can also manually specify the port you want forwarded from your host to the container.
|
||||
|
||||
```bash
|
||||
docker run -it --name node -p 8080:3000 bitnami/node
|
||||
```
|
||||
|
||||
Access your web server in the browser by navigating to
|
||||
[http://localhost:8080](http://localhost:8080/).
|
||||
|
||||
# Linking
|
||||
|
||||
If you want to connect to your node.js web server inside another container, you can use the linking
|
||||
system provided by Docker.
|
||||
|
||||
## Serving your node.js app through an nginx frontend
|
||||
|
||||
We may want to make our node.js web server only accessible via an nginx web server. Doing so will
|
||||
allow us to setup more complex configuration, serve static assets using nginx, load balance to
|
||||
different node.js instances, etc.
|
||||
|
||||
### Step 1: Create a virtual host
|
||||
|
||||
Let's create an nginx virtual host to reverse proxy to our node.js container. <a
|
||||
href="https://github.com/bitnami/bitnami-docker-nginx" target="_blank">The Bitnami nginx Docker
|
||||
Image</a> ships with some example virtual hosts for connecting to Bitnami runtime images. We will
|
||||
make use of the node.js example:
|
||||
|
||||
```nginx
|
||||
server {
|
||||
listen 0.0.0.0:80;
|
||||
server_name yourapp.com;
|
||||
access_log /logs/yourapp_access.log;
|
||||
error_log /logs/yourapp_error.log;
|
||||
|
||||
location / {
|
||||
proxy_set_header X-Real-IP $remote_addr;
|
||||
proxy_set_header HOST $http_host;
|
||||
proxy_set_header X-NginX-Proxy true;
|
||||
|
||||
# proxy_pass http://[your_node_container_link_alias]:3000;
|
||||
proxy_pass http://yourapp:3000;
|
||||
proxy_redirect off;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Notice we've substituted the link alias name `yourapp`, we will use the same name when creating the
|
||||
link.
|
||||
|
||||
Copy the virtual host above, saving the file somewhere on your host. We will mount it as a volume
|
||||
in our nginx container.
|
||||
|
||||
### Step 2: Run the node.js image with a specific name
|
||||
|
||||
Docker's linking system uses container ids or names to reference containers. We can explicitly
|
||||
specify a name for our node.js server to make it easier to connect to other containers.
|
||||
|
||||
```
|
||||
docker run -it --name node -v /path/to/node/app:/app bitnami/node npm start
|
||||
```
|
||||
|
||||
or using Docker Compose:
|
||||
|
||||
```yaml
|
||||
node:
|
||||
image: bitnami/node
|
||||
command: npm start
|
||||
volumes:
|
||||
- path/to/node/app:/app
|
||||
```
|
||||
|
||||
### Step 3: Run the nginx image and link it to the node.js server
|
||||
|
||||
Now that we have our node.js server running, we can create another container that links to it by
|
||||
giving Docker the `--link` option. This option takes the id or name of the container we want to link
|
||||
it to as well as a hostname to use inside the container, separated by a colon. For example, to have
|
||||
our node.js server accessible in another container with `yourapp` as it's hostname we would pass
|
||||
`--link node:yourapp` to the Docker run command.
|
||||
|
||||
```bash
|
||||
docker run -it -v /path/to/vhost.conf:/bitnami/nginx/conf/vhosts/yourapp.conf \
|
||||
--link node:yourapp \
|
||||
bitnami/nginx
|
||||
```
|
||||
|
||||
or using Docker Compose:
|
||||
|
||||
```yaml
|
||||
nginx:
|
||||
image: bitnami/nginx
|
||||
links:
|
||||
- node:yourapp
|
||||
volumes:
|
||||
- path/to/vhost.conf:/bintami/nginx/conf/yourapp.conf
|
||||
```
|
||||
|
||||
We started the nginx server, mounting the virtual host we created in
|
||||
[Step 1](#step-1-create-a-virtual-host), and created a link to the node.js server with the alias
|
||||
`yourapp`.
|
||||
|
||||
# Maintenance
|
||||
|
||||
## Upgrade this image
|
||||
|
||||
Bitnami provides up-to-date versions of node.js, including security patches, soon after they are
|
||||
made upstream. We recommend that you follow these steps to upgrade your container.
|
||||
|
||||
### Step 1: Get the updated image
|
||||
|
||||
```bash
|
||||
docker pull bitnami/node:0.12.4-1
|
||||
```
|
||||
|
||||
or if you're using Docker Compose, update the value of the image property to
|
||||
`bitnami/node:0.12.4-1`.
|
||||
|
||||
### Step 2: Remove the currently running container
|
||||
|
||||
```bash
|
||||
docker rm -v node
|
||||
```
|
||||
|
||||
or using Docker Compose:
|
||||
|
||||
```bash
|
||||
docker-compose rm -v node
|
||||
```
|
||||
|
||||
### Step 3: Run the new image
|
||||
|
||||
Re-create your container from the new image.
|
||||
|
||||
```bash
|
||||
docker run --name node bitnami/node:0.12.4-1
|
||||
```
|
||||
|
||||
or using Docker Compose:
|
||||
|
||||
```bash
|
||||
docker-compose start node
|
||||
```
|
||||
|
||||
# Contributing
|
||||
|
||||
We'd love for you to contribute to this Docker image. You can request new features by creating an
|
||||
[issue](https://github.com/bitnami/bitnami-docker-node/issues), or submit a
|
||||
[pull request](https://github.com/bitnami/bitnami-docker-node/pulls) with your contribution.
|
||||
|
||||
# Issues
|
||||
|
||||
If you encountered a problem running this container, you can file an
|
||||
[issue](https://github.com/bitnami/bitnami-docker-node/issues). For us to provide better support,
|
||||
be sure to include the following information in your issue:
|
||||
|
||||
- Host OS and version
|
||||
- Docker version (`docker version`)
|
||||
- Output of `docker info`
|
||||
- Version of this container (`echo $BITNAMI_APP_VERSION` inside the container)
|
||||
- The command you used to run the container, and any relevant output you saw (masking any sensitive
|
||||
information)
|
||||
|
||||
# License
|
||||
|
||||
Reference in New Issue
Block a user