isaach/netstar-categorizer
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README to clarify server start instructions for Digital Ocean deployment

Browse Source 
Removed instructions for starting the server and updated environment variable section.
This commit is contained in:
Paul Jenkins
2026-03-20 16:08:20 +00:00
committed by GitHub
parent e630ca4868
commit 14d736c97e
1 changed files with 9 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@@ -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.