Skip to content

Installation Configuration File

Chris King edited this page Jan 7, 2017 · 2 revisions

FiercePhish

Automated Installation Configuration File

Using the Automated Installation Method #1 will create a "~/FiercePhish.config" file. The variables are described in detail below:

Configure file prompt

File contents

  • CONFIGURED (default:false)

This variable must be set to "true" once you are done configuring everything. This will tell the installer that you are ready to continue the installation.

  • VERBOSE (default:false)

If set to "true", this will show you all the commands and output of the commands that are run by the installer. If you are having issues with the installer, set this to "true" and put the output of the installer in a Github issue CONFIGURED=false

  • SSL_ENABLE (default:false)

If set to "true", this will install and enable LetsEncrypt on your FiercePhish instance so you access the website via HTTPS. This is not yet implemented

  • MYSQL_ROOT_PASSWD (default:root_passwd)

Set this to what you would like the root password to be. It is highly recommended you change it from the default. If you already have mysql installed, this must be the current mysql root password.

  • WEBSITE_DOMAIN (default:127.0.0.1)

Set this to the domain name you have purchased. This is used for the Apache configuration steps and is how you will access the FiercePhish web application. If you have not purchased a domain, leave this as "127.0.0.1" (or the publicly facing IP address of the server).

  • EMAIL_DOMAIN (default:localhost)

Set this to the domain name you have purchased (same as WEBSITE_DOMAIN). This is used for Postfix/Dovecot configuration steps and represents the domain name you will be sending email from. If you have not purchased a domain, leave this as "localhost" (even if you plan on spoofing a domain you don't own).

  • ADMIN_USERNAME (default:admin)

Set this to the username of the user you would like created in FiercePhish (for initial access, you can create more users later)

  • ADMIN_EMAIL (default:root@localhost)

Set this to a valid email of the ADMIN_USERNAME user. This will be used for email notifications later.

  • ADMIN_PASSWORD (default:test)

This is the password for the ADMIN_USERNAME account that is created during the installation process

Post-installation cleanup

After the install script finishes, "~/FiercePhish.config" will be automatically deleted. If you plan to save this configuration file for quick use in the future, make sure you copy it to a different location before running the installation script.