Hi,
I’d like to propose a clarification in the “Install from Source” docs.
Specifically, the Docker section in “Pre-requisites”
If you have not fully configured Docker, it’s possible to receive 401s installing mysql in the initial yarn setup process. Installing Docker Desktop without authorizing it results in the following error:
✘ redis Error failed to resolve reference "docker.io/library/mysql:8.0.35": failed to authorize: fa... 4.8s
✘ mysql Error failed to resolve reference "docker.io/library/mysql:8.0.35": failed to authorize: fa... 4.8s
Error response from daemon: failed to resolve reference "docker.io/library/mysql:8.0.35": failed to authorize: failed to fetch oauth token: unexpected status from GET request to https://auth.docker.io/token?scope=repository%3Alibrary%2Fmysql%3Apull&service=registry.docker.io: 401 Unauthorized
error Command failed with exit code 1.
In order to fix this, I also needed to:
- run
docker login - authorize my local machine
- verify my email with Docker
Only then would it allow me to complete yarn setup and download docker.io/library/mysql:8.0.35.
Proposed change
I propose adding a small change to the documentation for “Install from source” yarn setup step:
“The setup task will install dependencies, initialise the database, set up git hooks, and initialise submodules. If using Docker Desktop, you will need to authorize your local machine with docker login before running this command.”
It also makes sense to move this text above the example command so that users can consider it before having yarn setup run and fail.
Thanks for considering the Docs change!