Maintaining CVEScan Web

This document provides detailed information on how to maintain the CVEScan Web application in a production environment. It covers various aspects such as restarting and stopping services, as well as backing up and restoring the system.

Stopping Services

To stop all services, you can use the following command:

docker compose stop

To stop a specific service, you can use the following command:

docker compose stop <service_name>

Restarting Services

To restart all services, you can use the following command:

docker compose restart

To restart a specific service, you can use the following command:

docker compose restart <service_name>

Service names are defined in the docker-compose.yml file. For example, if you want to restart the NGINX service, you can use the following command (assuming the service name is proxy):

docker compose restart proxy

Updating Services

If the source code of the CVEScan Web application has been updated (e.g., you pulled changes from the repository), or if new images have been published, you will need to rebuild and restart the services to apply the changes.

The update process depends on your deployment approach:

Source Code Based Deployment

If you are using the CVEScan Web source code repository and building images from source, you can update and restart the services using:

docker compose up --build

This command will:

  • Rebuild the images with the new source code.
  • Restart all services with the updated images.

Pre-built Images Deployment

If you are using pre-built images from the registry, follow these steps:

  1. Update the image tag in your .env file to the desired version:

    CVESCAN_IMAGE_TAG=2.0.1 # Change this to the new version tag
    
  2. Pull the latest images from the registry:

    docker compose pull
    
  3. Restart the services with the new images:

    docker compose up -d
    

    The -d flag runs the services in detached mode, allowing them to run in the background.