Docker for Windows Installation

This guide provides all necessary steps to install Apex via Docker on a Windows machine. This provides you with the quickest way to get up and running with Apex, and does not require PHP to be installed on your machine.

Install WSL

Install WSL by completing the following steps:

  1. Open Settings.
  2. Click on Apps.
  3. Under the "Related settings" section, click the Programs and Features option.
  4. Click the "Turn Windows features on or off" option from the left pane.
  5. Check the "Windows Subsystem for Linux option."
  6. Click the OK button.
  7. Click the Restart now button.

Install Linux Distros Using Microsoft Store

Next, install a Linux distribution by completing the following steps:

  1. Open Microsoft Store.
  2. Search for the Ubuntu 20.04 distribution.
  3. Select the distribution, and click the Install or Get button.
  4. Click the Launch button.
  5. Create a username for the Linux distro and press Enter.
  6. Specify a password for the distro and press Enter.

Install Docker on Windows

If you haven’t already downloaded the installer (DockerDesktopInstaller.exe), you can get it from the Docker site at https://www.docker.com/products/docker-desktop. It typically downloads to your Downloads folder, or you can run it from the recent downloads bar at the bottom of your web browser.

Once downloaded, complete the following steps:

  1. Double-click "DockerDesktopInstaller.exe" to run the installer.
  2. When prompted, ensure to install required Windows components for WSL 2 option is selected on the Configuration page.
  3. Follow the instructions on the installation wizard to authorize the installer and proceed with the install.
  4. When the installation is successful, click Close to complete the installation process.

Add User to Docker Group

This section only applies if your user account is different than your administrator account. If so, complete the following steps:

  1. Run Computer Management as an administrator.
  2. Navigate to Local Users and `Groups > Groups > docker-users.
  3. Right-click and add the user to the group.
  4. Log out and log back in for the changes to take effect.

Install WSL Extension in VS Code

Next, start your Linux instance with the following steps:

  1. Open VS Code.
  2. Install the wsl extension.
  3. Open a remote WSL instance.
  4. That's it, you now have a fully working Linux instance running in Docker. You may now login to your new Linux instance and install Apex by running the commands:
git clone https://github.com/apexpl/apex
cd apex && mv install_example.yml install.yml
sudo docker-compose up -d
sudo docker-compose exec apex apex

That's it, And Apex will now be fully installed with base packages, and your administration panel will be available at http://127.0.0.1/admin/.