User Tools

Site Tools


installing_lucy_on_linux

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
installing_lucy_on_linux [2018/10/10 02:17] – [Installation tutorial] lucyinstalling_lucy_on_linux [2022/06/22 12:37] (current) lucysecurity
Line 23: Line 23:
  
 The shell script will check if your system has already docker installed. If not, it will guide you through the installation process and install all necessary components automatically. The shell script will check if your system has already docker installed. If not, it will guide you through the installation process and install all necessary components automatically.
- 
-===== Can LUCY be installed on older Linux Kernel Version (< 3.10)? ===== 
- 
-The older versions of the linux setup script (< 2.8) have been tested on Debian 7 (Wheezy), Debian 8 (Jessie), Ubuntu 12.04 and Ubuntu 14.04. As an additional requirement, you need to have openssl installed. A 3.10 Linux kernel is the minimum requirement for Docker. Kernels older than 3.10 lack some of the features required to run Docker containers. In case you use an older Linux Kernel you will need to install LUCY on Debian 7 or Ubuntu 12. 
  
  
Line 34: Line 30:
   * **Make sure you use an updated list of repositories**: Get the latest list by typing "apt-get update" (apt-get update downloads the package lists from the repositories and "updates" them to get information on the newest versions of packages).    * **Make sure you use an updated list of repositories**: Get the latest list by typing "apt-get update" (apt-get update downloads the package lists from the repositories and "updates" them to get information on the newest versions of packages). 
   * **Make sure you have the latest PEM files**: Run "apt-get install ca-certificates". This package includes PEM files of CA certificates to allow SSL-based applications to check for the authenticity of SSL connection.   * **Make sure you have the latest PEM files**: Run "apt-get install ca-certificates". This package includes PEM files of CA certificates to allow SSL-based applications to check for the authenticity of SSL connection.
-  * **Make sure you have enough disk space in your temp drive**: Free some space by using "umount /tmp" in case there is not enough space. In general the LUCY installation requires at least 30 GB HD. Other hardware requirements are described [[hardware|here]].+  * **Make sure you have enough disk space in your temp drive**: Free some space by using "umount /tmp" in case there is not enough space. In generalthe LUCY installation requires at least 100 GB HDD. Other hardware requirements are described [[hardware|here]].
  
  
Line 49: Line 45:
   * openssl   * openssl
   * ca-certificates   * ca-certificates
 +  * net-tools
  
  
 ===== What are the hardware/Disk requirements? ===== ===== What are the hardware/Disk requirements? =====
  
-  * TMP: You will need at least GB Space in the tmp directory. Please unmounts your tmp in case you need to free some space there (example: "umount /tmp")+  * TMP: You will need at least GB Space in the tmp directory. Please unmount your tmp in case you need to free some space there (example: "umount /tmp")
   * Other hardware requirements can be found [[hardware|here]]   * Other hardware requirements can be found [[hardware|here]]
  
Line 59: Line 56:
 ===== Installation tutorial ===== ===== Installation tutorial =====
  
-1) First of all, download the file that you are going to execute e.g. "install.sh" from our download location (usually under http://phishing-server.comand save it in your directory. If your using a terminal you first need to enumerate the current download link by pressing F12 in your browser when visiting our download section and then use **wget** to download the file (example: "wget http://download.phishing-server.com/dl/lucy-latest/install.sh"\\+**Important notice:** 
 +If you use a Red Hat Linux, before running the LUCY installation script, please deploy Docker manually.\\ 
 +[[https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux_atomic_host/7/html-single/getting_started_with_containers/index#getting_docker_in_rhel_7|This]] article is pretty handy for instances without active subscriptions. 
 + 
 + 
 +1) First of all, download the file that you are going to execute e.g. "install.sh" from our download [[https://lucysecurity.com/download/|location]] and save it in your directory. If you are using a terminal you first need to enumerate the current download link by pressing F12 in your browser when visiting our download section and then use **wget** to download the file (example: "wget https://download.phishing-server.com/dl/lucy-latest/install.sh"\\
 2) Secondly, open the Terminal from Menu "Accessories \ Terminal".\\ 2) Secondly, open the Terminal from Menu "Accessories \ Terminal".\\
 3) Now type cd to the directory where you downloaded the file.\\ 3) Now type cd to the directory where you downloaded the file.\\
 4) Then type chmod +x name_of_file.sh to make your file executable (example "**chmod +x install.sh**").\\ 4) Then type chmod +x name_of_file.sh to make your file executable (example "**chmod +x install.sh**").\\
-5) Now type ./name_of_file.sh to execute the file (Example "**./install.sh**"). If you are able to install LUCY without docker (this is the preferred method), please use the "./install.sh legacy" command.\\ +5) Now type ./name_of_file.sh to execute the file (Example "**./install.sh**"). If you are able to install LUCY without docker (this is the preferred method for Ubuntu 20.04 only), please use the **"./install.sh legacy"** command.\\ 
-6) You will be asked if you want to install LUCY (Install LUCY (y/n)?) Please type "**y**" and press enter. During the installation LUCY will connect to our centralized custom repository to download the necessary packages.\\+6) You will be asked if you want to install LUCY (Install LUCY (y/n)?) Please type "**y**" and press enter. During the installationLUCY will connect to our centralized custom repository to download the necessary packages.\\
 7) As soon as the installation is finished, the [[setup_script_tutorial|automatic setup script]] should start. 7) As soon as the installation is finished, the [[setup_script_tutorial|automatic setup script]] should start.
  
Line 106: Line 108:
  
 ===== Uninstall LUCY ===== ===== Uninstall LUCY =====
-In 3.2 we will provide an uninstaller. For now if you want to remove LUCY you first need to get a list of all packages installed using $awk '/^Selecting/ {gsub(/\./,""); print $5}' /var/log/apt/term.log (which displays installed packages in historical order, and then purges the last packages). That list will enable you to remove the according packages. 
  
 +If you want to remove LUCY you first need to get a list of all packages installed using the command (which displays installed packages in historical order, and then purges the last packages):
 +<code>
 +awk '/^Selecting/ {gsub(/\./,""); print $5}' /var/log/apt/term.log
 +</code>
  
 +That list will enable you to remove the according packages. This method works for legacy installation method only.
  
 +For Docker-based installation you simply need to stop the container and remove it:
 +
 +<code>
 +docker stop lucy
 +docker ps -a
 +docker container rm <CONTAINER ID>
 +</code>
 ====== Frequently asked questions (FAQ) ====== ====== Frequently asked questions (FAQ) ======
 ===== Which components are installed with the installer script? What modifications are made to Linux OS by the installer? ===== ===== Which components are installed with the installer script? What modifications are made to Linux OS by the installer? =====
 When Lucy is installed as a docker image, it gets downloaded from https://hub.docker.com (you can search for Lucysecurity there) to internal docker storage that is managed by docker itself – as any other usual docker image. Usually it’s **/var/lib/docker/**. After that the installer launches the image with specific parameters, extracts a management script (that launches Lucy’s console setup tool) to **/tmp/files**, moves it to **/usr/bin/lucy-setup.sh** and removes the **/tmp/files** folder. These are all changes that the docker-based installer does, all other software and files are within the container. When Lucy is installed as a docker image, it gets downloaded from https://hub.docker.com (you can search for Lucysecurity there) to internal docker storage that is managed by docker itself – as any other usual docker image. Usually it’s **/var/lib/docker/**. After that the installer launches the image with specific parameters, extracts a management script (that launches Lucy’s console setup tool) to **/tmp/files**, moves it to **/usr/bin/lucy-setup.sh** and removes the **/tmp/files** folder. These are all changes that the docker-based installer does, all other software and files are within the container.
  
-When installing Lucy in a "legacy" way (which is possible only for Debians, as the installer requires some Debian-specific packages and software versions), the installer adds around 500 new packages, does very deep system changes, including configuring the login shell, changing other services (postfix, apache, etc).+When installing Lucy in a "legacy" way (which is possible only for Ubuntu 20.04, as the installer requires some Ubuntu-specific packages and software versions), the installer adds around 500 new packages, does very deep system changes, including configuring the login shell, changing other services (postfix, apache, etc)
 + 
 +In case if you use Red Hat, please look at the important notice in the Installation tutorial section.
  
 +===== What if I ran the install.sh on Red Hat without manually installing Docker? =====
 +Our installation script actually does not deploy Docker itself. 
 +It pulls Docker Installation script from https://get.docker.com/
 +For some reason, Docker installation script adds a repo which is not operational. 
 +To remove the repo, simply run the command below: \\
 +//yum-config-manager --disable docker-ce-stable//
  
 ===== The installer checks if docker is installed and installs it from the official docker website. Are there any downsides of having docker engine pre-installed? ===== ===== The installer checks if docker is installed and installs it from the official docker website. Are there any downsides of having docker engine pre-installed? =====
Line 123: Line 144:
 ===== Who patches the Docker Runtime and host Linux system when security vulnerabilities become known? ===== ===== Who patches the Docker Runtime and host Linux system when security vulnerabilities become known? =====
 When using a Docker-based installation, the Docker engine and all packages on the host are managed by the host package management system – be it RHEL package management or Debian/Ubuntu APT. Lucy’s docker container has no access to outer system and therefore cannot install any updates there. When using a Docker-based installation, the Docker engine and all packages on the host are managed by the host package management system – be it RHEL package management or Debian/Ubuntu APT. Lucy’s docker container has no access to outer system and therefore cannot install any updates there.
-When using a "legacy" installation, all software packages are updated along with Lucy updates using Lucy'Debian mirrors.+When using a "legacy" installation, all software packages are updated along with Lucy updates using Lucy'Ubuntu mirrors.
  
  
Line 130: Line 151:
  
  
-===== Is the container included in the installer payload or is the container loaded via docker pull? ===== +===== Is the docker-image included in the installer payload or is the docker-image loaded via docker pull? ===== 
-Lucy'container is downloaded from https://hub.docker.com (official Docker Hub) during installation.+Lucy'docker-image gets downloaded from https://hub.docker.com (official Docker Hub) during installation.
  
  
Line 140: Line 161:
  
 ===== How do you back up Lucy? ===== ===== How do you back up Lucy? =====
-Speaking of Docker container installation, the backup is seamless and is a peace of cake. First of all you "commit" the container, making a static image of it with all files, changes, etc: +Speaking of Docker container installation, the backup is seamless and is a piece of cake. First of all you "commit" the container, making a static image of it with all files, changes, etc: 
 **docker commit lucy lucy-backup** **docker commit lucy lucy-backup**
 After that you: After that you:
installing_lucy_on_linux.1539130624.txt.gz · Last modified: 2019/07/25 12:51 (external edit)