Mattermost
Mattermost is an open source platform for secure collaboration across the entire software development lifecycle..
- 1Copy the script below
- 2In HexOS, open Apps, find Mattermost and choose Custom Install
- 3Paste, then press Install — full guide with screenshots
1{
12 "version": 5,
23 "script": {
4 "version": "0.1.0",
5 "changeLog": "Auto-generated draft from TrueNAS mattermost 1.2.46"
6 },
7 "requirements": {
38 "locations": ["ApplicationsPerformance", "ApplicationsCapacity"],
49 "specifications": ["2CORE"],
510 "permissions": ["READ_WRITE_LOCATIONS"],
611 "ports": [30252, 30253]
12 },
713 "ensure_directories_exists": [
14 {"path": "$LOCATION(ApplicationsPerformance)"},
15 {"path": "$LOCATION(ApplicationsPerformance)/mattermost"},
16 {"path": "$LOCATION(ApplicationsCapacity)"},
17 {"path": "$LOCATION(ApplicationsCapacity)/mattermost"},
18 {
19 "path": "$LOCATION(ApplicationsPerformance)/mattermost/config",
20 "snapshot": {"id": "config"}
21 },
22 {
23 "path": "$LOCATION(ApplicationsPerformance)/mattermost/data",
24 "snapshot": {"id": "data"}
25 },
26 {"path": "$LOCATION(ApplicationsCapacity)/mattermost/logs"},
27 {
28 "path": "$LOCATION(ApplicationsPerformance)/mattermost/plugins",
29 "snapshot": {"id": "plugins"}
30 },
31 {
32 "path": "$LOCATION(ApplicationsPerformance)/mattermost/client_plugins",
33 "snapshot": {"id": "client_plugins"}
34 },
35 {
36 "path": "$LOCATION(ApplicationsPerformance)/mattermost/bleve_indexes",
37 "snapshot": {"id": "bleve_indexes"}
38 },
39 {
40 "path": "$LOCATION(ApplicationsPerformance)/mattermost/postgres_data",
41 "owner": {"user": "netdata", "group": "docker"},
42 "snapshot": {"id": "postgres_data"}
43 }
44 ],
45 "app_values": {
46 "mattermost": {
847 "db_password": "$RANDOM_STRING(16)",
948 "site_url": "http://$SERVER_LAN_IP:30252"
49 },
50 "storage": {
1051 "config": "$HOST_PATH($LOCATION(ApplicationsPerformance)/mattermost/config)",
1152 "data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/mattermost/data)",
1253 "logs": "$HOST_PATH($LOCATION(ApplicationsCapacity)/mattermost/logs)",
1354 "plugins": "$HOST_PATH($LOCATION(ApplicationsPerformance)/mattermost/plugins)",
1455 "client_plugins": "$HOST_PATH($LOCATION(ApplicationsPerformance)/mattermost/client_plugins)",
1556 "bleve_indexes": "$HOST_PATH($LOCATION(ApplicationsPerformance)/mattermost/bleve_indexes)",
1657 "postgres_data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/mattermost/postgres_data)"
58 },
59 "network": {
1760 "web_port": {"bind_mode": "published", "port_number": 30252},
1861 "calls_port": {"bind_mode": "published", "port_number": 30253}
62 },
1963 "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
64 }
65}
What this script does
Hover or tap a box to see the lines it explains.
-
Script format
Tells HexOS this is a version 5 install script, so it knows how to read the rest.
Line 2
-
Script revision
This copy of the script is revision 0.1.0. Latest change: “Auto-generated draft from TrueNAS mattermost 1.2.46”.
Lines 3–6
-
Storage locations it needs
The app uses these HexOS storage locations: App storage (fast) and App storage (large). If one isn't set up yet, HexOS will ask you to pick a place for it.
Line 8
-
Minimum hardware
Recommended minimum: 2 CPU cores.
Line 9
-
Permission to use your folders
Allows the app to read and write files inside the storage locations listed above — and nowhere else.
Line 10
-
Network ports
The app needs ports 30252 and 30253 to be free on your server. A port is like an apartment number for your server's address.
Line 11
-
Folders created on install
Creates the folders the app needs before it starts: App storage (fast) › mattermost, App storage (large) › mattermost, App storage (fast) › mattermost › config, App storage (fast) › mattermost › data, App storage (large) › mattermost › logs, App storage (fast) › mattermost › plugins, App storage (fast) › mattermost › client_plugins, App storage (fast) › mattermost › bleve_indexes and App storage (fast) › mattermost › 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 13–44
-
Auto-generated db password
HexOS makes up a long random db password during install. It's only used inside Mattermost, so you never need to know it.
Line 47
-
Your server's address (site url)
Automatically set to your server's address on your home network (http://your-server-ip:30252).
Line 48
-
Where the app's settings is saved
Where the app's settings is saved on your server: App storage (fast) › mattermost › config.
Line 51
-
Where the app's main data is saved
Where the app's main data is saved on your server: App storage (fast) › mattermost › data.
Line 52
-
Where the app's log files is saved
Where the app's log files is saved on your server: App storage (large) › mattermost › logs.
Line 53
-
Where add-ons and plugins is saved
Where add-ons and plugins is saved on your server: App storage (fast) › mattermost › plugins.
Line 54
-
Where the app's “client plugins” files is saved
Where the app's “client plugins” files is saved on your server: App storage (fast) › mattermost › client_plugins.
Line 55
-
Where the app's “bleve indexes” files is saved
Where the app's “bleve indexes” files is saved on your server: App storage (fast) › mattermost › bleve_indexes.
Line 56
-
Where the app's database is saved
Where the app's database is saved on your server: App storage (fast) › mattermost › postgres_data.
Line 57
-
Web port: 30252
The app's web page is published on port 30252. You don't need to remember it — clicking the app's card in HexOS takes you there.
Line 60
-
Calls port: 30253
Publishes the app's calls port as 30253.
Line 61
-
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 63