From c0916258448553a958c96ee2f8e15df92855d9e5 Mon Sep 17 00:00:00 2001
From: ArnoStiefvater <arno.stiefvater@greenbone.net>
Date: Wed, 1 Dec 2021 17:02:16 +0100
Subject: [PATCH] Add more information about install paths

---
 INSTALL.md | 28 +++++++++++++++++++++++-----
 1 file changed, 23 insertions(+), 5 deletions(-)

diff --git a/INSTALL.md b/INSTALL.md
index 10cfa2448..1ddbc8e4d 100644
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -73,6 +73,15 @@ Or (if you want to use the default installation path /usr/local):
 
 This only needs to be done once.
 
+Other cmake variables need to be adjusted as well if you want to have all files in CMAKE_INSTALL_PREFIX or in the default installation path `/usr/local`. They can be added to the `cmake` call with `-D<var_name>=<install_prefix><default_value>`.
+
+| Variable               | Default                              |
+| ---------------------- |:-------------------------------------|
+| SYSCONFDIR             |  `/etc`                              |
+| LOCALSTATEDIR          |  `/var`                              |
+| OPENVAS_FEED_LOCK_PATH |  `/var/lib/openvas/feed-update.lock` |
+| OPENVAS_RUN_DIR        |  `/run/ospd`                         |
+
 Thereafter, the following commands are useful:
 
     make                # build the scanner
@@ -114,7 +123,8 @@ Setting up openvas
 Setting up an openvas requires the following steps:
 
 1. (optional) You may decide to change the default scanner preferences
-   by setting them in the file `$prefix/etc/openvas.conf`. If that file does
+   by setting them in the file `/etc/openvas/openvas.conf` or `<SYSCONFDIR>/openvas/openvas.conf`
+   when `SYSCONFDIR` was set via the `cmake` call. If that file does
    not exist (default), then the default settings are used. You can view
    them with `openvas -s`. The output of that command is a valid configuration
    file. The man page (`man openvas`) provides details about the available
@@ -148,7 +158,7 @@ Setting up an openvas requires the following steps:
    ```bash
    sudo cp config/redis-openvas.conf /etc/redis/
    sudo chown redis:redis /etc/redis/redis-openvas.conf
-   sudo echo "db_address = /run/redis-openvas/redis.sock" > <install-prefix>/etc/openvas/openvas.conf
+   sudo echo "db_address = /run/redis-openvas/redis.sock" > /etc/openvas/openvas.conf # Or append to <SYSCONFDIR>/openvas/openvas.conf when SYSCONFDIR was set via the cmake call.
    sudo systemctl start redis-server@openvas.service
    ```
 
@@ -191,7 +201,11 @@ Logging Configuration
 
 If you encounter problems, by default the scanner writes logs to the file
 
-    <install-prefix>/var/log/gvm/openvas.log
+    /var/log/gvm/openvas.log
+
+When `LOCALSTATEDIR` was set via the `cmake` call the scanner writes logs to the file
+
+    <LOCALSTATEDIR>/log/gvm/openvas.log
 
 It may contain useful information.The exact location of this file may differ
 depending on your distribution and installation method. Please have this file
@@ -199,9 +213,13 @@ ready when contacting the GVM developers via the Greenbone Community Portal
 or submitting bug reports at <https://github.com/greenbone/openvas/issues> as
 they may help to pinpoint the source of your issue.
 
-Logging is configured via the file
+Logging is configured via the file at default location
+
+    /etc/openvas/openvas_log.conf
+
+When `SYSCONFDIR` was set via the `cmake` call the file is located at
 
-    <install-prefix>/etc/openvas/openvas_log.conf
+    <SYSCONFDIR>/openvas/openvas_log.conf
 
 The configuration is divided into domains like this one