/apbs-rest-detect

Tool to detect installation requirements for APBS-REST

Primary LanguageGo

apbs-rest-detect

GitHub Actions status

Tool to detect installation requirements for APBS-REST

Based on the software already installed on your machine, we will give our best recomendation for which method to get ABPS-REST up and running. Installation paths include Docker Desktop, Minikube (via Virtualbox), or Minikube (via KVM).

Usage

Run the binary/executable for your respective system

./detect

You should see output with similar format to the following, respective to your system:

Linux

$ ./detect.exe
Target: Linux

Recommended Path:
  Minikube (via VirtualBox)

Required software:
  - VirtualBox
  - Minikube

Needed software...
  - VirtualBox - get from https://www.virtualbox.org/wiki/Downloads
  - Minikube   - get from https://kubernetes.io/docs/tasks/tools/install-minikube/

Windows

Note the additional line denoting Windows edition:

$ ./detect.exe
Target: Windows

Recommended Path:
  Docker Desktop (w/ Kubernetes)

Windows Edition:
  Microsoft Windows 10 Enterprise

Required software:
  - Docker Desktop

Needed software...
  - Docker Desktop - get from https://docs.docker.com/docker-for-windows/install/

Mac

$ ./detect.exe
Target: macOS

Recommended Path:
  Docker Desktop (w/ Kubernetes)

Required software:
  - Docker Desktop

Needed software...
  - Docker Desktop - get from https://docs.docker.com/docker-for-mac/install/

If your CPU does not support virtualization for 64-bit systems, you should receive output such as the following:

$ ./detect
Target: Linux

Unfortunately, your CPU does not support virtualization.

Build

To build from scratch, install the Go compiler, clone this repo, and from its top directory enter the following into your favorite shell:

$ go build -o <binary_name> ./src/