Hardware Simulator Deployment Guide

This guide provides step-by-step instructions to deploy the Hardware Simulator application on a Debian server. Now available as an npm package, you can easily install and run the simulator using Node.js.

Table of Contents

1. Prepare the Debian Server
2. Install the Hardware Simulator Package
3. Add Systemd Service for Automatic Start
4. Configure Firewall
5. Configure Reverse Proxy (Optional)
6. Monitor Logs
7. Configuration of the Simulator

1. Prepare the Debian Server

Everything as root.

Install npm:

apt update
apt install npm -y

Verify Installation:

npm -v

2. Install the Hardware Simulator Package

Install the npm Package:

npm install -g hwsim

This will download the latest version of Hardware Simulator.

Test Locally:

Run the Hardware Simulator using the built-in npm script:

npm run start-hwsim

Ensure everything works as expected before proceeding.

Now you can run:

start-hwsim

3. Add Systemd Service for Automatic Start

Create a Systemd Service File:

nano /etc/systemd/system/hwsim.service

Add the Following Configuration:

[Unit]
Description=Hardware Simulator Application
After=network.target

[Service]
ExecStart=/usr/bin/node /usr/local/lib/node_modules/hwsim/index.js
WorkingDirectory=/usr/local/lib/node_modules/hwsim
Restart=always
Environment=PORT=80

[Install]
WantedBy=multi-user.target

Enable and Start the Service:

systemctl enable hwsim
systemctl start hwsim

Check Service Status:

systemctl status hwsim

4. Configure Firewall

If a firewall like UFW is enabled, allow access to port 80 (web) and 2101 (TCP server):

ufw allow 80/tcp
ufw allow 2101/tcp
ufw reload

5. Configure Reverse Proxy (Optional)

For better security and easier domain name usage, configure a reverse proxy using Nginx.

Install Nginx:

apt install nginx -y

Create a New Nginx Configuration:

nano /etc/nginx/sites-available/hwsim

Add the Following:

server {
    listen 80;
    server_name your-domain.com;

    location / {
        proxy_pass http://localhost:80;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection 'upgrade';
        proxy_set_header Host $host;
        proxy_cache_bypass $http_upgrade;
    }
}

Note: Replace your-domain.com with your actual domain name.

Enable the Configuration:

ln -s /etc/nginx/sites-available/hwsim /etc/nginx/sites-enabled/
nginx -t
systemctl restart nginx

6. Monitor Logs

Check Systemd Logs:

journalctl -u hwsim -f

7. Configuration

Access through a browser with the ip of the server, default on port 80. So just entering the ip is enough.