Hexy Templates

Factorio Server

Factorio headless server in a Docker container

Not yet tested games Based on TrueNAS app v1.1.10 (Factorio Server stable-2.0.77)
Project website TrueNAS app source Script on GitHub Report a problem
  1. 1
    Copy the script below
  2. 2
    In HexOS, open Apps, find Factorio Server and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
factorio.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS factorio 1.1.10"
6  },
37  "installation_questions": [
8    {
9      "question": "Username",
10      "type": "text",
11      "key": "username",
12      "required": true
13    },
14    {
15      "question": "Token",
16      "type": "password",
17      "key": "token",
18      "required": true
19    }
20  ],
21  "requirements": {
422    "locations": ["ApplicationsPerformance"],
523    "specifications": ["2CORE"],
624    "permissions": ["READ_WRITE_LOCATIONS"],
725    "ports": [34197, 27015]
26  },
827  "ensure_directories_exists": [
28    {"path": "$LOCATION(ApplicationsPerformance)"},
29    {"path": "$LOCATION(ApplicationsPerformance)/factorio"},
30    {
31      "path": "$LOCATION(ApplicationsPerformance)/factorio/data",
32      "snapshot": {"id": "data"}
33    }
34  ],
35  "app_values": {
36    "factorio": {
937      "username": "$QUESTION(username)",
1038      "token": "$QUESTION(token)"
39    },
40    "storage": {
1141      "data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/factorio/data)"
42    },
43    "network": {
1244      "game_port": {"bind_mode": "published", "port_number": 34197},
1345      "rcon_port": {"bind_mode": "published", "port_number": 27015}
46    },
1447    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
48  }
49}

What this script does

Hover or tap a box to see the lines it explains.

  1. Script format

    Tells HexOS this is a version 5 install script, so it knows how to read the rest.

    Line 2

  2. Script revision

    This copy of the script is revision 0.1.0. Latest change: “Auto-generated draft from TrueNAS factorio 1.1.10”.

    Lines 3–6

  3. Questions you'll be asked

    Before installing, HexOS will ask you for: Username and Token. Your answers are slotted into the settings further down wherever you see $QUESTION(...).

    Lines 7–20

  4. Storage locations it needs

    The app uses these HexOS storage locations: App storage (fast). If one isn't set up yet, HexOS will ask you to pick a place for it.

    Line 22

  5. Minimum hardware

    Recommended minimum: 2 CPU cores.

    Line 23

  6. Permission to use your folders

    Allows the app to read and write files inside the storage locations listed above — and nowhere else.

    Line 24

  7. Network ports

    The app needs ports 34197 and 27015 to be free on your server. A port is like an apartment number for your server's address.

    Line 25

  8. Folders created on install

    Creates the folders the app needs before it starts: App storage (fast) › factorio and App storage (fast) › factorio › data. Folders marked “snapshot” are included in HexOS snapshots, so you can roll them back.

    Lines 27–34

  9. Your answer: username

    Filled in with what you typed for “username” when you installed.

    Line 37

  10. Your answer: token

    Filled in with what you typed for “token” when you installed.

    Line 38

  11. Where the app's main data is saved

    Where the app's main data is saved on your server: App storage (fast) › factorio › data.

    Line 41

  12. Game port: 34197

    Publishes the app's game port as 34197.

    Line 44

  13. Rcon port: 27015

    Publishes the app's rcon port as 27015.

    Line 45

  14. Resource limits

    Caps how much of your server the app can use: 2 CPU cores and 10% of your server's memory, but never more than 4 GB. This keeps one busy app from slowing everything else down.

    Line 47