Hexy Templates

ViTransfer

ViTransfer - Professional video review and approval platform for filmmakers

Not yet tested productivity Based on TrueNAS app v1.2.62 (ViTransfer 1.3.8)
Project website TrueNAS app source Script on GitHub Report a problem
  1. 1
    Copy the script below
  2. 2
    In HexOS, open Apps, find ViTransfer and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
vitransfer.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS vitransfer 1.2.62"
6  },
37  "installation_questions": [
8    {
9      "question": "Share token secret",
10      "type": "password",
11      "key": "share_token_secret",
12      "required": true
13    },
14    {
15      "question": "Admin email",
16      "type": "password",
17      "key": "admin_email",
18      "required": true
19    },
20    {
21      "question": "Admin password",
22      "type": "password",
23      "key": "admin_password",
24      "required": true
25    }
26  ],
27  "requirements": {
428    "locations": ["ApplicationsPerformance"],
529    "specifications": ["2CORE"],
630    "permissions": ["READ_WRITE_LOCATIONS"],
731    "ports": [30291]
32  },
833  "ensure_directories_exists": [
34    {"path": "$LOCATION(ApplicationsPerformance)"},
35    {"path": "$LOCATION(ApplicationsPerformance)/vitransfer"},
36    {
37      "path": "$LOCATION(ApplicationsPerformance)/vitransfer/redis_data",
38      "snapshot": {"id": "redis_data"}
39    },
40    {
41      "path": "$LOCATION(ApplicationsPerformance)/vitransfer/uploads",
42      "snapshot": {"id": "uploads"}
43    },
44    {
45      "path": "$LOCATION(ApplicationsPerformance)/vitransfer/postgres_data",
46      "owner": {"user": "netdata", "group": "docker"},
47      "snapshot": {"id": "postgres_data"}
48    }
49  ],
50  "app_values": {
51    "vitransfer": {
952      "db_password": "$RANDOM_STRING(16)",
1053      "redis_password": "$RANDOM_STRING(16)",
1154      "jwt_secret": "$RANDOM_STRING(32)",
1255      "jwt_refresh_secret": "$RANDOM_STRING(32)",
1356      "encryption_key": "$RANDOM_STRING(32)",
1457      "share_token_secret": "$QUESTION(share_token_secret)",
1558      "admin_email": "$QUESTION(admin_email)",
1659      "admin_password": "$QUESTION(admin_password)",
1760      "app_url": "http://$SERVER_LAN_IP:30291"
61    },
62    "storage": {
1863      "redis_data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/vitransfer/redis_data)",
1964      "uploads": "$HOST_PATH($LOCATION(ApplicationsPerformance)/vitransfer/uploads)",
2065      "postgres_data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/vitransfer/postgres_data)"
66    },
67    "network": {
2168      "web_port": {"bind_mode": "published", "port_number": 30291}
69    },
2270    "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 vitransfer 1.2.62”.

    Lines 3–6

  3. Questions you'll be asked

    Before installing, HexOS will ask you for: Share token secret, Admin email and Admin password. 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). 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 30291 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) › vitransfer, App storage (fast) › vitransfer › redis_data, App storage (fast) › vitransfer › uploads and App storage (fast) › vitransfer › 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 33–49

  9. Auto-generated db password

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

    Line 52

  10. Auto-generated redis password

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

    Line 53

  11. Auto-generated jwt secret

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

    Line 54

  12. Auto-generated jwt refresh secret

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

    Line 55

  13. Auto-generated encryption key

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

    Line 56

  14. Your answer: share token secret

    Filled in with what you typed for “share token secret” when you installed.

    Line 57

  15. Your answer: admin email

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

    Line 58

  16. Your answer: admin password

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

    Line 59

  17. Your server's address (app url)

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

    Line 60

  18. Where the app's “redis data” files is saved

    Where the app's “redis data” files is saved on your server: App storage (fast) › vitransfer › redis_data.

    Line 63

  19. Where files you upload is saved

    Where files you upload is saved on your server: App storage (fast) › vitransfer › uploads.

    Line 64

  20. Where the app's database is saved

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

    Line 65

  21. Web port: 30291

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

    Line 68

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