Skip to content

Commit

Permalink
Doc: change wrapper-type to scanner-type
Browse files Browse the repository at this point in the history
  • Loading branch information
@nichtsfrei
nichtsfrei committed Apr 8, 2024
1 parent 34016b4 commit bc4e49c
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions rust/openvasd/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ Options:
enable get scans endpoint [env: ENABLE_GET_SCANS=]
--api-key <api-key>
API key that must be set as X-API-KEY header to gain access [env: API_KEY=]
--wrapper-type <ospd,openvas>
--scanner-type <ospd,openvas>
Type of wrapper used to manage scans [env: WRAPPER_TYPE=]
--max-queued-scans <max-queued-scans>
Maximum number of queued scans [env: MAX_QUEUED_SCANS=]
Expand Down Expand Up @@ -195,13 +195,13 @@ If the signature check is enabled, it is also required to set the the `GNUPGHOME
| Feed Check Interval | --feed-check-interval | | feed.check_interval | secs</br>nanos | FEED_CHECK_INTERVAL | Interval to check for feed updates in seconds. Using the config file, it can be set in seconds and nanoseconds | 3600 (seconds) |
| Notus advisories path | --advisories | | notus | advisories_path | NOTUS_ADVISORIES | Path containing the Notus advisories directory | /var/lib/notus/advisories/ |
| Notus products path | --products | | notus | products_path | NOTUS_PRODUCTS | Path containing the Notus products | /var/lib/notus/products/ |
| Redis URL | --redis-url | | storage.redis | url | | Redis url. Either unix:// or redis:// | redis://localhost:6379 |
| Redis URL | --redis-url | | storage.redis | url | REDIS_URL | Redis url. Either unix:// or redis:// | redis://localhost:6379 |
| TLS Certificates | --tls-certs | | tls | certs | TLS_CERTS | Path to server TLS certs file. If none is given, TLS is disabled | |
| TLS Key | --tls-key | | tls | key | TLS_KEY | Path to server TLS key | |
| TLS Client Certificates | --tls-client-certs | | tls | client_certs | TLS_CLIENT_CERTS | Path to client TLS certs enables mTLS | |
| Enable get scans | --enable-get-scans | | endpoints | enable_get_scans | ENABLE_GET_SCANS | Enables GET /scans endpoint | false |
| API key | --api-key | | endpoints | key | API_KEY | API key that must be set as X-API-KEY header to gain access. If none is given, api-key authorization is disabled | |
| Wrapper Type | --wrapper-type | | scanner | type | WRAPPER_TYPE | Type of wrapper used to manage scans, currently only `OSPD` is available | OSPD |
| Scanner Type | --scanner-type | | scanner | type | SCANNER_TYPE | Type of wrapper used to manage scans, currently only `OSPD` is available | OSPD |
| Max queued scans | --max-queued-scans | | scheduler | max_queued_scans | MAX_QUEUED_SCANS | Maximum number of queued scans, omit for no limits | |
| Max running scans | --max-running-scans | | scheduler | max_running_scans | MAX_RUNNING_SCANS | Maximum number of active running scans, omit for no limits | |
| Min free memory | --min-free-mem | | scheduler | min_free_mem | MIN_FREE_MEMORY | Minimum memory that must be available in order to start a scan. If not set, there is no limit. | |
Expand Down

0 comments on commit bc4e49c

Please sign in to comment.