Deployment Guide

Loading the Service

Packet Viewer Service is currently distributed as a tar archive containing a Docker image. To load the image, run:

docker load < packet-viewer-v1.1.0.tar.gz

This command will load the packet-viewer:v1.1.0 image.

Running the service

To quickly start the container and check if it is working, run the following command:

docker run --rm -p 4443:443 -v /my-captures:/data/captures packet-viewer:v1.1.0

Open your web browser and navigate to https://localhost:4443/api/health. Accept the self-signed certificate. This should return the following JSON:

{"healthy":true}

Running behind a subdirectory

If you need to put the built-in Packet Viewer UI behind a “subdirectory” on the server, such as /pv use the prefix configuration argument set to the URL path you wish. For example, --prefix=”/pv” If you are not using the built-in Packet Viewer UI, you do not need this option, and should use your primary HTTP server’s proxy capabilities instead.

Environment

The docker image exposes an HTTP server on port 80 and an HTTPS server on port 443 that can be accessed using a web browser. By default Packet Viewer will redirect HTTP traffic on port 80 to HTTPS on port 443.

The /data volume mounted in the Docker container can contain PCAP files under the /data/captures directory and optionally profiles under the /data/profiles directory. Instead of using a volume, PCAP files can also be provided by an S3 bucket.