System Administration

This document assumes that the root folder for VulnIQ installation is /vulniq which is the default folder.
/vulniq folder contains the following directories:
  • backend
    • bin : Application binaries. You must use run.sh to run the backend process as it sets many environment variables before running the process.
    • logs : Application logs.
  • database-folder
    • etc-mysql-mariadb.conf.d : Configuration files. Used only when mariadb is running as a docker container.
    • var-lib-mysql : Database files.
    • var-log-mysql : Mariadb logs.
  • devops : Docker configurations and run scripts.
  • elastic-data-folder : Elasticsearch folder.
    • config : Elasticsearch configuration.
    • data : Elasticsearch data files.
    • logs : Elasticsearch logs.
  • permanent-storage-folder : VulnIQ files will be stored in this folder. Make sure that this folder is writable by the backend process. Do NOT manually change/modify any files/folders.
  • temp-files-folder : Temporary files. Temporary files should be cleaned up by the backend process but you can delete any remaining files folders from this folder, if they have not been modified in the last few hours.
  • webapp
    • document-root
    • php-lib
    • logs

Monitoring

Logs
Backend Logs
Backend logs can be found in /vulniq/backend/logs folder. Files in this folder:
  • app.log : Contains mostly debug logs, that are not considered important enough to be included in vulniq.log file. Useful for troubleshooting.
  • gc.log : Java garbage collection logs.
  • vulniq.log : Main backend application logs. Partially in JSON format.
  • vulniq-health.log : Used to log events that require administrative action. You should monitor this file and take action when new entries are added to this file.
Other Logs
  • /vulniq/database-folder/var-log-mysql : Mysql logs
  • /vulniq/elastic-data-folder/logs : Elasticsearch logs
  • /vulniq/webapp/logs : Apache and web app logs
  • /var/log/apache2/ : Other Apache logs