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 Docker

Installing and configuring Docker for use with Gigantum

If you use the Gigantum Desktop App or get-gigantum.sh script, then the Docker install is managed for you. If you prefer to install Docker manually, follow the steps in the appropriate section below.

Installing and Configuring for Windows

Follow these directions if you aren't using the Gigantum Desktop App to manage installation and you want to do it all manually on a Windows Machine.

🚧

Windows Version Limitation

Due to limitations in the Docker Windows client, Gigantum only supports Professional, Education, or Enterprise editions of Microsoft Windows 10.

🚧

WSL2 not yet supported

Gigantum Client does not yet run on WSL2 in Windows. We are actively working to add this capability in the near future.

Installing and configuring Docker on Windows 10 requires a few steps. This section summarizes Docker's instructions for common Windows installations.

  1. Download Docker Community Edition (CE) stable release installer
  2. Double-click ‘Docker for Windows Installer.exe’ to run the installer
  3. Follow the install wizard steps to accept terms, authorize the application, and install
    • You may have to authorize with your password, but maybe not.
    • If asked to choose Windows containers, just say no.
    • If Docker asks to enable Hyper-V, say yes. This may result in a reboot.
  4. After completing installation, sign out and sign back in to Windows to give your user permissions to run Docker commands.
  5. Launch the Docker application by double clicking on the Desktop icon or running the program through the Windows search bar

By default, Docker limits the amount of processors and memory available for use. To make it faster, a general rule of thumb is to increase the allocations to half of the available CPU (e.g. 2 of 4) and half of the available RAM (e.g. 8 GB of 16 GB). This leaves Windows adequate resources to run, but keeps Gigantum and your Projects snappy.

The more memory and cores you give to Docker, the faster Gigantum will be. However, if you don't have enough cores and memory for Windows, your computer will be slow. Typically you should keep 1-2 cores and ~2-4GB of RAM allocated to Windows at a minimum.

One-Time Docker Configuration Process:

  1. Start Docker and right-click on the Docker icon in the system tray
  2. Select Settings
  3. Click on the Shared Drives tab and check the C drive and hit Apply.
    • If you forget to do this, Docker may access the C drive the first time Gigantum starts.
    • If your OS is set up differently, then select the drive containing the Windows User Directories
  4. Click on the Advanced Tab and give more CPU and Memory to Docker
    • For a "standard" laptop, allocating half of your CPUs and Memory to Docker should work well
  5. Click Apply and wait for Docker to restart

Installing and Configuring for MacOS

🚧

Docker for Mac Version Limitation

Due to limitations in the Docker for Mac client, only macOS 10.10 Yosemite and higher are currently supported.

This section summarizes Docker's instructions for common macOS installations. You can visit Docker's website for additional information.

  1. Download the Docker for Mac Community Edition (CE) stable build.
  2. Double click the downloaded Docker.dmg if it doesn't launch automatically.
  3. Drag and drop Docker to Applications in the new window.
  4. Launch Docker by clicking on the Docker app in the Applications folder

Configuring Docker for MacOS

The default Docker configuration limits the amount of processors and memory available for use by Gigantum. A general rule of thumb is to increase the allocations to half of the available CPU (e.g. 2 of 4) and half of the available RAM (e.g. 8 GB of 16 GB). This leaves macOS adequate resources to run, but keeps Gigantum and your Projects snappy.

If your system has lots of memory and/or cores available, allocating more than half to Docker will give your Projects more resources to run faster as well. Typically you should keep 1-2 cores and ~2-4GB of RAM allocated to macOS at a minimum.

One-Time Docker Configuration Process:

  1. Open the Docker for Mac app if it is not already running
  2. Right-click on the Docker whale icon in the taskbar to open the Docker menu
  3. Select Preferences
  4. Click on the Advanced tab
  5. Slide both CPUs and memory to the right to give more CPU and memory
    • For a "standard" laptop, allocating half of your CPUs and Memory to Docker should work well
    • You are free to modify these settings to meet your computational needs, but it is recommended that you keep at least 1-2 CPUs and 2-4 GB of RAM available for your host operating system
  6. Click Apply and Docker will restart
  7. Once the Docker whale icon in stops animating in the taskbar you are ready to go!

Process to configure Docker for Mac

Installing for Linux

The following instructions are a summary of the process for Ubuntu 16.04, but are similar for various flavors of Linux. Check out Docker's install instructions for more details.

🚧

Install Latest Docker

The docker and docker.io packages distributed with Ubuntu 16.04 will not install a version of Docker that functions with Gigantum! Follow the instructions on this page or at Docker's website to install the latest stable version.

The easiest way to install Docker is through a convenience script they provide, as described on Get Docker CE for Ubuntu page. If desired, you can read more about this script here.

First, download and run the convenience script to install Docker.

sudo apt-get install -y curl
curl -fsSL get.docker.com -o get-docker.sh
sudo sh get-docker.sh

🚧

Caution

Always examine scripts downloaded from the internet before running them locally.

When this script is complete, Docker will be installed but only the root user will be able to use it. By adding your username to the docker group you can execute Docker commands without having to run sudo first. Run the following command to add your user account.

sudo usermod -aG docker $USER

Note, you need to log out and then log in to update these permissions. You will know it is working when running docker ps in your terminal does not cause an error.

Configuring for Linux

Because Docker runs natively on Linux, you should not have to perform any additional configuration for Gigantum to work well.

Updated 10 days ago

Installing Docker


Installing and configuring Docker for use with Gigantum

Suggested Edits are limited on API Reference Pages

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