From 14d736c97e9228c26209391e19470599034471c9 Mon Sep 17 00:00:00 2001 From: Paul Jenkins Date: Fri, 20 Mar 2026 16:08:20 +0000 Subject: [PATCH] Update README to clarify server start instructions for Digital Ocean deployment Removed instructions for starting the server and updated environment variable section. --- README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 1822cab..86e4505 100644 --- a/README.md +++ b/README.md @@ -92,14 +92,14 @@ npm install ``` cp .env.example .env -PORT=3000 + +# --------- example contents --------- +# UDP_PORT=33333 +# HTTP_PORT=3333 +# ------------------------------------ ``` -## Running the Server - -To start the UDP server, use the following command: - -``` -npm start -``` -This will run the server and bind it to the port specified in your .env file. +## Digital Ocean Deployment details +1. The Node server is installed to `/opt/netstar-categorizer` +2. Rather than using `npm start` (which doesn't restart after a crash) the we use **[PM2](https://pm2.keymetrics.io/)**, which provides a more robust runtime +3. The full command to start the server using pm2 is `pm2 start npm --name "netstar-categorizer" --cwd /opt/netstar-categorizer/ -- start` - for convenience, there's a `run-me.sh` script in `/root` that will execute this command.