2521-docker-image

Set up COMP2521 Docker Image on Windows

Note: these instructions are somewhat bare-bones right now. They should work, but it’d be nice to have something a little more thorough. Consider making a pull request if you’d like to help out!

  1. Install Git.

    • Ensure that you install the additional command-line tools.
    • Ensure that the tools are added to your PATH.

  2. Install Docker Desktop.

  3. Restart your system to ensure your environment variables are updated as required.

  4. Launch a “Git Bash” terminal.

  5. Download the project by running git clone https://github.com/COMP2521UNSW/2521-docker-image.git. The image will download to your current terminal directory, so ensure you run this in a safe location (to avoid data loss).

  6. Run the setup script and follow its prompts. You can run cd 2521-docker-image then ./scripts/setup. You may need to restart your terminal during the setup process if the SSH agent wasn’t configured correctly.