Skip to content

Collector software setup

Use the Collector Installer app to install the local NeoGT collector, dashboard, database, and supporting services.

Before you start

Confirm that the machine has:

  • Docker installed and running, or permission to install Docker from the installer app.
  • Internet access to pull the production images from GHCR.
  • Access to the official software releases repository: neotech-australia/software-releases.
  • An available dashboard port. The default is 443.

For Docker Compose setup without the installer app, use Manual installation.

Using installer app

The installer app creates the runtime folder, generates local credentials, creates a self-signed localhost TLS certificate, pulls the production Docker images, and starts the Docker Compose stack.

The installer app writes generated admin and database credentials to credentials.txt in the install folder.

Download the installer for the target operating system from the official software releases repository:

github.com/neotech-australia/software-releases

The installer binaries are stored in the repository bin/ folder.

Operating systemDefault install folder
macOS~/Library/Application Support/TiltmeterPlatform
Windows%LOCALAPPDATA%\TiltmeterPlatform
Linux~/.local/share/tiltmeter-platform

Install with the GUI

Choose the tab for the target machine.

  1. Open neotech-australia/software-releases and download bin/tiltmeter-collector-installer-mac-arm64-0.1.0.dmg.
  2. Open the DMG file.
  3. Drag Tiltmeter Collector Installer App.app to Applications.
  4. Open Tiltmeter Collector Installer App from Applications.
  5. Check the Docker status shown by the installer.
  6. Enter the dashboard port, or keep the default value 443.
  7. Start the install.
  8. Wait for Docker checks, image pulls, certificate generation, and stack startup to complete.
  9. Open https://localhost:<Dashboard Port> in a browser.
  1. Open neotech-australia/software-releases and download bin/tiltmeter-collector-installer-win64-0.1.0.exe.
  2. Double-click the EXE file.
  3. Check the Docker status shown by the installer.
  4. Enter the dashboard port, or keep the default value 443.
  5. Start the install.
  6. Wait for Docker checks, image pulls, certificate generation, and stack startup to complete.
  7. Open https://localhost:<Dashboard Port> in a browser.
  1. Open neotech-australia/software-releases and download bin/tiltmeter-collector-installer-linux-x64-0.1.0.
  2. Make the downloaded file executable if the desktop environment asks for permission.
  3. Open the installer.
  4. Check the Docker status shown by the installer.
  5. Enter the dashboard port, or keep the default value 443.
  6. Start the install.
  7. Wait for Docker checks, image pulls, certificate generation, and stack startup to complete.
  8. Open https://localhost:<Dashboard Port> in a browser.
Tiltmeter Collector Installer App

If the browser warns that the localhost certificate is not trusted, continue to the local dashboard. The certificate is generated locally by the installer for the machine.

Installer output

The installer uses these production images:

ImageValue
Collectorghcr.io/neotech-australia/tiltmeter-platform/collector:latest
Dashboardghcr.io/neotech-australia/tiltmeter-platform/dashboard:latest

The local dashboard is available at:

txt
https://localhost:<Dashboard Port>

For the default port:

txt
https://localhost:443

Headless install

Use the same installer from a terminal on machines without a GUI, or when installing over SSH. The terminal output shows Docker checks, image pulls, stack startup, status, and logs.

bash
"/Applications/Tiltmeter Collector Installer App.app/Contents/MacOS/Tiltmeter Collector Installer App" install --dashboard-port 443
powershell
cd ..\bin
.\tiltmeter-collector-installer-win64-0.1.0.exe install --dashboard-port 443
bash
cd ../bin
chmod +x ./tiltmeter-collector-installer-linux-x64-0.1.0
./tiltmeter-collector-installer-linux-x64-0.1.0 install --dashboard-port 443

If the selected dashboard port is already in use, install stops before changing the stack. To continue anyway, add --yes.

bash
"/Applications/Tiltmeter Collector Installer App.app/Contents/MacOS/Tiltmeter Collector Installer App" install --dashboard-port 443 --yes
powershell
.\tiltmeter-collector-installer-win64-0.1.0.exe install --dashboard-port 443 --yes
bash
./tiltmeter-collector-installer-linux-x64-0.1.0 install --dashboard-port 443 --yes

Status and logs

bash
"/Applications/Tiltmeter Collector Installer App.app/Contents/MacOS/Tiltmeter Collector Installer App" status
"/Applications/Tiltmeter Collector Installer App.app/Contents/MacOS/Tiltmeter Collector Installer App" logs --tail 300
powershell
cd ..\bin
.\tiltmeter-collector-installer-win64-0.1.0.exe status
.\tiltmeter-collector-installer-win64-0.1.0.exe logs --tail 300
bash
cd ../bin
./tiltmeter-collector-installer-linux-x64-0.1.0 status
./tiltmeter-collector-installer-linux-x64-0.1.0 logs --tail 300

Common commands

Append one of these commands after the installer executable path:

bash
check-docker
install-docker
install --dashboard-port 443
start
stop
restart
status
logs --tail 300

Neotech Geotechnical Engineering documentation.