Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docker: add docker socket help for mac users #709

Merged
merged 3 commits into from
Oct 4, 2024
Merged

docker: add docker socket help for mac users #709

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d23dfd6
docker: add docker socked help for mac users
tmorrell Oct 3, 2024
00892d8
Update docs/install/requirements.md
tmorrell Oct 3, 2024
519f383
Update docs/install/requirements.md
tmorrell Oct 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/install/requirements.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,15 @@ and adjust the `Memory` to the corresponding value. If you have a few cores
more to spare, it might be a good idea to give more than 2. Take into account
that you will run between 4 and 8 containers.

#### Docker socket (macOS)

invenio-cli uses the Docker Python API to check things like the Docker version. The Docker Python API
uses the Docker socket, which may not be enabled by default on a Mac. You'll know you have this problem
tmorrell marked this conversation as resolved.
Show resolved Hide resolved
if you see the error message `docker.errors.DockerException: Error while fetching server API version:`.
You can enable to Docker socket by going to Docker desktop, Settings, Advanced, and checking the box for
tmorrell marked this conversation as resolved.
Show resolved Hide resolved
"Allow the default Docker socket to be used". You will need to enter your Mac password after you "Apply & restart"
this change.

#### OpenSearch and Docker (macOS and Linux)

Among the containers you will run is an OpenSearch container which is quite demanding.
Expand Down