Hexy Templates

Woodpecker CI

Woodpecker CI is a simple, yet powerful CI/CD engine with great extensibility.

Not yet tested productivity Based on TrueNAS app v1.2.40 (Woodpecker CI v3.18.1)
Project website TrueNAS app source Script on GitHub Report a problem
  1. 1
    Copy the script below
  2. 2
    In HexOS, open Apps, find Woodpecker CI and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
woodpecker-ci.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS woodpecker-ci 1.2.40"
6  },
37  "installation_questions": [
8    {
9      "question": "Type",
10      "type": "select",
11      "key": "type",
12      "required": true,
13      "options": [
14        {"text": "GitHub", "value": "github"},
15        {"text": "Gitea", "value": "gitea"},
16        {"text": "Forgejo", "value": "forgejo"},
17        {"text": "Bitbucket", "value": "bitbucket"},
18        {"text": "GitLab", "value": "gitlab"}
19      ]
20    }
21  ],
22  "requirements": {
423    "locations": ["ApplicationsPerformance"],
524    "specifications": ["2CORE"],
625    "permissions": ["READ_WRITE_LOCATIONS"],
726    "ports": [30166, 30168]
27  },
828  "ensure_directories_exists": [
29    {"path": "$LOCATION(ApplicationsPerformance)"},
30    {"path": "$LOCATION(ApplicationsPerformance)/woodpecker-ci"},
31    {
32      "path": "$LOCATION(ApplicationsPerformance)/woodpecker-ci/agent_config",
33      "owner": {"user": "apps"},
34      "snapshot": {"id": "agent_config"}
35    },
36    {
37      "path": "$LOCATION(ApplicationsPerformance)/woodpecker-ci/postgres_data",
38      "owner": {"user": "netdata", "group": "docker"},
39      "snapshot": {"id": "postgres_data"}
40    }
41  ],
42  "app_values": {
43    "woodpecker": {
944      "db_password": "$RANDOM_STRING(16)",
1045      "external_url": "http://$SERVER_LAN_IP:30166",
1146      "agent_secret": "$RANDOM_STRING(32)",
1247      "forge": {"type": "$QUESTION(type)"}
48    },
49    "storage": {
1350      "agent_config": "$HOST_PATH($LOCATION(ApplicationsPerformance)/woodpecker-ci/agent_config)",
1451      "postgres_data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/woodpecker-ci/postgres_data)"
52    },
53    "network": {
1554      "http_port": {"bind_mode": "published", "port_number": 30166},
1655      "https_port": {"bind_mode": "published", "port_number": 30168}
56    },
1757    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
58  }
59}

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 woodpecker-ci 1.2.40”.

    Lines 3–6

  3. Questions you'll be asked

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

    Lines 7–21

  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 23

  5. Minimum hardware

    Recommended minimum: 2 CPU cores.

    Line 24

  6. Permission to use your folders

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

    Line 25

  7. Network ports

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

    Line 26

  8. Folders created on install

    Creates the folders the app needs before it starts: App storage (fast) › woodpecker-ci, App storage (fast) › woodpecker-ci › agent_config and App storage (fast) › woodpecker-ci › postgres_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 28–41

  9. Auto-generated db password

    HexOS makes up a long random db password during install. It's only used inside Woodpecker CI, so you never need to know it.

    Line 44

  10. Your server's address (external url)

    Automatically set to your server's address on your home network (http://your-server-ip:30166).

    Line 45

  11. Auto-generated agent secret

    HexOS makes up a long random agent secret during install. It's only used inside Woodpecker CI, so you never need to know it.

    Line 46

  12. Your answer: type

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

    Line 47

  13. Where the app's “agent config” files is saved

    Where the app's “agent config” files is saved on your server: App storage (fast) › woodpecker-ci › agent_config.

    Line 50

  14. Where the app's database is saved

    Where the app's database is saved on your server: App storage (fast) › woodpecker-ci › postgres_data.

    Line 51

  15. Http port: 30166

    The app's web page is published on port 30166. You don't need to remember it — clicking the app's card in HexOS takes you there.

    Line 54

  16. Https port: 30168

    Publishes the app's https port as 30168.

    Line 55

  17. 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 57