Skip to content

Commit

Permalink
Merge pull request #385 from GrahamDumpleton/docker-requirements
Browse files Browse the repository at this point in the history
Add requirements for Docker Desktop.
  • Loading branch information
GrahamDumpleton authored May 23, 2024
2 parents f5046ad + 47f1c72 commit 4fc68d5
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion project-docs/getting-started/quick-start-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ To deploy Educates on your local machine using the Educates command line tool th

* You need to be running macOS or Linux. If using Windows you will need WSL (Windows subsystem for Linux). The Educates command line tool has primarily been tested on macOS.

* You need to have a working `docker` environment. The Educates command line tool has primarily been tested with Docker Desktop.
* You need to have a working `docker` environment. The Educates command line tool has primarily been tested with Docker Desktop on macOS.

* You need to have sufficient memory and disk resources allocated to the `docker` environment to run Kubernetes, Educates etc.

Expand All @@ -27,6 +27,14 @@ To deploy Educates on your local machine using the Educates command line tool th

* You need to have port 5001 available on the local machine as this will be used for a local image registry.

If you are using Docker Desktop, you need to have the following enabled:

* Use kernel networking for UDP (Settings->Resources->Network).

* Allow the default Docker socket to be used (Settings->Advanced).

* Allow privileged port mapping (Settings->Advanced).

Downloading the CLI
-----------------------

Expand Down

0 comments on commit 4fc68d5

Please sign in to comment.