{"id":13599612,"url":"https://github.com/pfelk/pfelk","last_synced_at":"2025-04-10T17:31:39.218Z","repository":{"id":37611105,"uuid":"109324539","full_name":"pfelk/pfelk","owner":"pfelk","description":"pfSense/OPNsense + Elastic Stack","archived":false,"fork":false,"pushed_at":"2024-10-20T18:08:40.000Z","size":57781,"stargazers_count":1045,"open_issues_count":6,"forks_count":191,"subscribers_count":39,"default_branch":"main","last_synced_at":"2024-10-20T22:01:54.185Z","etag":null,"topics":["docker","elastic","elasticsearch","firewall","logs","opnsense","pfsense","siem"],"latest_commit_sha":null,"homepage":"https://pfelk.github.io/pfelk/","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pfelk.png","metadata":{"files":{"readme":"README.md","changelog":"changelog","contributing":"CONTRIBUTING.md","funding":null,"license":"license","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-11-02T22:17:00.000Z","updated_at":"2024-10-20T18:08:44.000Z","dependencies_parsed_at":"2023-02-12T19:16:03.941Z","dependency_job_id":"ead61331-96e8-44ba-be3b-a8949252cf9d","html_url":"https://github.com/pfelk/pfelk","commit_stats":{"total_commits":2387,"total_committers":32,"mean_commits":74.59375,"dds":0.0875576036866359,"last_synced_commit":"480d869464368525c6b40d4d5e0393b2d5df5a6f"},"previous_names":[],"tags_count":23,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pfelk%2Fpfelk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pfelk%2Fpfelk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pfelk%2Fpfelk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pfelk%2Fpfelk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pfelk","download_url":"https://codeload.github.com/pfelk/pfelk/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223442572,"owners_count":17145802,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker","elastic","elasticsearch","firewall","logs","opnsense","pfsense","siem"],"created_at":"2024-08-01T17:01:07.739Z","updated_at":"2025-04-10T17:31:39.200Z","avatar_url":"https://github.com/pfelk.png","language":"Shell","funding_links":[],"categories":["Shell"],"sub_categories":[],"readme":"![Version badge](https://img.shields.io/badge/ELK-8.17.0-blue.svg)\n\n[![](https://dcbadge.vercel.app/api/server/h3DJs2Kj8k)](https://discord.gg/h3DJs2Kj8k)\n\n[![YouTube](https://img.shields.io/badge/YouTube-FF0000?style=for-the-badge\u0026logo=youtube\u0026logoColor=white)](https://www.youtube.com/3ilson)\n\n# Elastic Integration\n- https://docs.elastic.co/en/integrations/pfsense\n\n# pfSense/OPNsense + Elastic Stack  \n![pfelk dashboard](https://raw.githubusercontent.com/pfelk/pfelk/main/Images/Dashboard%20-%20v61.gif)\n\n### Contents\n* [Prerequisites](#prerequisites)\n* [Key Features](#key-features)\n* [pfelk overview](#pfelk-overview)\n* [Installation](#installation)\n  * [docker](#docker-compose)\n  * [script installation](#script-installation-method)\n  * [manual installation](#manual-installation-method)\n* [Roadmap](#roadmap)\n* [Comparison to similar solutions](#comparison-to-similar-solutions)\n* [Contributing](#contributing)\n* [License](#license)\n\n### Prerequisites\n- Ubuntu Server v20.04+ or Debian Server 11+ (stretch and buster tested)\n- pfSense v2.5.0+ or OPNsense 23.0+\n- Minimum of 8GB of RAM (Docker requires more) and recommend 32GB ([WiKi Reference](https://github.com/pfelk/pfelk/wiki/How-To:-Performance))\n- Setting up remote logging ([WiKi Reference](https://github.com/pfelk/pfelk/wiki/How-To:-Prerequisite-%7C--pfSense-OPNsense-Logging))\n\n**pfelk** is a highly customizable **open-source** tool for ingesting and visualizing your firewall traffic with the full power of Elasticsearch, Logstash and Kibana.\n\n### Key features:\n\n- **ingest** and **enrich** your pfSense/OPNsense **firewall traffic** logs by leveraging *Logstash*\n\n- **search** your indexed data in *near-real-time* with the full power of the *Elasticsearch*\n\n- **visualize** you network traffic with interactive dashboards, Maps, graphs in *Kibana*\n\nSupported entries include:\n - pfSense/OPNSense setups\n - TCP/UDP/ICMP protocols\n - KEA-DHCP (v4/v6) message types with dashboard - in development \n - DHCP (v4/v6) message types with dashboard - depreciated\n - IPv4/IPv6 mapping\n - pfSense CARP data\n - openVPN with dashboard\n - Unbound DNS Resolver with dashboard and Kibana SIEM compliance\n - Suricata IDS with dashboard and Kibana SIEM compliance\n - Snort IDS with dashboard and Kibana SIEM compliance \n - Squid with dashboard and Kibana SIEM compliance\n - HAProxy with dashboard\n - Captive Portal with dashboard\n - NGINX with dashboard\n\n**pfelk** aims to replace the vanilla pfSense/OPNsense web UI with extended search and visualization features. You can deploy this solution via **ansible-playbook**, **docker-compose**, **bash script**, or manually.\n\n### pfelk overview\n* ![pfelk-overview](https://github.com/pfelk/pfelk/raw/main/Images/pfelk-visual.png)\n\n### Quick start\n\n### Installation\n\n#### docker-compose\n * [Manual Method](https://github.com/pfelk/pfelk/blob/main/install/docker.md) or [Scripted Installed](#) - Scripted Method Coming Soon\n * `$ docker-compose up`\n * [![YouTube](https://img.shields.io/badge/YouTube-FF0000?style=for-the-badge\u0026logo=youtube\u0026logoColor=white)](https://www.youtube.com/watch?v=MJVbLvdVtyY) Guide (Update Coming Soon\n\n#### script installation method\n* Download installer script from [pfelk](https://raw.githubusercontent.com/pfelk/pfelk/main/etc/pfelk/scripts/pfelk-installer.sh) repository\n* `$ wget https://raw.githubusercontent.com/pfelk/pfelk/main/etc/pfelk/scripts/pfelk-installer.sh`\n* Make script executable \n* `$ chmod +x pfelk-installer.sh`\n* Run installer script \n* `$ sudo ./pfelk-installer.sh`\n* Configure Security [here](https://github.com/pfelk/pfelk/blob/main/install/security.md)\n* Templates [here](https://github.com/pfelk/pfelk/blob/main/install/templates.md)\n* Finish Configuring [here](https://github.com/pfelk/pfelk/blob/main/install/configuration.md)\n* [![YouTube](https://img.shields.io/badge/YouTube-FF0000?style=for-the-badge\u0026logo=youtube\u0026logoColor=white)](https://www.youtube.com/watch?v=qcGcsQQoPo0) Guide\n\n#### manual installation method\n* [Ubuntu 20.04-22.04](https://github.com/pfelk/pfelk/blob/main/install/preparation.md)\n* [Debian 11-12](https://github.com/pfelk/pfelk/blob/main/install/preparation.md)\n* [Docker](https://github.com/pfelk/pfelk/blob/main/install/docker.md)\n* [![YouTube](https://img.shields.io/badge/YouTube-FF0000?style=for-the-badge\u0026logo=youtube\u0026logoColor=white)](https://www.youtube.com/watch?v=_IJAAUqNVRc) Guide\n\n### Roadmap\nThis is the experimental public roadmap for the pfelk project.\n\n[See the roadmap »](https://github.com/orgs/pfelk/projects/11)\n\n### Comparison to similar solutions\n[Comparisions »](https://github.com/pfelk/pfelk/wiki/Comparison)\n\n### Contributing\nPlease reference to the [CONTRIBUTING file](https://github.com/pfelk/pfelk/blob/main/CONTRIBUTING.md). Collectively we can enhance and improve this product. Issues, feature requests, PRs, and documentation contributions are encouraged and welcomed!\n\n### License\nThis project is licensed under the terms of the Apache 2.0 open source license. Please refer to [LICENSE](https://github.com/pfelk/pfelk/blob/main/license) for the full terms.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpfelk%2Fpfelk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpfelk%2Fpfelk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpfelk%2Fpfelk/lists"}