https://github.com/cinderblock/factorio-stats
A Simple Factorio Server Status Webpage
https://github.com/cinderblock/factorio-stats
Last synced: 2 months ago
JSON representation
A Simple Factorio Server Status Webpage
- Host: GitHub
- URL: https://github.com/cinderblock/factorio-stats
- Owner: cinderblock
- Created: 2024-11-13T06:50:48.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-11-30T00:42:08.000Z (over 1 year ago)
- Last Synced: 2025-03-22T22:36:39.251Z (about 1 year ago)
- Language: TypeScript
- Size: 84.5 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# A Simple Factorio Server Status Webpage
This is a simple webpage that displays the status of a Factorio server.
It uses the Factorio server's RCON interface to get the server status and exposes it over an HTTP interface.
You must serve the compiled version of the ui folder with a web server.
The backend server must be started and configured with the correct RCON settings.
## Setup
```bash
git clone https://github.com/cinderblock/factorio-stats.git
cd factorio-stats
npm install
# Serve the contents of the ui/dist folder with a web server
cp backend/.env.example backend/.env
# Edit backend/.env to match your server's RCON settings
npm start
```
### Example Nginx Config
```nginx
server {
listen 80;
server_name factorio.example.com;
root /path/to/factorio-stats/ui/dist;
location / {
try_files $uri $uri/ /index.html @backend;
}
location @backend {
proxy_pass http://localhost:3000; # Change this to the port the backend server is running on
proxy_set_header Host factorio.example.com;
proxy_set_header X-Real-IP $remote_addr;
}
}
```
## Update
```bash
npm run update
```
### Update and Run
```bash
npm run update && npm start
```