Hexy Templates

Gramps Web

Gramps Web is a free, open-source genealogy system for building your family tree - together. Use it standalone or as a companion to Gramps Desktop, with full control over your data and privacy as the top priority.

Not yet tested management Based on TrueNAS app v1.4.6 (Gramps Web 26.9.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 Gramps Web and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
gramps-web.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS gramps-web 1.4.6"
6  },
7  "requirements": {
38    "locations": [
9      "ApplicationsPerformance",
10      "ApplicationsCapacity",
11      "Media"
12    ],
413    "specifications": ["2CORE"],
514    "permissions": ["READ_WRITE_LOCATIONS"],
615    "ports": [30179]
16  },
717  "ensure_directories_exists": [
18    {"path": "$LOCATION(ApplicationsPerformance)"},
19    {"path": "$LOCATION(ApplicationsPerformance)/gramps-web"},
20    {"path": "$LOCATION(ApplicationsCapacity)"},
21    {"path": "$LOCATION(ApplicationsCapacity)/gramps-web"},
22    {"path": "$LOCATION(Media)", "network_share": true},
23    {
24      "path": "$LOCATION(ApplicationsPerformance)/gramps-web/users",
25      "snapshot": {"id": "users"}
26    },
27    {
28      "path": "$LOCATION(ApplicationsPerformance)/gramps-web/index",
29      "snapshot": {"id": "index"}
30    },
31    {
32      "path": "$LOCATION(ApplicationsCapacity)/gramps-web/thumbnail_cache"
33    },
34    {"path": "$LOCATION(ApplicationsCapacity)/gramps-web/cache"},
35    {
36      "path": "$LOCATION(ApplicationsPerformance)/gramps-web/grampsdb",
37      "owner": {"user": "netdata", "group": "docker"},
38      "snapshot": {"id": "grampsdb"}
39    }
40  ],
41  "app_values": {
42    "gramps": {
843      "redis_password": "$RANDOM_STRING(16)",
944      "app_key": "$RANDOM_STRING(32)"
45    },
46    "storage": {
1047      "users": "$HOST_PATH($LOCATION(ApplicationsPerformance)/gramps-web/users)",
1148      "index": "$HOST_PATH($LOCATION(ApplicationsPerformance)/gramps-web/index)",
1249      "thumbnail_cache": "$HOST_PATH($LOCATION(ApplicationsCapacity)/gramps-web/thumbnail_cache)",
1350      "cache": "$HOST_PATH($LOCATION(ApplicationsCapacity)/gramps-web/cache)",
1451      "media": "$HOST_PATH($LOCATION(Media))",
1552      "grampsdb": "$HOST_PATH($LOCATION(ApplicationsPerformance)/gramps-web/grampsdb)"
53    },
54    "network": {
1655      "web_port": {"bind_mode": "published", "port_number": 30179}
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 gramps-web 1.4.6”.

    Lines 3–6

  3. Storage locations it needs

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

    Lines 8–12

  4. Minimum hardware

    Recommended minimum: 2 CPU cores.

    Line 13

  5. Permission to use your folders

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

    Line 14

  6. Network ports

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

    Line 15

  7. Folders created on install

    Creates the folders the app needs before it starts: App storage (fast) › gramps-web, App storage (large) › gramps-web, App storage (fast) › gramps-web › users, App storage (fast) › gramps-web › index, App storage (large) › gramps-web › thumbnail_cache, App storage (large) › gramps-web › cache and App storage (fast) › gramps-web › grampsdb. 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 17–40

  8. Auto-generated redis password

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

    Line 43

  9. Auto-generated app key

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

    Line 44

  10. Where the app's “users” files is saved

    Where the app's “users” files is saved on your server: App storage (fast) › gramps-web › users.

    Line 47

  11. Where the app's “index” files is saved

    Where the app's “index” files is saved on your server: App storage (fast) › gramps-web › index.

    Line 48

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

    Where the app's “thumbnail cache” files is saved on your server: App storage (large) › gramps-web › thumbnail_cache.

    Line 49

  13. Where temporary cache files is saved

    Where temporary cache files is saved on your server: App storage (large) › gramps-web › cache.

    Line 50

  14. Where your media is saved

    Where your media is saved on your server: Media.

    Line 51

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

    Where the app's “grampsdb” files is saved on your server: App storage (fast) › gramps-web › grampsdb.

    Line 52

  16. Web port: 30179

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

    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