Mattrax

module
v0.0.0-...-2921379 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 2, 2021 License: AGPL-3.0

README

Mattrax

Go Report Card

Open Source MDM (Mobile Device Management) System. Supporting Windows, Linux and macOS. There are plans to implement IOS, Android and ChromeOS in the future.

Project Status

Mattrax is under super heavy development. The Mattrax Cloud (SaaS version) will launch early 2021 and the self-hosted version will be available not long after that. Currently, the project is not ready for prime time so do not expose it to the internet and expect bugs.

Developing

Mattrax is built using Go and uses a PostgreSQL database. To setup a development environment use the instructions below.

HTTPS certificates are required to start the server. Let's Encrypt can be used to issue trusted certificates for free. The following commands expect the certificate to be at the path ./certs/tls.crt and the certificate's key at path ./certs/tls.key but this can be modified.

# Terminal 1: The Postgres database
docker-compose -f ./docker-compose-dev.yml up
# Terminal 2: Go Backend
go run ./cmd/mattrax --db "postgres://mattrax_db:password@localhost/mattrax?sslmode=disable" --domain mdm.example.com --tlscert "./certs/tls.crt" --tlskey "./certs/tls.key" --debug
# Terminal 3: Vue Frontend
cd dashboard
npm i
API_BASE_URL="https://mdm.example.com/api" npm run dev
# Open http://localhost:3000 in your browser and use the default credentials which are logged to the console on first run of the Go server.

This project uses sqlc so the command sqlc generate is used to generate the internal/db package from sql/queries.sql.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL