Installation Prerequisites

Supported Operating System for Docker Installation

LUCY runs on Docker. Docker Engine is supported on Linux, Cloud, Windows, and OS X.

What is Docker?

Docker is a platform that allows developers to automate the deployment of applications inside lightweight, portable, self-sufficient containers. These containers can run on any system that has Docker installed, ensuring that the software works consistently across different environments.

Key Features of Docker:

  • Portability: Docker containers can be run on any machine with Docker installed, making it easy to move Lucy between environments.

  • Isolation: Each Docker container runs in isolation, which means it doesn't interfere with other containers or the host system.

  • Efficiency: Containers share the host system's kernel, making them more lightweight and faster to start compared to traditional virtual machines.

How Lucy Uses Docker

Using Docker, Lucy can be deployed consistently and efficiently across different systems. Here's how Docker is used in the context of Lucy:

  1. Containerization: Lucy is packaged as a Docker container, which includes all the necessary software and dependencies. This ensures that Lucy runs the same way on any system with Docker installed.

  2. Port Management: The installer script ensures that the necessary network ports (25, 80, and 443) are available and not used by other services. These ports, such as handling web traffic and email communications, are essential for Lucy's operations.

  3. Automated Installation: The installer script automates setting up Docker (if it's not already installed) and configuring it to run Lucy. This reduces the complexity of installation and ensures that all necessary steps are followed correctly.

  4. Isolation and Security: Running Lucy in a Docker container isolates it from other applications on the host system. This improves security and reduces the risk of conflicts with other software.

Supported Linux Distributions

  • Ubuntu: 16.04 LTS, 18.04 LTS, 20.04 LTS, 22.04 LTS

  • Debian: 9.x, 10.x (Legacy)

  • Red Hat/CentOS: 7.x, 8.x

Other Operating Systems

Virtualization platforms such as VMware or VirtualBox are compatible with most common operating systems. Users are encouraged to refer to their specific vendor's documentation for detailed compatibility information.

Compatibility with Operating Systems and Platforms:

Docker containers support a wide range of environments, including but not limited to:

  • Amazon EC2

  • Arch Linux

  • CentOS

  • CRUX Linux

  • Fedora

  • FrugalWare

  • Gentoo

  • IBM SoftLayer

  • Install on Joyent Public Cloud

  • Mac OS X

  • Microsoft Azure platform

  • Oracle Linux

  • Rackspace Cloud

  • Red Hat Enterprise Linux

  • openSUSE and SUSE Linux Enterprise

  • Ubuntu

  • Windows

Supported Browsers:

LUCY's phishing and awareness templates are designed to function seamlessly across a wide range of browsers to ensure broad accessibility for users. Here’s a list of supported browsers:

  • Browsers:

    • Chrome (desktop and mobile)

    • Firefox (desktop and mobile)

    • Microsoft Edge (desktop and mobile)

    • Opera (desktop and mobile)

    • Safari (desktop and mobile)


Hardware Requirements

Small Campaigns (up to 2000 recipients)

  • RAM: 8 GB

  • CPU: 4 Core

  • Hard Disk: 100 GB

Medium Campaigns (up to 50,000 recipients)

  • RAM: 16 GB

  • CPU: 8 Core

  • Hard Disk: 300 GB

Large Campaigns (up to 100,000 recipients)

  • RAM: 32 GB

  • CPU: 16 Core

  • Hard Disk: 500 GB

Hardware Recommendations
  • Initial Setup: Ensure that your initial hardware setup meets the minimum requirements for your expected campaign size. It's better to allocate more resources upfront to avoid performance bottlenecks.

  • Storage Planning: Given the potential need for additional templates and the data generated by campaigns, planning for ample storage from the beginning is wise. Consider future expansion when selecting your hard disk size.

  • Use Built-in Tools: Regularly utilize LUCY's performance testing and monitoring tools to keep your system running efficiently. These tools can provide valuable insights into how well your hardware is coping with the demands of your campaigns.

  • Flexible Scaling: If you are hosting your LUCY instance on a VPS, take advantage of the ability to scale your resources as needed. This can be particularly useful for handling peak loads during large campaigns.

VPS Hosting

For users opting for a Virtual Private Server (VPS) hosted by LUCY:

  • Dynamic Resource Scaling. LUCY provides the capability to automatically scale computing resources, including CPU and RAM, to meet the demands of your campaign. This feature ensures optimal performance of campaigns by adjusting resources in real time, eliminating the need for manual adjustments. In case of hardware limitations, users are encouraged to contact the support department for assistance in scaling their Virtual Private Server (VPS).


Outbound Network Communication

Sorted by Type of Action

  • License Server: Downloads updates, templates, and uploads generalized billing stats via HTTPS.

  • Vulnerability Checks: Allows port 80 connection to static.nvd.nist.gov for NIST CVE database. This feature can be disabled.

Sorted by Port & IP

  • Local License Server:

Requires access to update1.phishing-server.com for Lucy version 5 and above - The IP address is dynamic, please create an allow rule for the Domain name. For Lucy version 4.14.2 and below, please allow update.phishing-server.com (162.55.130.83).

  • Function: Lucy Update/License Server/HTTP proxy

  • IP: 162.55.130.83

  • Port: 80/443 (HTTP/HTTPS)

  • Protocol: TCP

  • Linux Repository:

    • IP: 162.55.130.83

    • Port: 80 (HTTP)

    • Protocol: TCP

  • DNS Server:

    • IP: 8.8.8.8 (or any other DNS Server)

    • Port: 53 (DNS)

    • Protocol: UDP

  • NIST CVE Database (Optional):

    • Host: nvd.nist.gov

    • Port: 443 (HTTPS)

    • Protocol: TCP

  • URL Shortening Service (Optional):

    • IP: is.gd, api-ssl.bitly.com

    • Port: 443 (HTTPS)

    • Protocol: TCP

Inbound Network Communication

  • Web Access:

    • Ports: 80 and 443

    • Protocol: TCP

    • Destination: Your LUCY Proxy IP(s)

  • Email Replies:

    • Port: 25 (SMTP)

    • Protocol: TCP

    • Destination: Your LUCY Proxy IP(s)


Malware Simulation Communication

  • Data Collection: Uses HTTP/HTTPS to send collected data to LUCY, compatible with environments using proxy servers.

Last updated