Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update install.md #985

Merged
merged 1 commit into from
Jan 13, 2022
Merged

Update install.md #985

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 23 additions & 5 deletions INSTALL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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 [email protected]
```

Expand Down Expand Up @@ -191,17 +201,25 @@ 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
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

Expand Down