Installation


Docker Desktop

Docker Desktop is a requirement for AppIgnition, but you can install Docker Desktop on all major platforms:

Docker Desktop comes with all of the required software needed to successfully run the Docker engine, meaning once you install Docker Desktop, you can start using AppIgnition!

Git

Before installing AppIgnition, ensure that Git is installed on your machine and available in your system's PATH variable. Git is necessary for cloning the repository of containers needed to run your applications, and it is used to clone repositories of existing applications you might want to install. Furthermore, while it is not required if you only plan on working with public repositories, you might want to consider configuring SSH access on your local machine to any of your private repositories. As an example, you can configure SSH access to GitHub by reading these instructions.

{warning} If you're using Windows, you might want to consider reading our additional documentation to finish configuring Git on your machine once it is installed.

As a final note, you also want to ensure your private key files have the correct permissions within your ~/.ssh folder. On Unix systems (Mac or Linux), you can apply the permissions with the following command:

chmod 600 ~/.ssh/id_rsa

This is assuming your private key file is named id_rsa.

Install

To install AppIgnition, make sure you are using the latest version of Docker Desktop. To verify you are on the latest version, navigate to the Settings page by clicking the gear icon in the navbar, and then Software updates.

Docker software updates

Once verified, click Apply & restart. Head back to the main menu and click Add Extensions in the sidenav. Search for AppIgnition, and then click Install. For easier navigation, you can also choose to install it from the Docker Extension Marketplace.

Docker Resources

If you never used Docker Desktop before, I would recommend altering your allocated resources to improve your development experience. Navigate to the settings page in Docker Desktop and then select Resources on the side nav. Modify each setting depending on how much you're comfortable providing. With more resources, your experience will be better, but it might come at the expense of worsening your experience outside of Docker.

Docker resources

{warning} If you are using Windows, resources will be managed by Windows Subsystem for Linux (WSL). WSL will automatically be installed when you install Docker Desktop.