https://github.com/banksio/node-pfsensescripts

https://github.com/banksio/node-pfsensescripts

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/banksio/node-pfsensescripts
• Owner: banksio
• Created: 2020-09-18T23:27:23.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-07-12T22:21:12.000Z (5 months ago)
• Last Synced: 2024-07-13T00:02:03.504Z (5 months ago)
• Language: JavaScript
• Size: 56.6 KB
• Stars: 1
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# node-pfSenseScripts

![GitHub last commit](https://img.shields.io/github/last-commit/banksio/node-pfSenseScripts)

![Docker Build Status](https://img.shields.io/docker/build/banksio/pfsensescripts)

[![Docker Pulls](https://img.shields.io/docker/pulls/banksio/pfsensescripts)](https://hub.docker.com/r/banksio/pfsensescripts)

A node.js app to perform various actions on a pfSense web GUI.

Currently in alpha: There may still be some rough edges, but please feel free to test it and report any bugs found, or new features that may be beneficial!

## Features

* Change the gateway of a Firewall Rule.

## Usage

### Environment Variables

There are a selection of environment variables that are required to be set for this script to work. These are documented below.

You can use a `pfsensescripts.env` file with the docker-compose included in this repository, or just pass them into `docker run` manually.

Variable | Content

------------ | -------------

pfSense_IP | The IP address of the pfSense instance to perform the task on.

pfSense_user | The username to authenticate with the pfSense instance.

pfSense_pass | The password to authenticate with the pfSense instance.

task | The task for the script to perform. 1 for reboot and 2 for rule gateway change.

gatewayText | The text to match to the gateway to switch the Firewall Rule to.

pfSense_if | The interface for which to check the Firewall rules of.

pfSense_RuleDesc | The rule description of the rule to modify.

*Further documentation coming soon.*