Te-k / phishdetect-node

This is the server component of PhishDetect

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Build Status Go Report Card

PhishDetect Node

This software is part of the PhishDetect project.

This is the server component of PhishDetect, normally referred to as PhishDetect Node. It is what performs the requested analysis of suspicious links and web pages, and that offers a REST API the PhishDetect Browser Extension (as well as other clients) communicates with in order to pull malicious indicators and to push alerts.

Install

In order to run PhishDetect Node you only need to download the phishdetect-node binary from the latest release.

Build

In order to build PhishDetect Node you need Go 1.12+ installed. You can then proceed with:

make deps
make linux

For proper documentation please refer to the Admin Guide.

Docker

To build and run PhishDetect Node in a local Docker container, install Docker and run

docker build -t phishdetect-node .
docker run -it --rm --name phishdetect-container -p 7856:7856 phishdetect-node

To run both PhishDetect Node and MongoDB in containers, use docker-compose:

docker-compose build
docker-compose up

You can then access the node at http://localhost:7856.

License

PhishDetect Node is released under GNU Affero General Public License 3.0 and is copyrighted to Claudio Guarnieri.

The hook icon was created by Alex Fuller from Noun Project.

About

This is the server component of PhishDetect

License:GNU Affero General Public License v3.0


Languages

Language:Go 81.4%Language:HTML 17.7%Language:Makefile 0.6%Language:Dockerfile 0.2%