tutor icon indicating copy to clipboard operation
tutor copied to clipboard

docs: add git clone eof error troubleshooting

Open Danyal-Faheem opened this issue 11 months ago • 0 comments

Issue

  • Git throws an EOF error while cloning large repositories on slow/unstable networks.
RUN mkdir -p /openedx/edx-platform &&     git clone https://github.com/openedx/edx-platform.git --branch open-release/quince.1 --depth 1 /openedx/edx-platform:
Cloning into '/openedx/edx-platform'...
fatal: the remote end hung up unexpectedly
fatal: early EOF
fatal: index-pack failed
  • This error is thrown while cloning edx-platform during the build process of the openedx/openedx-dev image. https://github.com/overhangio/tutor/blob/13c420cb0a722b90bf7bb7984a3ee44eb150114d/tutor/templates/build/openedx/Dockerfile#L41-L43

Changes

  • Added a troubleshooting guide for the issue thrown by git while cloning large repositories on slow/unstable networks.
  • Since this issue is subjective to every users network connection, I have instead just added a troubleshooting guide to reduce resources in the buildkit which does fix the issue.

This error has been reported by multiple users, for example here and here. I myself have faced this as well. The max I could try it out was on a 25 Mb/s wired connection and it still threw the error.

Danyal-Faheem avatar Feb 27 '24 10:02 Danyal-Faheem