Hexy Templates

Shlink

The definitive self-hosted URL shortener

Not yet tested productivity Based on TrueNAS app v1.2.43 (Shlink 5.1.7)
Project website TrueNAS app source Script on GitHub Report a problem
  1. 1
    Copy the script below
  2. 2
    In HexOS, open Apps, find Shlink and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
shlink.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS shlink 1.2.43"
6  },
37  "installation_questions": [
8    {
9      "question": "Default domain",
10      "type": "text",
11      "key": "default_domain",
12      "required": true
13    }
14  ],
15  "requirements": {
416    "locations": ["ApplicationsPerformance"],
517    "specifications": ["2CORE"],
618    "permissions": ["READ_WRITE_LOCATIONS"],
719    "ports": [30227]
20  },
821  "ensure_directories_exists": [
22    {"path": "$LOCATION(ApplicationsPerformance)"},
23    {"path": "$LOCATION(ApplicationsPerformance)/shlink"},
24    {
25      "path": "$LOCATION(ApplicationsPerformance)/shlink/postgres_data",
26      "owner": {"user": "netdata", "group": "docker"},
27      "snapshot": {"id": "postgres_data"}
28    }
29  ],
30  "app_values": {
31    "shlink": {
932      "db_password": "$RANDOM_STRING(16)",
1033      "redis_password": "$RANDOM_STRING(16)",
1134      "default_domain": "$QUESTION(default_domain)"
35    },
36    "storage": {
1237      "postgres_data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/shlink/postgres_data)"
38    },
39    "network": {
1340      "api_port": {"bind_mode": "published", "port_number": 30227}
41    },
1442    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
43  }
44}

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 shlink 1.2.43”.

    Lines 3–6

  3. Questions you'll be asked

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

    Lines 7–14

  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 16

  5. Minimum hardware

    Recommended minimum: 2 CPU cores.

    Line 17

  6. Permission to use your folders

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

    Line 18

  7. Network ports

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

    Line 19

  8. Folders created on install

    Creates the folders the app needs before it starts: App storage (fast) › shlink and App storage (fast) › shlink › 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 21–29

  9. Auto-generated db password

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

    Line 32

  10. Auto-generated redis password

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

    Line 33

  11. Your answer: default domain

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

    Line 34

  12. Where the app's database is saved

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

    Line 37

  13. Api port: 30227

    Publishes the app's api port as 30227.

    Line 40

  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 42