Skip to content

Docker Installation

Jump to bottom
XternA edited this page Apr 6, 2024 · 27 revisions

Note: This section can be used as a reference guide (but recommended reading through) as the tool is capable of installing Docker provided the necessary dependencies are available.

The stack utilizes containerization technologies such as Docker to run applications in a virtualized and isolated environment from the host.

Docker doesn't need to be pre-installed as the tool is capable of installing Docker. Though if it is already installed then the process becomes much easier.

This won't be the case for Windows hosts. Refer to the Windows section.

Linux/macOS

When using the tool, from the main menu, select for Install/Uninstall Docker option which will present the following sub-menu.

Income Generator Application Manager
----------------------------------------

1. Install Docker
2. Uninstall Docker
0. Back to Main Menu

Select an option (1-2):

Choosing either option will install or uninstall docker completely from the host system. If Docker is already installed then nothing happens.

macOS (Darwin)

Installing Docker directly via the tool on macOS is also fully supported. The tool uses the Homebrew package manager to automate this process, similar to Linux distro Ubunutu's apt package manager. This will be pre-installed when the tool starts for the first time and the binary isn't found on the system.

Unlike Linux where the Docker-CLI is installed. On macOS, there is no option to install just the CLI version but Docker Desktop is installed instead which includes the underlying CLI and Docker Engine.

When installing Docker via the tool, the Docker Desktop will launch during the installation. It's recommended to go through the setup on Docker Desktop. An account is not required and can be skipped.

The only thing that needs doing is to ensure the Docker Engine is started every time (Which runs the containerized applications and ensures they're running). Without this, none of the containerized apps will run.

Open the Docker Desktop UI and navigate to the settings ⚙️ panel.

  1. Check Start Docker Desktop
    • This will start the Docker Engine on host system startup.
  2. Uncheck Open Docker Dashboard
    • This will prevent the UI from loading up on startup.

We don't need to interface with the UI at all. There's no option currently to install the CLI independently.

Another thing to note. Closing and Quitting the Docker Desktop has two meanings:

  • Closing - The Docker Engine is still running, which means all the applications will still be live.
  • Quitting - The Docker Engine will completely shut down, which means all applications will cease operation. No income generating.

Therefore, to keep the applications running ensure that if you do open the Docker Desktop, just close it and not terminate it. This includes the Docker 🐋 icon in the top menubar.

Windows

⚠️ Refer to the Windows guide on setup and configurations before proceeding here.

On Windows host, it is recommended to install Docker first before running the tool. There is no support for installing from within the tool.

This is to avoid having to port the scripts over to the Windows batch script as the tool is written in Shell. Since Docker, despite being installed within the Windows host directory, Docker Engine effectively uses the WSL subspace, which means we can technically run the tool in Linux, but on Windows.

To install Docker Desktop (no CLI-only version). In the Windows Terminal type:

winget install -e --id Docker.DockerDesktop

Provided the later version of Windows 10 & 11 comes with Winget (official package manager for Windows) pre-installed.

Once installed, launch the Docker Desktop to start the Docker Engine. Agree to the terms and go through the process. An account is not required and can be skipped.

Containerized applications will not run if the Docker Engine isn't running, so we need to ensure that it is started automatically on every system startup.

Open the Docker Desktop UI and navigate to the settings ⚙️ panel.

  1. Check Start Docker Desktop
    • This will start the Docker Engine on host system startup.
  2. Uncheck Open Docker Dashboard
    • This will prevent the UI from loading up on startup.

We don't need to interface with the UI at all. There's no option currently to install the CLI independently.

Make sure not to terminate the Docker 🐋 icon in the taskbar as this allows the Docker Engine to stay running. Closing the UI is fine, just don't quit.

Clone this wiki locally