ibehren1/fw-gui repository overview

Tell me how you are using FW-GUI! File a Usage Report⁠

⁠Disclaimer

The FW-GUI project is not affiliated with VyOS in any way. It is a wholly separate project to build a community tool that helps to visually build and manage firewall specific configurations for VyOS firewalls. This project is not owned by VyOS.io, or Sentrium S.L., nor does it seek to appear to be an official project, product or partner of the aforementioned.

FW-GUI is developed and maintained by @ibehren1⁠.
Copyright © 2023-2025 Isaac Behrens. All rights reserved.

⁠FW-GUI for Managing Firewall Rule Configurations on VyOS Firewalls

The web-based FW-GUI allows the user to visually:

• Create and manage group objects
• Create and manage firewall chains
• Create and manage filters of chains
• Create and manage flowtables
• Support for managing multiple firewall configurations
• Create and compare (diff) snapshots of firewall configurations
• Push the created policy configurations to the firewall(s) via SSH connectivity from the web interface
• Import/export a JSON file of the fw-gui configuration for backup and to move between instances of the GUI

(FW-GUI only manages configurations under 'set firewall' in the command line syntax.)

⁠VyOS Release Support

Source code		https://github.com/ibehren1/fw-gui⁠
Working demo		https://fw-gui.com⁠

⁠Docker Compose

(More advanced docker-compose.yml with support for TLS via Nginx Proxy Manager available in the GitHub Readme⁠.

version: '3.7'
services:
  fw-gui:
    image: ibehren1/fw-gui:latest
    container_name: fw-gui
    depends_on:
      - mongodb
    environment:
      - APP_SECRET_KEY='This is the secret key.'
      - DISABLE_REGISTRATION=False
      - SESSION_TIMEOUT=120
      - MONGODB_URI=mongodb
      - BUCKET_NAME=
      - AWS_ACCESS_KEY_ID=
      - AWS_SECRET_ACCESS_KEY=
    ports:
      - 8080:8080/tcp
    restart: unless-stopped
    volumes:
      - data:/opt/fw-gui/data
  mongodb:
    container_name: mongodb
    image: mongo:latest
    restart: always
    volumes:
      - mongo-data:/data/db
      - mongo-config:/data/configdb
volumes:
  data:
  mongo-data:
  mongo-config:

⁠Kubernetes Install via Helm

git clone https://github.com/ibehren1/fw-gui.git
cd fw-gui
helm install fw-gui ./chart/fw-gui-0.1.0.tgz

⁠Breaking Upgrade v1.4.0+

FW-GUI v1.4.0+ uses a separate MongoDB database to store configurations. If you first deployed with a version lower than 1.4.0, you will need to update your deployment to connect to either an external MongoDB database or deploy a second container to host MongoDB. See the GitHub Readme⁠ for specific changes required.

⁠Interface Screenshots