diff --git a/docs/configuration.md b/docs/configuration.md index b8e8c89e..bdb6f8df 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -274,6 +274,10 @@ storage: The storage option is **required** and defines which storage backend is in use. You must configure one backend; if you configure more, the registry returns an error. +If you are deploying a registry on Windows, be aware that a Windows volume mounted from the host is not recommended. Instead, you can use a S3, or Azure, backing data-store. If you do use a Windows volume, you must ensure that the `PATH` to the mount point is within Window's `MAX_PATH` limits. Failure to do so can result in the following error message: + + mkdir /XXX protocol error and your registry will not function properly. + ### cache Use the `cache` subsection to enable caching of data accessed in the storage