Skip to content

Installation

DocFirewall can be installed via pip or used as a Docker container.

Prerequisites

  • Python 3.10+
  • ClamAV (Optional, for local antivirus scanning)

Standard Installation

To install DocFirewall locally, use pip.

# Install the package from PyPI
pip install doc-firewall

Virtual Environments

It is highly recommended to use a virtual environment to avoid dependency conflicts. 

python -m venv venv
source venv/bin/activate
pip install doc-firewall

External Dependencies

ClamAV (Optional)

If you plan to use the local Antivirus feature, you need clamscan or clamd installed.

sudo apt-get update
sudo apt-get install clamav clamav-daemon
sudo freshclam

brew install clamav

Docling

DocFirewall uses Docling for deep parsing. It installs its own dependencies (PyTorch, etc.). The installation process usually handles this automatically.

Docker Support

For isolated environments, use the provided Docker image.

# Build the image
docker build -t doc-firewall .

# Run a test scan
docker run --rm -v $(pwd):/app doc-firewall scripts/validate_with_doc_firewall.py