docs(known-issues): add notes about potential missing libcurl4/3 (#614)

- add requirements information to README
- add requirements information to quick-start-guide
- add known-issues section

Co-authored-by: benoit.lagae <[email protected]>
Co-authored-by: hasezoey <[email protected]>

Author: blagae

README.md

@@ -78,6 +78,8 @@ And one of those (on Linux):
 - having an `/etc/*-release` file that is compliant to the [OS-Release Spec](https://www.freedesktop.org/software/systemd/man/os-release.html) (and does not include `lsb`)
 - manually specify which version & system should be used
 
+On Linux, you will also need `libcurl4` (or `libcurl3` on some older distro versions). This will probably only be an issue on "slim" Docker images.
+
 ### Choose the Correct Package
 
 [Choose the right package for the task](https://nodkz.github.io/mongodb-memory-server/docs/guides/quick-start-guide#choose-the-right-package)

docs/guides/known-issues.md

@@ -21,3 +21,16 @@ Workaround:
 
 - Use a SystemBinary with [`SYSTEM_BINARY`](../api/config-options.md#SYSTEM_BINARY)
 - Do not use AlpineLinux
+
+## libcurl on slim Docker images
+
+Docker images of the "slim" variety often don't have `libcurl` installed, such as [the official "slim" Node.js image](https://hub.docker.com/_/node) or [sitespeed.io node](https://hub.docker.com/r/sitespeedio/node).  
+If you don't install it manually, then `mongodb-memory-server` will not start up in your container, with the following exception message:
+
+> Instance Exited before being ready and without throwing an error!
+
+This can easily be resolved by installing it in your image:
+
+```sh
+apt-get install libcurl4
+```

docs/guides/quick-start-guide.md

@@ -17,6 +17,8 @@ When on Linux, one of the following are required:
 - having an `/etc/*-release` file that is compliant to the [OS-Release Spec](https://www.freedesktop.org/software/systemd/man/os-release.html) (and does not include `lsb`)
 - manually specify which version & system should be used
 
+On Linux, you will also need `libcurl` (or `libcurl3` on some older distro versions). This will probably only be an issue on "slim" Docker images.
+
 ## Choose the right package
 
 There are multiple packages for this project, here are the differences: