https://github.com/lovethebomb/factorio-status
🛢 The mini server status.
https://github.com/lovethebomb/factorio-status
dockerfile express factorio javascript pugjs rcon status typescript
Last synced: about 2 months ago
JSON representation
🛢 The mini server status.
- Host: GitHub
- URL: https://github.com/lovethebomb/factorio-status
- Owner: lovethebomb
- Created: 2018-06-09T21:37:18.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-24T03:50:19.000Z (about 2 years ago)
- Last Synced: 2023-03-30T16:22:22.591Z (about 2 years ago)
- Topics: dockerfile, express, factorio, javascript, pugjs, rcon, status, typescript
- Language: TypeScript
- Homepage: https://factorio.ilot.sh
- Size: 1.21 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# factorio-status
[](https://travis-ci.com/lovethebomb/factorio-status)
The mini server status for the [Factorio](https://www.factorio.com) server [factorio.ilot.sh](https://factorio.ilot.sh), based on [rcon-ts](https://github.com/electricessence/rcon-ts).
## Usage
```bash
git clone [email protected]:lovethebomb/factorio-status.git
```
Create a `.env` file with `KEY=value` as decribed:
```bash
RCON_HOST="your-server-hostname" | default factorio.domain.tld
RCON_PORT=your-server-port | default 27015
RCON_PASSWORD=your-server-port
RCON_TIMEOUT=your-server-timeout | default 5000
```
## Development
```bash
npm run dev
```
## Testing
```bash
npm run test
```
## Production
A [Dockerfile](Dockerfile) is provided.
The build-and-run step is:
```bash
npm run build && npm run start
```
You can provide the `.env` file through a Docker volume and override the port `envvar` if needed.
```bash
docker run -v -e "PORT=3000" /path/to/.env:/app/.env factorio-status
```