Gigantum Documentation

You'll find comprehensive guides and documentation to help you start working with the Gigantum platform as quickly as possible. If you get stuck, then there is help for that too. Just reach out to the team or get help from the community using our our Spectrum channel.

Get Started    Changelog

Quick-start Script

Use the script to quickly configure a Linux host


Quick Start

It's recommended that you read through this page, but to run the script simply execute the following:

curl -fsSL -o

A "quick-start" script is available that can automatically configure a Linux host for you. The script has been tested on Ubuntu 18.04, Centos 8, and Amazon Linux 2. If you run into issues on a different host OS, let us know in our Spectrum chat community.

Remember to examine all scripts downloaded from the internet before running them locally.


Once you have provisioned a Linux host with ssh access (if you have the choice, Ubuntu 18.04 is recommended), running the script will configure the host to run Gigantum.

The script must be run with Bash and as a non-root user.

The script will prompt you for two options:

  • Install NVIDIA GPU support: If you are running on a Linux host with GPUs and would like to perform accelerated computing in Gigantum, enable this option. The script will then install NVIDIA drivers on your host and the nvidia-docker2 package for backwards compatibility.
  • Start Gigantum Client on boot: If enabled, the Gigantum Client will be installed as a service and started automatically when the instance boots. If not enabled, you will have to manually start/stop the Client via the CLI.

Finally, the script can be run in a non-interactive mode with the following flags:

  • -q: Quiet - Don't prompt for input
  • -n: Install GPU support packages
  • -s: Install service/init script to start Gigantum on boot

Running the script

Step 1: SSH into the Linux Host
Use your terminal or SSH client to connect to the host. Depending on the host, you may SSH in as a specific user as shown in some examples below. Note, we port forward the port 10000, because this is the port the Gigantum Client runs on.

# An example of logging into an Ubuntu EC2 instance on AWS
ssh -i ~/.ssh/<my pem>.pem -L 10000:localhost:10000 [email protected]<instance hostname>
# An example if you have a linux host that you log into as root with a password instead of a key
ssh -L 10000:localhost:10000 [email protected]<ip address>

Step 2: (if needed) Create non-root user
If you are already ssh'ed in as a user other than root, you can skip this step!

The script does not allow you to run as root. This is because the Client does not want files to be owned by root, but by an unprivileged user. If you install the Client as a service, it will run as the same user as the user who ran the install script.

To create a user to run Gigantum Client, we create the user, give them sudo access, and set a password as shown below:

useradd -m giguser
usermod -aG sudo giguser
passwd giguser

With this user created, we now switch to that user to run the install script

su giguser

Step 3: Run the install script
Finally, we run the install script, answering the prompts as needed. Remember, if you wish to use GPUs with Gigantum your instance must have GPUs attached and you enter y when prompted. If this instance is only to be used to run Gigantum Client, it is recommended to run the Client as a service.

cd ~
curl -fsSL -o

Using Gigantum Client

Now that the Client is installed you're ready to start working! Depending if you're running the Client as a service or not changes how you get started.

Installed as a service
This is the easiest path. After the script completes, the Client should be running and you can simply go to http://localhost:10000 in a web browser your local machine.

To stop working, exit your SSH session. To continue again, simply SSH back into the server, remember to port forward as shown above. You don't actually have to do anything with the SSH session - just leave it open while you're working (you can easily re-establish the ssh connection if you close it).

Not installed as a service
If you did not install Gigantum Client as a service you need to close your current SSH session and start again, remembering to port forward as shown above. This step ensures the non-root user has the ability to interact with docker.

Next, if you SSH in as root, switch to the non-root user user as you did during installation.

Finally, run gigantum start to start the Client. You should now be able to go to http://localhost:10000 in a web browser your local machine and see the Client UI.

To stop the Client, run gigantum stop.

Updated 3 months ago

Quick-start Script

Use the script to quickly configure a Linux host

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.