Set up a Node.js app for a website with Apache on Ubuntu 16.04
Execution of Node.js scripts as a service
Although open source JavaScript Node.js scripts can be run from the command line using screen, running the scripts as a service using the process manager PM2 gives the scripts a more robust set of behaviors. When run as a service this way, the scripts will automatically restart if the server is rebooted or the script crashes.
PM2 is a process manager for Node.js, with a wide range of features you can use to control and manage your Node.js scripts. Visit the official PM2 website for more information on using PM2.
Requirements
- A Cloud Server running Linux (Ubuntu 16.04).
- A working domain name which links to the server.
- A functional Apache web server installed and running.
Free Cloud Server Trial from IONOS
Try out a Cloud Server for free now - test your IONOS Cloud Server for 30 days!
Install Node.js
Update your server’s packages and install curl with the following commands:
sudo apt-get update
sudo apt-get install curl
Download the Node.js personal package archive (PPA). This contains a more recent Node.js version than the Ubuntu repositories:
curl -sL https://deb.nodesource.com/setup_6.x -o nodesource_setup.sh
Run the nodesource_setup.sh command to add the PPA to your server’s package cache:
sudo bash nodesource_setup.sh
This script will update the server automatically. There is no need to run apt-get update a second time.
Afterwards, install Node.js:
sudo apt-get install nodejs
This will automatically install npm as well.
Finally, install the build-essential package for npm:
sudo apt-get install build-essential
Create a sample Node.js application
For this example, we will begin by creating a separate directory in your website’s document root for housing Node.js applications:
sudo mkdir /var/www/html/nodejs
Create the file hello.js in this directory:
sudo nano /var/www/html/nodejs/hello.js
Add the following example content to the file:
#!/usr/bin/env nodejs
var http = require('http');
http.createServer(function (request, response) {
response.writeHead(200, {'Content-Type': 'text/plain'});
response.end('Hello World! Node.js is working correctly.\n');
}).listen(8080);
console.log('Server running at http://127.0.0.1:8080/');
Save and exit the file and make the file executable:
sudo chmod 755 hello.js
Install PM2
Use npm to install PM2 with the command:
sudo npm install -g pm2
Start the hello.js example script that you’ve just created with the command:
sudo pm2 start hello.js
As root add PM2 to the startup scripts, so that it will automatically restart if the server is rebooted:
sudo pm2 startup systemd
Cloud backup from IONOS
Make costly downtime a thing of the past and back up your business the easy way!
Configure Apache
To access the Node.js script from the web, install the Apache modules proxy and proxy_http with the commands:
sudo a2enmod proxy
sudo a2enmod proxy_http
Once the installation is complete, restart Apache for the changes to take effect:
sudo service apache2 restartNext, you will need to adjust the Apache proxy configurations. The following directives need to be inserted into the VirtualHost command block in the site’s main Apache configuration file.
By common convention, this Apache configuration file is usually /etc/apache2/sites-available/example.com.conf on Ubuntu.
The location and filename of a site’s Apache configuration file can vary.
Edit this file with your editor of choice, for example with the command:
sudo nano /etc/apache2/sites-available/example.com.conf
Scroll through the file until you find the VirtualHost command block, which will look like:
<VirtualHost *:80>
ServerName example.com
<Directory "/var/www/example.com/html">
AllowOverride All
</Directory>
</VirtualHost>
Add the following to VirtualHost command block:
ProxyRequests Off
ProxyPreserveHost On
ProxyVia Full
<Proxy *>
Require all granted
</Proxy>
<Location /nodejs>
ProxyPass http://127.0.0.1:8080
ProxyPassReverse http://127.0.0.1:8080
</Location>Be sure to put these lines outside any Directory command blocks. For example:
<VirtualHost *:80>
ServerName example.com
ProxyRequests Off
ProxyPreserveHost On
ProxyVia Full
<Proxy *>
Require all granted
</Proxy>
<Location /nodejs>
ProxyPass http://127.0.0.1:8080
ProxyPassReverse http://127.0.0.1:8080
</Location>
<Directory "/var/www/example.com/html">
AllowOverride All
</Directory>
</VirtualHost>
Save and exit the file, then restart Apache for the changes to take effect:
sudo services apache2 restart`
After restarting Apache, you can test the application by viewing it in a browser. You should see the following message from the test file you created earlier:
Hello World! Node.js is working correctly.
Related articles
Node.js: the JavaScript runtime environment at a glance
With the software platform, Node.js, you can use JavaScript server-side and benefit from the asynchronous, event-based programming and the range of options for developing server applications. In this Node.js tutorial, we give you an overview of the program’s modular structure, explain how you can install program modules at any time using the integrated package manager, NPM, and use them to set up…
Setting Up a Docker Repository
Learn how to store your Docker images, either with a self-hosted local registry, or using a Docker Hub repository.
Installing and running Docker on a Linux server
Learn how to install Docker, start the service, set it to start on boot, and learn how to work with Docker containers and images. In this article we will cover basic Docker commands and information.
How to create Docker images
Once you have learned the basics of working with Docker, the next step is to learn how to create and save your own images. There are two ways to create a Docker image: manually using the `docker commit` command, or automatically using a Dockerfile.
Understanding and managing Docker container volumes
Software for managing containers makes working with Linux containers significantly easier. You can not only transfer files between containers but also save files from containers. This article shows you how you can effectively manage containers using Docker container volumes, including extensive Docker volumes examples.
How to install Apache on Ubuntu
The Apache web server is a popular choice for web hosting thanks to its powerful modules and its open-source code. In this step by step guide we explain how to install and set up Apache on Ubuntu. You will also find out what packages you need and how to change your settings as appropriate. Simply read on to find out more.
