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

Local Launch and Login

You've got Gigantum installed locally and are ready to go.

Start Gigantum

To start Gigantum, Docker must be running. If you use Gigantum Desktop, it will start Docker for you. If you use the CLI you must make sure Docker is running yourself.

  • If you are using Gigantum Desktop, simply click on the big Start button
  • If you are using the CLI, simply run gigantum start.

This will launch a window in your default web browser where you can log in for the first time. The application should appear at http://localhost:10000/. If it doesn't automatically happen, then just go to that location.

Create An Account

Your first time logging in will require you to create a Gigantum account. To support versioning, collaboration, and access to cloud storage, the Gigantum Client currently requires all users have an identity from the start.

When the app opens at http://localhost:10000/, you'll be prompted to sign up.

  • Click on the "Sign Up or Login" button to load the registration page
  • Enter your email, a username, and password
  • Agree to the Terms of Service (primarily related to interacting with Gigantum Hub)
  • Click to submit

Sign up when launching for the first time

Once registration completes, you will be redirected to the Project listing page and are ready to go! You will receive and email to confirm your registration. Please confirm your email!

This is the landing page you will see once you've completely logged in. You are now ready to create a Project or explore the demo!

Updated 6 months ago

Local Launch and Login

You've got Gigantum installed locally and are ready to go.

Suggested Edits are limited on API Reference Pages

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