Hexy Templates

Piwigo

Piwigo is a photo gallery software for the web that comes with powerful features to publish and manage your collection of pictures.

Not yet tested media Based on TrueNAS app v1.4.11 (Piwigo 16.4.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 Piwigo and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
piwigo.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS piwigo 1.4.11"
6  },
37  "installation_questions": [
8    {
9      "question": "Admin name",
10      "type": "text",
11      "key": "admin_name",
12      "required": true
13    },
14    {
15      "question": "Admin password",
16      "type": "password",
17      "key": "admin_password",
18      "required": true
19    },
20    {
21      "question": "Admin email",
22      "type": "text",
23      "key": "admin_email",
24      "required": true
25    }
26  ],
27  "requirements": {
428    "locations": ["ApplicationsPerformance", "Media"],
529    "specifications": ["2CORE"],
630    "permissions": ["READ_WRITE_LOCATIONS"],
731    "ports": [30066]
32  },
833  "ensure_directories_exists": [
34    {"path": "$LOCATION(ApplicationsPerformance)"},
35    {"path": "$LOCATION(ApplicationsPerformance)/piwigo"},
36    {"path": "$LOCATION(Media)", "network_share": true},
37    {
38      "path": "$LOCATION(ApplicationsPerformance)/piwigo/config",
39      "snapshot": {"id": "config"}
40    },
41    {
42      "path": "$LOCATION(ApplicationsPerformance)/piwigo/gallery",
43      "snapshot": {"id": "gallery"}
44    },
45    {
46      "path": "$LOCATION(ApplicationsPerformance)/piwigo/mariadb_data",
47      "owner": {"user": "netdata", "group": "docker"},
48      "snapshot": {"id": "mariadb_data"}
49    }
50  ],
51  "app_values": {
52    "piwigo": {
953      "db_password": "$RANDOM_STRING(16)",
1054      "db_root_password": "$RANDOM_STRING(16)",
1155      "admin_name": "$QUESTION(admin_name)",
1256      "admin_password": "$QUESTION(admin_password)",
1357      "admin_email": "$QUESTION(admin_email)"
58    },
59    "storage": {
1460      "config": "$HOST_PATH($LOCATION(ApplicationsPerformance)/piwigo/config)",
1561      "gallery": "$HOST_PATH($LOCATION(ApplicationsPerformance)/piwigo/gallery)",
1662      "mariadb_data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/piwigo/mariadb_data)",
1763      "additional_storage": [
64        "$MOUNTED_HOST_PATH($LOCATION(Media), /media)"
65      ]
66    },
67    "network": {
1868      "web_port": {"bind_mode": "published", "port_number": 30066}
69    },
1970    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
71  }
72}

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 piwigo 1.4.11”.

    Lines 3–6

  3. Questions you'll be asked

    Before installing, HexOS will ask you for: Admin name, Admin password and Admin email. 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) and Media. 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. Network ports

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

    Line 31

  8. Folders created on install

    Creates the folders the app needs before it starts: App storage (fast) › piwigo, App storage (fast) › piwigo › config, App storage (fast) › piwigo › gallery and App storage (fast) › piwigo › mariadb_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 33–50

  9. Auto-generated db password

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

    Line 53

  10. Auto-generated db root password

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

    Line 54

  11. Your answer: admin name

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

    Line 55

  12. Your answer: admin password

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

    Line 56

  13. Your answer: admin email

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

    Line 57

  14. Where the app's settings is saved

    Where the app's settings is saved on your server: App storage (fast) › piwigo › config.

    Line 60

  15. Where the app's “gallery” files is saved

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

    Line 61

  16. Where the app's database is saved

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

    Line 62

  17. Your shared folders

    Gives the app access to your existing files: Media appears inside the app as /media.

    Lines 63–65

  18. Web port: 30066

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

    Line 68

  19. 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 70