https://github.com/fboulnois/factorio-up
An all-in-one executable to automatically update and run a Factorio server
https://github.com/fboulnois/factorio-up
dedicated-server docker factorio factorio-server headless
Last synced: about 1 month ago
JSON representation
An all-in-one executable to automatically update and run a Factorio server
- Host: GitHub
- URL: https://github.com/fboulnois/factorio-up
- Owner: fboulnois
- License: mpl-2.0
- Created: 2025-08-24T19:30:00.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2025-08-24T19:31:46.000Z (about 1 month ago)
- Last Synced: 2025-08-24T23:06:17.844Z (about 1 month ago)
- Topics: dedicated-server, docker, factorio, factorio-server, headless
- Language: Rust
- Homepage:
- Size: 20.5 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# factorio-up
A single executable to download and run the latest stable version of Factorio headless server, optimized for containers.
## Features
- Downloads the latest stable version of Factorio headless server and verifies the checksum
- Extracts the downloaded archive into a new directory
- (optional) Initializes a map with custom settings
- (optional) Symlinks the binary file and data directory
- (optional) Runs the command as a specific user
- (optional) Runs the Factorio binary with custom settings
## Usage
Options are specified as command line arguments. The basic usage is:
```sh
factorio-up [OPTIONS] ...
```
Running the command without any options will download the latest stable version of Factorio headless server and extract it into a new directory.
### Options
| Option | Description |
| ------ | ----------- |
| `--init-map ` | Initialize the map settings [default: false] |
| `--save-file ` | File path to the save .zip [default: server-default.zip] |
| `--map-gen-settings ` | File path to the map generator settings [default: map-gen-settings.json] |
| `--map-settings ` | File path to the map settings [default: map-settings.json] |
| `--exe-path ` | File path to symlink the downloaded server binary |
| `--data-dir ` | Directory to symlink the downloaded server data |
| `--user ` | Run the command as this user |
Additional trailing options will be treated as a command with arguments to execute. For example, `factorio-up --user $USER echo hello world` will run the command `echo hello world` as the current user after downloading and extracting the Factorio server. This is useful for running Factorio or other scripts or commands after an update.
## Build
```sh
docker build . --tag factorio-up
```
## Deploy
See the [Dockerfile](https://github.com/fboulnois/factorio-docker/blob/main/Dockerfile) for a minimal example on how to deploy the executable in a container.