Portable Installation

Docksal can be installed from a USB drive or a local folder.
This is useful for conferences/trainings/etc. where internet bandwidth is an issue.

Creating a portable Docksal distribution

A working Docksal 1.2.0+ (fin v1.6.0+) environment is required

One-line download script

The following download script can be used to pre-download most of the dependencies and Docker images..

bash <(curl -fsSL https://get.docksal.io/portable)

Here is what the script will download:

  • Babun and winpty (necessary for Windows only)
  • VirtualBox and boot2docker.iso (necessary for macOS and Windows)
  • Docker tools: docker cli, docker-compose, docker-machine (macOS and Windows versions)
  • Docksal system and default stack images (these are cross-platform)

The following download options are available:

  • SKIP_DEPS - skip downloading dependencies (use if you plan to use the native Docker for Mac/Win apps or Linux)
  • SKIP_IMAGES - skip pulling and saving Docker images

Example:

SKIP_DEPS=1 bash <(curl -fsSL https://get.docksal.io/portable)

Once downloaded, place the contents of the folder on a USB drive/etc and distribute.

Custom stacks

If you plan on using a custom stack configuration, you will have to export the project images manually.

You can export both system and project images by running the following within a Docksal project folder:

fin image save --system
fin image save --project

This will create two files: docksal-system-images.tar and docksal-<project-name>-images.tar.
Instruct users to use the latter file instead of docksal-default-images.tar when loading stack images (see below).

Docker for Mac/Windows

Manually download Docker for Mac/Windows apps into the portable distribution folder:

Installing from a portable source

Babun is included in the portable distribution, but has to be installed manually before proceeding. All further commands are expected to be run in Babun on Windows.

Docksal’s one-line installer supports portable mode installation and will detect and use local files when available.

Mac and Windows (using VirtualBox)

This is the recommended setup option.

A minimal internet connection is still necessary to pull fin and Docksal stack files (~150kB).

Within the portable Docksal distribution folder run:

bash <(curl -fsSL https://get.docksal.io)
fin vm start
fin image load docksal-default-images.tar

Docker for Mac/Windows (“native” mode)

Consider reviewing the docs on switching between “native” applications and VirtualBox.

Install the corresponding Docker app for your OS from the provided portable distribution. Start the app and wait until Docker says it’s running.

Within the portable Docksal distribution folder run:

DOCKER_NATIVE=1 bash <(curl -fsSL https://get.docksal.io)
fin image load docksal-default-images.tar

Linux

Only Docksal system and stack images will be installed from the portable source. All other Docker dependencies and tools will be downloaded from the internet (you will need a decent internet connection).

Within the portable Docksal distribution folder run:

bash <(curl -fsSL https://get.docksal.io)
fin image load docksal-default-images.tar