Installation

All installation methods start with the same preparation step: create a dedicated BIG-IP user for BigIPReport. After that, pick the installation method that best fits where you want to run the report.

On this page

Use Docker for container deployments. It starts both parts of the application for you:

  • The frontend web server.
  • The scheduled data collector.

This avoids most of the manual web server, PowerShell, and scheduler setup required by native Windows or Linux installations.

Installation steps

  1. Clone the repo
  2. Prepare the BigIPs.
  3. Choose an installation method:
    • Docker — recommended for most users.
    • Linux - native PowerShell, web server, and cron.
    • Windows - native PowerShell, IIS, and Task Scheduler.
    • Kubernetes - Helm-based deployment.
  4. Optional: review Additional config for logging, parallelism, pool member state polling, and other bigipreportconfig.xml settings.

Which method should I choose?

Choose Docker if you want the simplest local or small-server deployment. Choose Kubernetes if you already operate applications with Helm and want BigIPReport managed by your cluster. Choose native Linux or Windows when you cannot use containers or need to integrate with an existing web server and scheduler.

Table of contents

This site uses Just the Docs, a documentation theme for Jekyll.