Hexy Templates

Penpot

Penpot - The open-source design tool for design and code collaboration

Not yet tested productivity Based on TrueNAS app v1.5.48 (Penpot 2.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 Penpot and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
penpot.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS penpot 1.5.48"
6  },
37  "installation_questions": [
8    {
9      "question": "Public uri",
10      "type": "text",
11      "key": "public_uri",
12      "required": true
13    }
14  ],
15  "requirements": {
416    "locations": ["ApplicationsPerformance"],
517    "specifications": ["2CORE"],
618    "permissions": ["READ_WRITE_LOCATIONS"],
719    "ports": [31027]
20  },
821  "ensure_directories_exists": [
22    {"path": "$LOCATION(ApplicationsPerformance)"},
23    {"path": "$LOCATION(ApplicationsPerformance)/penpot"},
24    {
25      "path": "$LOCATION(ApplicationsPerformance)/penpot/assets",
26      "snapshot": {"id": "assets"}
27    },
28    {
29      "path": "$LOCATION(ApplicationsPerformance)/penpot/postgres_data",
30      "owner": {"user": "netdata", "group": "docker"},
31      "snapshot": {"id": "postgres_data"}
32    }
33  ],
34  "app_values": {
35    "penpot": {
936      "public_uri": "$QUESTION(public_uri)",
1037      "db_password": "$RANDOM_STRING(16)",
1138      "redis_password": "$RANDOM_STRING(16)"
39    },
40    "storage": {
1241      "assets": "$HOST_PATH($LOCATION(ApplicationsPerformance)/penpot/assets)",
1342      "postgres_data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/penpot/postgres_data)"
43    },
44    "network": {
1445      "web_port": {"bind_mode": "published", "port_number": 31027}
46    },
1547    "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 penpot 1.5.48”.

    Lines 3–6

  3. Questions you'll be asked

    Before installing, HexOS will ask you for: Public uri. 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 31027 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) › penpot, App storage (fast) › penpot › assets and App storage (fast) › penpot › 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–33

  9. Your answer: public uri

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

    Line 36

  10. Auto-generated db password

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

    Line 37

  11. Auto-generated redis password

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

    Line 38

  12. Where the app's “assets” files is saved

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

    Line 41

  13. Where the app's database is saved

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

    Line 42

  14. Web port: 31027

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

    Line 45

  15. 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