Files
2023-11-16 13:14:44 -08:00

2.4 KiB

Step 4: Pull your image

Now things are running!

Whoa, now things are running! This may take a few minutes. This might take a tiny amount of time, so grab your popcorn 🍿 and wait for the build to finish before moving on.

To pull the Docker image, we need to log into Docker first.

Before we can use this Docker image, you will need to generate a personal access token that contains the following permissions:

  • repo (all)
  • write:packages
  • read:packages

screenshot personal access token creation page with boxes for repo (all), write:packages, and read:packages checked

We will use this token to log in to Docker, and authenticate with the package.

  1. Open your terminal (Bash or Git Bash recommended).
  2. Use the following command to log in:
    docker login ghcr.io -u USERNAME
    
  3. Replace USERNAME with your GitHub username.
  4. Enter your new Personal Access Token as the password.
  5. Press Enter.

If everything went well, 🤞 you should see Login Succeeded in your terminal.

⌨️ Activity: Pull your image

  1. Copy and paste the pull command from the package instructions into your terminal. It should look something like this:
    • docker pull ghcr.io/YOURNAME/publish-packages/game:TAG screenshot of the pull command on the GitHub package page
    • Tip: To reach this page, click the Code tab at the top of your repository. Then, find the navigation bar below the repository description, and click the Packages heading link
  2. Replace YOURNAME with your GitHub username.
  3. Replace TAG with the image tag.
  4. Press Enter.
  5. You should see output indicating that the pull was successful, like Status: Downloaded newer image for ghcr.io/YOURNAME/publish-packages/game:TAG. screenshot of successful Docker image output
  6. We can't automatically verify this step for you, so please continue on to the next step below!