Coolify

An open-source & self-hostable Heroku / Netlify / Vercel alternative.

Not yet tested productivity Based on TrueNAS app v1.2.67 (Coolify 4.3.23)

Project website TrueNAS app source Script on GitHub Report a problem

1
Copy the script below
2
In HexOS, open Apps, find Coolify and choose Custom Install
3
Paste, then press Install — full guide with screenshots

coolify.json

Download

1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS coolify 1.2.67"
6  },
37  "installation_questions": [
8    {
9      "question": "App id",
10      "type": "password",
11      "key": "app_id",
12      "required": true
13    },
14    {
15      "question": "Pusher app id",
16      "type": "password",
17      "key": "pusher_app_id",
18      "required": true
19    }
20  ],
21  "requirements": {
422    "locations": ["ApplicationsPerformance", "ApplicationsCapacity"],
523    "specifications": ["2CORE"],
624    "permissions": ["READ_WRITE_LOCATIONS"],
725    "ports": [30275, 30276, 30277]
26  },
827  "ensure_directories_exists": [
28    {"path": "$LOCATION(ApplicationsPerformance)"},
29    {"path": "$LOCATION(ApplicationsPerformance)/coolify"},
30    {"path": "$LOCATION(ApplicationsCapacity)"},
31    {"path": "$LOCATION(ApplicationsCapacity)/coolify"},
32    {
33      "path": "$LOCATION(ApplicationsPerformance)/coolify/ssh_keys",
34      "snapshot": {"id": "ssh_keys"}
35    },
36    {
37      "path": "$LOCATION(ApplicationsPerformance)/coolify/applications",
38      "snapshot": {"id": "applications"}
39    },
40    {
41      "path": "$LOCATION(ApplicationsPerformance)/coolify/databases",
42      "owner": {"user": "netdata", "group": "docker"},
43      "snapshot": {"id": "databases"}
44    },
45    {
46      "path": "$LOCATION(ApplicationsPerformance)/coolify/services",
47      "snapshot": {"id": "services"}
48    },
49    {"path": "$LOCATION(ApplicationsCapacity)/coolify/backups"},
50    {
51      "path": "$LOCATION(ApplicationsPerformance)/coolify/webhooks_maintenance",
52      "snapshot": {"id": "webhooks_maintenance"}
53    },
54    {
55      "path": "$LOCATION(ApplicationsPerformance)/coolify/postgres_data",
56      "owner": {"user": "netdata", "group": "docker"},
57      "snapshot": {"id": "postgres_data"}
58    }
59  ],
60  "app_values": {
61    "coolify": {
962      "db_password": "$RANDOM_STRING(16)",
1063      "redis_password": "$RANDOM_STRING(16)",
1164      "app_id": "$QUESTION(app_id)",
1265      "app_key": "$RANDOM_STRING(32)",
1366      "pusher_app_id": "$QUESTION(pusher_app_id)",
1467      "pusher_app_key": "$RANDOM_STRING(32)",
1568      "pusher_app_secret": "$RANDOM_STRING(32)"
69    },
70    "storage": {
1671      "ssh_keys": "$HOST_PATH($LOCATION(ApplicationsPerformance)/coolify/ssh_keys)",
1772      "applications": "$HOST_PATH($LOCATION(ApplicationsPerformance)/coolify/applications)",
1873      "databases": "$HOST_PATH($LOCATION(ApplicationsPerformance)/coolify/databases)",
1974      "services": "$HOST_PATH($LOCATION(ApplicationsPerformance)/coolify/services)",
2075      "backups": "$HOST_PATH($LOCATION(ApplicationsCapacity)/coolify/backups)",
2176      "webhooks_maintenance": "$HOST_PATH($LOCATION(ApplicationsPerformance)/coolify/webhooks_maintenance)",
2277      "postgres_data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/coolify/postgres_data)"
78    },
79    "network": {
2380      "web_port": {"bind_mode": "published", "port_number": 30275},
2481      "realtime_backend_port": {
82        "bind_mode": "published",
83        "port_number": 30276
84      },
2585      "realtime_websocket_port": {
86        "bind_mode": "published",
87        "port_number": 30277
88      }
89    },
2690    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
91  }
92}

{
  "version": 5,
  "script": {
    "version": "0.1.0",
    "changeLog": "Auto-generated draft from TrueNAS coolify 1.2.67"
  },
  "installation_questions": [
    {
      "question": "App id",
      "type": "password",
      "key": "app_id",
      "required": true
    },
    {
      "question": "Pusher app id",
      "type": "password",
      "key": "pusher_app_id",
      "required": true
    }
  ],
  "requirements": {
    "locations": ["ApplicationsPerformance", "ApplicationsCapacity"],
    "specifications": ["2CORE"],
    "permissions": ["READ_WRITE_LOCATIONS"],
    "ports": [30275, 30276, 30277]
  },
  "ensure_directories_exists": [
    {"path": "$LOCATION(ApplicationsPerformance)"},
    {"path": "$LOCATION(ApplicationsPerformance)/coolify"},
    {"path": "$LOCATION(ApplicationsCapacity)"},
    {"path": "$LOCATION(ApplicationsCapacity)/coolify"},
    {
      "path": "$LOCATION(ApplicationsPerformance)/coolify/ssh_keys",
      "snapshot": {"id": "ssh_keys"}
    },
    {
      "path": "$LOCATION(ApplicationsPerformance)/coolify/applications",
      "snapshot": {"id": "applications"}
    },
    {
      "path": "$LOCATION(ApplicationsPerformance)/coolify/databases",
      "owner": {"user": "netdata", "group": "docker"},
      "snapshot": {"id": "databases"}
    },
    {
      "path": "$LOCATION(ApplicationsPerformance)/coolify/services",
      "snapshot": {"id": "services"}
    },
    {"path": "$LOCATION(ApplicationsCapacity)/coolify/backups"},
    {
      "path": "$LOCATION(ApplicationsPerformance)/coolify/webhooks_maintenance",
      "snapshot": {"id": "webhooks_maintenance"}
    },
    {
      "path": "$LOCATION(ApplicationsPerformance)/coolify/postgres_data",
      "owner": {"user": "netdata", "group": "docker"},
      "snapshot": {"id": "postgres_data"}
    }
  ],
  "app_values": {
    "coolify": {
      "db_password": "$RANDOM_STRING(16)",
      "redis_password": "$RANDOM_STRING(16)",
      "app_id": "$QUESTION(app_id)",
      "app_key": "$RANDOM_STRING(32)",
      "pusher_app_id": "$QUESTION(pusher_app_id)",
      "pusher_app_key": "$RANDOM_STRING(32)",
      "pusher_app_secret": "$RANDOM_STRING(32)"
    },
    "storage": {
      "ssh_keys": "$HOST_PATH($LOCATION(ApplicationsPerformance)/coolify/ssh_keys)",
      "applications": "$HOST_PATH($LOCATION(ApplicationsPerformance)/coolify/applications)",
      "databases": "$HOST_PATH($LOCATION(ApplicationsPerformance)/coolify/databases)",
      "services": "$HOST_PATH($LOCATION(ApplicationsPerformance)/coolify/services)",
      "backups": "$HOST_PATH($LOCATION(ApplicationsCapacity)/coolify/backups)",
      "webhooks_maintenance": "$HOST_PATH($LOCATION(ApplicationsPerformance)/coolify/webhooks_maintenance)",
      "postgres_data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/coolify/postgres_data)"
    },
    "network": {
      "web_port": {"bind_mode": "published", "port_number": 30275},
      "realtime_backend_port": {
        "bind_mode": "published",
        "port_number": 30276
      },
      "realtime_websocket_port": {
        "bind_mode": "published",
        "port_number": 30277
      }
    },
    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
  }
}

What this script does

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

Script format

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

Line 2
Script revision

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

Lines 3–6
Questions you'll be asked

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

Lines 7–20
Storage locations it needs

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

Line 22
Minimum hardware

Recommended minimum: 2 CPU cores.

Line 23
Permission to use your folders

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

Line 24
Network ports

The app needs ports 30275, 30276 and 30277 to be free on your server. A port is like an apartment number for your server's address.

Line 25
Folders created on install

Creates the folders the app needs before it starts: App storage (fast) › coolify, App storage (large) › coolify, App storage (fast) › coolify › ssh_keys, App storage (fast) › coolify › applications, App storage (fast) › coolify › databases, App storage (fast) › coolify › services, App storage (large) › coolify › backups, App storage (fast) › coolify › webhooks_maintenance and App storage (fast) › coolify › 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 27–59
Auto-generated db password

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

Line 62
Auto-generated redis password

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

Line 63
Your answer: app id

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

Line 64
Auto-generated app key

HexOS makes up a long random app key during install. It's only used inside Coolify, so you never need to know it.

Line 65
Your answer: pusher app id

Filled in with what you typed for “pusher app id” when you installed.

Line 66
Auto-generated pusher app key

HexOS makes up a long random pusher app key during install. It's only used inside Coolify, so you never need to know it.

Line 67
Auto-generated pusher app secret

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

Line 68
Where the app's “ssh keys” files is saved

Where the app's “ssh keys” files is saved on your server: App storage (fast) › coolify › ssh_keys.

Line 71
Where the app's “applications” files is saved

Where the app's “applications” files is saved on your server: App storage (fast) › coolify › applications.

Line 72
Where the app's “databases” files is saved

Where the app's “databases” files is saved on your server: App storage (fast) › coolify › databases.

Line 73
Where the app's “services” files is saved

Where the app's “services” files is saved on your server: App storage (fast) › coolify › services.

Line 74
Where backups the app makes is saved

Where backups the app makes is saved on your server: App storage (large) › coolify › backups.

Line 75
Where the app's “webhooks maintenance” files is saved

Where the app's “webhooks maintenance” files is saved on your server: App storage (fast) › coolify › webhooks_maintenance.

Line 76
Where the app's database is saved

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

Line 77
Web port: 30275

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

Line 80
Realtime backend port: 30276

Publishes the app's realtime backend port as 30276.

Lines 81–84
Realtime websocket port: 30277

Publishes the app's realtime websocket port as 30277.

Lines 85–88
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 90

What this script does

Script format

Script revision

Questions you'll be asked

Storage locations it needs

Minimum hardware

Permission to use your folders

Network ports

Folders created on install

Auto-generated db password

Auto-generated redis password

Your answer: app id

Auto-generated app key

Your answer: pusher app id

Auto-generated pusher app key

Auto-generated pusher app secret

Where the app's “ssh keys” files is saved

Where the app's “applications” files is saved

Where the app's “databases” files is saved

Where the app's “services” files is saved

Where backups the app makes is saved

Where the app's “webhooks maintenance” files is saved

Where the app's database is saved

Web port: 30275

Realtime backend port: 30276

Realtime websocket port: 30277

Resource limits