Skip to content

Commit

Permalink
🎉 advance docs to use python-gvm
Browse files Browse the repository at this point in the history
  • Loading branch information
manuel-sommer committed Nov 15, 2024
1 parent f5e850a commit 3195d4f
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 1 deletion.
2 changes: 1 addition & 1 deletion src/22.4/container/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ and their services in detail.
|-----------|---------|-------------|
| redis-server | [Redis Server](https://redis.io/) | A redis server with an adjusted config. Used to store VT data and scan results by the scanner. |
| pg-gvm | [postgresql](https://www.postgresql.org/) | A PostgreSQL database cluster setup for use with {term}`gvmd`. The actual data is stored in the `psql_data_vol` volume. |
| gvmd | gvmd | A container for {term}`gvmd` that uses unix sockets in volumes to communicate with the PostgreSQL database and ospd-openvas scanner. The downloaded feed data is stored in the `gvmd_data_vol` volume. To verify the feed data, the GPG keyring from the `gpg_data_vol` is used. |
| gvmd | gvmd | A container for {term}`gvmd` that uses unix sockets in volumes to communicate with the PostgreSQL database and ospd-openvas scanner. The downloaded feed data is stored in the `gvmd_data_vol` volume. To verify the feed data, the GPG keyring from the `gpg_data_vol` is used. <br> You can enable port 9390 and use [python-gvm](https://pypi.org/project/python-gvm/) to control Greenbone Community Edition installations and Greenbone Enterprise Appliances remotely. Note: Please rotate the credential set and don't hardcode them.|
| gsa | gsad | A container running the {term}`gsad` web server for providing the web application {term}`GSA`. The web interface is available at localhost on port 9392. For communication with gvmd, a unix socket in a volume is used. |
| ospd-openvas | ospd-openvas | A container providing the vulnerability scanner. The VT data from the feed is stored in the `vt_data_vol` volume. To verify the feed data, the GPG keyring from the `gpg_data_vol` is used. The connection to the redis server is established via a unix socket in a volume. |
| gvm-tools | | A container providing the [gvm-tools](https://github.com/greenbone/gvm-tools/) CLI to query and control gvmd and ospd-openvas. |
Expand Down
13 changes: 13 additions & 0 deletions src/_static/docker-compose-22.4.yml
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,19 @@ services:
gvmd:
image: registry.community.greenbone.net/community/gvmd:stable
restart: on-failure
# enable port 9390 and use the official python python-gvm library to control Greenbone Community Edition installations and Greenbone Enterprise Appliances remotely
# environment:
# USER: admin
# PASSWORD: admin
# GVMD_ARGS: --port=9390 --listen=0.0.0.0
# ports:
# - 9390:9390
# command: >
# /bin/bash -c "
# gvm-manage-certs -V ||
# gvm-manage-certs -a -C;
# /usr/local/bin/start-gvmd
# "
volumes:
- gvmd_data_vol:/var/lib/gvm
- scap_data_vol:/var/lib/gvm/scap-data/
Expand Down

0 comments on commit 3195d4f

Please sign in to comment.