Windows Host

General Guidance

Windows users can use the tool under WSL (Windows Subsystem For Linux). Make sure it's under WSL2 for better compatibility.

As the tool is primarily written for Linux based as well as Docker in Windows also runs the underlying technology in the Linux subsystem. There is no need to rewrite or port the tool over to the Windows shell.

Windows users can directly benefit from running a full-fledged Linux environment from within Windows.

Provided you've gone through the prerequisites with WSL available.

Open the command line (Run as administrator - Only needs to be done just this once), then run the following:

curl -o C:\Windows\igm.bat -L https://raw.githubusercontent.com/XternA/income-generator/main/start.bat

This will get the initialiser script and configure everything including getting the tool. This script will essentially be registered as the alias igm for global accessibility. Since it's placed in C:\Windows dir. it's already recognised without needing to define environment variable.

Everything will be running in the WSL environment. The tool is located in the home directory ~/ of the Linux structure.

From now on, you can run the tool without admin. Just type in the command line:

igm

After the initial setup and first run. Whether you are executing the tool from the Windows command line or in the WSL Linux subsystem's terminal, you can run the tool anywhere with igm. It's not required to switch to-or-from Windows/Linux shell.

Daemon (Docker Engine)

You must ensure that the Docker engine daemon is running at all times, or starte d before interacting with the tool, this is also required as the containerized applications depend on the Docker Engine.

Refer to the Docker Installation guide.