From 851a3918c96ba63c0f5e3c4ccd835abca2a319c1 Mon Sep 17 00:00:00 2001 From: Brian Rogers <6869577+brogers5@users.noreply.github.com> Date: Sat, 23 May 2020 23:25:40 -0400 Subject: [PATCH] Add a note warning of possible undesired line-ending conversion during clone on Windows. --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index c69dc53..4c88d24 100644 --- a/README.md +++ b/README.md @@ -104,6 +104,14 @@ Using the latest stable verison of Docker is always recommended. Support for old # Building the container yourself To build this container, clone the repository and cd into it. +## Note for Windows users: +Your Git for Windows installation may be configured to convert Unix-style line-endings (i.e. `'\n'`) to Windows-style line-endings (i.e. `"\r\n"`) by default. If this is not overridden, images built from your local repository may encounter run-time failures due to line-ending differences between Unix and Windows. + +To avoid this behavior, it is recommended to clone the repository with `core.autocrlf` configured as `input`: +``` +$ git clone -c core.autocrlf=input git://github.com/MarkusMcNugen/docker-qBittorrentvpn.git +``` + ## Build it: ``` $ cd /repo/location/qbittorrentvpn