Hexy Templates

Forgejo Runner

A runner for Forgejo.

Not yet tested productivity Based on TrueNAS app v2.0.24 (Forgejo Runner 13.2.0)
Project website TrueNAS app source Script on GitHub Report a problem
  1. 1
    Copy the script below
  2. 2
    In HexOS, open Apps, find Forgejo Runner and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
forgejo-runner.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS forgejo-runner 2.0.24"
6  },
37  "installation_questions": [
8    {
9      "question": "Instance url",
10      "type": "text",
11      "key": "instance_url",
12      "required": true
13    },
14    {
15      "question": "Runner uuid",
16      "type": "password",
17      "key": "runner_uuid",
18      "required": true
19    },
20    {
21      "question": "Runner registration token",
22      "type": "password",
23      "key": "runner_registration_token",
24      "required": true
25    }
26  ],
27  "requirements": {
428    "locations": ["ApplicationsPerformance"],
529    "specifications": ["2CORE"],
630    "permissions": ["READ_WRITE_LOCATIONS"]
31  },
732  "ensure_directories_exists": [
33    {"path": "$LOCATION(ApplicationsPerformance)"},
34    {"path": "$LOCATION(ApplicationsPerformance)/forgejo-runner"},
35    {
36      "path": "$LOCATION(ApplicationsPerformance)/forgejo-runner/data",
37      "owner": {"user": "apps"},
38      "snapshot": {"id": "data"}
39    }
40  ],
41  "app_values": {
42    "forgejo_runner": {
843      "instance_url": "$QUESTION(instance_url)",
944      "runner_uuid": "$QUESTION(runner_uuid)",
1045      "runner_registration_token": "$QUESTION(runner_registration_token)"
46    },
47    "storage": {
1148      "data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/forgejo-runner/data)"
49    },
1250    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
51  }
52}

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 forgejo-runner 2.0.24”.

    Lines 3–6

  3. Questions you'll be asked

    Before installing, HexOS will ask you for: Instance url, Runner uuid and Runner registration token. Your answers are slotted into the settings further down wherever you see $QUESTION(...).

    Lines 7–26

  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 28

  5. Minimum hardware

    Recommended minimum: 2 CPU cores.

    Line 29

  6. Permission to use your folders

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

    Line 30

  7. Folders created on install

    Creates the folders the app needs before it starts: App storage (fast) › forgejo-runner and App storage (fast) › forgejo-runner › data. Some folders are handed to a specific system user so the app is allowed to write to them. Folders marked “snapshot” are included in HexOS snapshots, so you can roll them back.

    Lines 32–40

  8. Your answer: instance url

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

    Line 43

  9. Your answer: runner uuid

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

    Line 44

  10. Your answer: runner registration token

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

    Line 45

  11. Where the app's main data is saved

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

    Line 48

  12. 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 50