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

Using non-standard configurations

A standard installation of the Gigantum client will have our recommended configuration. At present, we can provide only limited support for non-standard configurations. As such, while we provide documentation below, please realize that we can make no guarantees once you start making such changes!

Changes can be made by creating a file called ~/gigantum/.labmanager/config.yaml (this will be parsed as a YAML file). Any configuration you provide there will override the defaults.

Alternative / additional base images

While Gigantum only guarantees support for our official base images (these are maintained as an open source project), it is possible to configure alternative or additional sources. The default configuration is:

environment:
  repo_url:
    - "https://github.com/gigantum/base-images.git"

You may substitute any git repository that adheres to the appropriate specification (we recommend forking our existing base-images repository to get started). The repository URL will check out the default branch (usually master), though you can specify a non-standard branch with syntax like the following: "https://github.com/gigantum/[email protected]". While the default is to use only one repository, you may also use a list of repositories. If you wish to keep the default gigantum repositories, for example, you might add your own repository like this:

environment:
  repo_url:
    - "https://github.com/gigantum/base-images.git"
    - "https://github.com/my-org/[email protected]"

Multi-tenant Mode

By default, the local Gigantum client will maintain your identity in the application itself. This allows you to retain your identity and work offline. If you would rather have identity managed by the browser (for example, if you are supporting multiple users on one client), you can add the following to a custom configuration file (the default for identity_manager is local):

auth:
  identity_manager: browser

Updated 24 days ago

Using non-standard configurations


Suggested Edits are limited on API Reference Pages

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