Gigantum

The Gigantum User Hub

Welcome to the Gigantum user hub. 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.

Let's get to it!

Get Started    

Launch and Login

You've got it installed and are ready to go.

This section describes how to start Gigantum locally, sign in and sign up, and get started using the app. To get started, you just need to do the following:

  1. Make sure Docker is running
  2. Start Gigantum using the Desktop App (or the CLI)
  3. Login and create your account

After you've created an account, you may have to login to get access to the application.

Make Sure Docker is Running then Start Gigantum Client

Docker usually starts on boot, but sometimes you need to start it manually. Make sure Docker is running and start the Gigantum Client by using Gigantum Desktop (or the CLI).

  • If you are using Gigantum Desktop, simply double click on the icon;

  • If you are using the CLI, 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 Your Account

Your first time logging in will require you to create an 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 login. Just login and start the registration process.

  • Click on "Sign Up" to create a new account
  • Fill out the fields
  • Agree to the Terms of Service (primarily related to interacting with Gigantum Cloud)
  • Click "Sign Up"
This is the registration widget you will see in your browser when logging in for the first time. You will need to enter the indicated information to sign up.

This is the registration widget you will see in your browser when logging in for the first time. You will need to enter the indicated information to sign up.

  • Agree to the access request.
    • The "Authorize App" is an extra control when running on localhost, and the dialog just prompts you to agree that it is safe to authorize the application.
After filling in the form, you need to agree to the authorization request. This is because Gigantum is running locally and is not yet "trusted".

After filling in the form, you need to agree to the authorization request. This is because Gigantum is running locally and is not yet "trusted".

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.

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!

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!

Launch and Login


You've got it installed 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.