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

Working Remotely

Tips on how to run the Gigantum Client on a remote server

When working on a remote server, you will typically use the Gigantum CLI on a Linux system. You will also generally need to log into your remote systems using SSH (see below if you don't have ssh installed). As such, a basic level of familiarity with command-line operation will be necessary to work successfully with a self-managed remote Client.


The default Client configuration is intended for a single user at a time

While multiple users may be able to log in at the same time to a default Gigantum Client instance, the application state may become corrupted, primarily because the application caches your user identity to enable offline use.

If you want to support multiple users sharing a Client instance, then it is best to enable multi-tenant mode.

At a high-level, to run the Client remotely you need to complete the following steps:

  1. Provision and obtain SSH access to a remote server.
  2. Install Docker on the remote host because the Gigantum Client runs on Docker.
  3. Install the Gigantum CLI so you can configure, start and stop Gigantum over SSH.

While the Quick-start Script approach will automatically configure everything you need in many cases, more detailed steps are described in these sub-pages for different scenarios:

If you need help with a different cloud service, please drop us a note in our Spectrum chat community!

Getting SSH on your local machine

Linux and macOS come with the SSH command-line program pre-installed, as do recent updates to windows 10. You should be able to open a terminal (PowerShell on Windows) and run ssh from the prompt.

If you have an older version of Windows (e.g., Windows 7), you can use the graphical PuTTY program and configure tunneling under Connection->SSH->Tunnels in the configuration window. The source port should be 10000 and the destination should be

Updated about a year ago

Working Remotely

Tips on how to run the Gigantum Client on a remote server

Suggested Edits are limited on API Reference Pages

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