Added information on package access rights (#15)

* Added information on package access rights * Apply suggestions from code review Co-authored-by: Fabian Schöppach <[email protected]> --------- Co-authored-by: Fabian Schöppach <[email protected]>
FAIRmat-NFDI · Apr 3, 2024 · 01f9d99 · 01f9d99
1 parent b5ce5ef
commit 01f9d99
Showing 1 changed file with 17 additions and 4 deletions.
diff --git a/template_README.md b/template_README.md
@@ -9,12 +9,14 @@ and how to customize it through [adding plugins](#adding-a-plugin).
 > [!IMPORTANT] 
 > Depending on the settings of the owner of this repository, the distributed image might
 > be private and require authentication to pull.
-> If you are the owner you should make sure that your organization settings allow public
-> packages and after that set this package public.
+> If you want to keep the image private you need to configure and use a personal access
+> token (PAT) according to the instructions in the GitHub docs [here](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry#authenticating-with-a-personal-access-token-classic).
+> If you want to make the image public (recommended), you should make sure that your 
+> organization settings allow public packages and make this package public after building it.
 > You can read more about this in the GitHub docs [here](https://docs.github.com/en/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility).
 
 > [!TIP]
-> In order for you others to find and learn from your distribution we in FAIRmat would
+> In order for others to find and learn from your distribution we in FAIRmat would
 > greatly appreciate it if you would add the topic `nomad-distribution` by clicking the
 > ⚙️ next to "About" on the main GitHub page for this repository.
 
@@ -41,7 +43,8 @@ cd nomad-oasis
 ```sh
 sudo chown -R 1000 .volumes
 ```
-5. Pull the images speicified in the `docker-compose.yaml` (retrieved from the `nomad-oasis.zip`) using
+5. Pull the images specified in the `docker-compose.yaml` (retrieved from the `nomad-oasis.zip`).
+Note that the image needs to be public or you need to provide a PAT (see "Important" note above).
 ```sh
 docker compose pull
 ```
@@ -123,3 +126,13 @@ plugins:
 
 Once the changes have been committed to the main branch, the new image will automatically 
 be generated.
+
+## FAQ/Trouble shooting
+
+ *I get an* `Error response from daemon: Head "https://ghcr.io/v2/GITHUB_REPOSITORY/manifests/main": unauthorized`
+ *when trying to pull my docker image.*
+
+ Most likely you have not made the package public or provided a personal access token (PAT).
+ You can read how to make your package public in the GitHub docs [here](https://docs.github.com/en/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility)
+ or how to configure a PAT (if you want to keep the distribution private) in the GitHub
+ docs [here](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry#authenticating-with-a-personal-access-token-classic).