Hexy Templates

AdventureLog

Self-hostable travel tracker and trip planner.

Not yet tested productivity Based on TrueNAS app v1.3.30 (AdventureLog v0.13.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 AdventureLog and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
adventurelog.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS adventurelog 1.3.30"
6  },
37  "installation_questions": [
8    {
9      "question": "Admin username",
10      "type": "text",
11      "key": "admin_username",
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      "question": "Backend url",
28      "type": "text",
29      "key": "backend_url",
30      "required": true
31    }
32  ],
33  "requirements": {
434    "locations": ["Media", "ApplicationsPerformance"],
535    "specifications": ["2CORE"],
636    "permissions": ["READ_WRITE_LOCATIONS"],
737    "ports": [30250, 30251]
38  },
839  "ensure_directories_exists": [
40    {"path": "$LOCATION(Media)", "network_share": true},
41    {"path": "$LOCATION(ApplicationsPerformance)"},
42    {"path": "$LOCATION(ApplicationsPerformance)/adventurelog"},
43    {
44      "path": "$LOCATION(ApplicationsPerformance)/adventurelog/postgres_data",
45      "owner": {"user": "netdata", "group": "docker"},
46      "snapshot": {"id": "postgres_data"}
47    }
48  ],
49  "app_values": {
50    "adventurelog": {
951      "db_password": "$RANDOM_STRING(16)",
1052      "secret_key": "$RANDOM_STRING(32)",
1153      "admin_username": "$QUESTION(admin_username)",
1254      "admin_password": "$QUESTION(admin_password)",
1355      "admin_email": "$QUESTION(admin_email)",
1456      "frontend_url": "http://$SERVER_LAN_IP:30250",
1557      "backend_url": "$QUESTION(backend_url)"
58    },
59    "storage": {
1660      "media": "$HOST_PATH($LOCATION(Media))",
1761      "postgres_data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/adventurelog/postgres_data)"
62    },
63    "network": {
1864      "backend_port": {"bind_mode": "published", "port_number": 30250},
1965      "frontend_port": {"bind_mode": "published", "port_number": 30251}
66    },
2067    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
68  }
69}

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 adventurelog 1.3.30”.

    Lines 3–6

  3. Questions you'll be asked

    Before installing, HexOS will ask you for: Admin username, Admin password, Admin email and Backend url. Your answers are slotted into the settings further down wherever you see $QUESTION(...).

    Lines 7–32

  4. Storage locations it needs

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

    Line 34

  5. Minimum hardware

    Recommended minimum: 2 CPU cores.

    Line 35

  6. Permission to use your folders

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

    Line 36

  7. Network ports

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

    Line 37

  8. Folders created on install

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

  9. Auto-generated db password

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

    Line 51

  10. Auto-generated secret key

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

    Line 52

  11. Your answer: admin username

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

    Line 53

  12. Your answer: admin password

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

    Line 54

  13. Your answer: admin email

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

    Line 55

  14. Your server's address (frontend url)

    Automatically set to your server's address on your home network (http://your-server-ip:30250).

    Line 56

  15. Your answer: backend url

    Filled in with what you typed for “backend url” when you installed.

    Line 57

  16. Where your media is saved

    Where your media is saved on your server: Media.

    Line 60

  17. Where the app's database is saved

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

    Line 61

  18. Backend port: 30250

    Publishes the app's backend port as 30250.

    Line 64

  19. Frontend port: 30251

    Publishes the app's frontend port as 30251.

    Line 65

  20. 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 67