Skip to content

Latest commit

 

History

History
50 lines (44 loc) · 1.49 KB

Development-Env.md

File metadata and controls

50 lines (44 loc) · 1.49 KB

Setting up a Development Environment for pfSense-pkg-zeek

This is a step-by-step guide to setting up a development environment for working on the pfSense-pkg-zeek package.

For most people, it will be easiest to work in a FreeBSD VM.

Steps to create development environment

  1. Create a FreeBSD VM on your favorite virtualization platform
  2. Install git:
# pkg update && pkg install git
  1. Install zeek (will automatically install all dependencies):
# pkg update && pkg install zeek
  1. Clone repository to disk:
# git clone https://github.com/shadonet/pfSense-pkg-zeek
  1. Make any changes/updates
  2. To make a build of the updated package:
# make DISABLE_VULNERABILITIES=yes package
  1. The output will be a .txz file in the work/pkg/ directory

Steps to test a package

  1. Create a pfSense VM on your favorite virtualization platform
  2. Set the interface IP addresses appropriately
  3. Enable Secure Shell (sshd)
  4. scp the .txz package generated earlier to the pfSense VM:
$ scp pfSense-pkg-zeek-3.0.6.txz root@<pfSense VM IP>:
  1. SSH to the pfSense VM
  2. Drop to a shell (option 8 at the main menu)
  3. (If you haven't already) set FreeBSD: { enabled: yes } in /usr/local/etc/pkg/repos/FreeBSD.conf and /usr/local/share/pfSense/pkg/repos/pfSense-repo.conf
  4. Install zeek:
# pkg update && pkg install -y zeek
  1. Install the package:
# pkg install pfSense-pkg-zeek-3.0.6.txz
  1. Test the new functionality via the web UI of pfSense