Gigantum

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

Installing Gigantum Desktop

A desktop app for managing Gigantum locally

Gigantum Desktop is a native app for managing the Gigantum Client, which is the actual web application you work in. Gigantum Desktop is the recommended way to install, update, and launch the Gigantum Client locally.

If you prefer the command line, then you can skip Desktop app and just install the Gigantum CLI to manage the Gigantum Client from the comfort of a terminal.

Download and Install

Getting Gigantum Desktop is easy and it will walk you through installing and configuring Docker if needed. To get started, download the app from https://gigantum.com/download. Once downloaded:

  • MacOS: Double click the file and drag-and-drop the app into your Applications folder
  • Windows: Double click the installer to run it. If you have Windows Defender you may need to "unblock" the app. To do this, right click on the app, select Properties, and then check "Unblock"
  • Linux: You may need to make the AppImage executable as shown here

Running Gigantum Desktop for the first time will open a configuration wizard to help walk you through installing Docker, configuring Docker, and configuring Gigantum.

Additionally, Gigantum Desktop periodically checks for updates and notifies you when one is available. When updating, data is first downloaded in the background so you can keep working. The update will be applied when you restart.

Starting and Stopping Gigantum Client

Gigantum Desktop can start when you compute starts so it is always available when you need it. When running the app sits in your system tray.

To start the Client, click on the Gigantum icon in your system tray and then the large Start button. This will start the Client container and open your default web browser (browser used is configurable in preferences) to http://localhost:10000, but if this doesn't happen then just go to that URL in a web browser.

Starting Gigantum Client using the Desktop app

Starting Gigantum Client using the Desktop app

To stop the Client, again click on the system tray icon and the large Stop button. This will shutdown the Gigantum Client and all Gigantum managed Docker containers. Be sure to save your work before quitting!

Stopping Gigantum Client using the Desktop app

Stopping Gigantum Client using the Desktop app

To quit the Desktop application completely, click the icon in your system tray, open the app menu, and select quit. This will shutdown the Gigantum Client and all Gigantum managed Docker containers. Be sure to save your work before quitting! If at any point you wish to simply restart the Gigantum client, select "Restart" from the app menu.

Quitting Gigantum Desktop

Quitting Gigantum Desktop

Updated 24 days ago

Installing Gigantum Desktop


A desktop app for managing Gigantum locally

Suggested Edits are limited on API Reference Pages

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