DOC: improve readme, separating troubleshooting.

Added also the lists of authors, and adding a troubleshooting.
Libvirt-devel is required

1 files changed, 43 insertions, 0 deletions

diff --git a/doc/TROUBLESHOOTING.md b/doc/TROUBLESHOOTING.md
new file mode 100644
index 00000000..b16b3431
--- /dev/null
+++ b/doc/TROUBLESHOOTING.md
@@ -0,0 +1,43 @@
+# Troubleshooting
+
+## You cannot build from source
+
+You run 
+
+```console
+glide install
+go build 
+```
+And you get:
+
+```console
+Package libvirt was not found in the pkg-config search path.
+Perhaps you should add the directory containing `libvirt.pc'
+to the PKG_CONFIG_PATH environment variable
+No package 'libvirt' found
+pkg-config: exit status 1
+```
+
+You probably need libvirt-dev(el) package installed.
+
+```console 
+apt install libvirt-dev
+```
+
+## Bug in libvirt
+
+* There is a [bug in libvirt](https://bugzilla.redhat.com/show_bug.cgi?id=1293804) that seems to be causing
+  problems to unlink volumes. Tracked [here](https://github.com/dmacvicar/terraform-provider-libvirt/issues/6).
+
+  If you see something like:
+
+  ```console
+  cannot unlink file '/var/lib/libvirt/images/XXXXXXXXXXXX': Permission denied
+  ```
+  It is probably related and fixed in libvirt 1.3.3 (already available in openSUSE Tumbleweed).
+
+## Selinux on Debian distros
+
+* On Debian distros SELinux is enforced by qemu even if it is disabled globally, this might cause unexpected `Could not open '/var/lib/libvirt/images/<FILE_NAME>': Permission denied` errors. Double check that `security_driver = "none"` is uncommented in `/etc/libvirt/qemu.conf` and issue `sudo systemctl restart libvirt-bin` to restart the daemon.
+
+