How to: install ezXSS

ezXSS is ez to install. You have multiple options to install ezXSS, either on a already running webserver with Apache / NGINX, or with Docker.

Before installing, make sure you have a few things:

• Server or hosting with PHP 7.1 or up
• Domain name (consider a short one)
• SSL Certificate to test on https websites (consider Cloudflare or Let's Encrypt for a free SSL)

It's best to already have your domain pointed to the web root where you gonna install ezXSS, and a certificate is already present.

Install with Apache

• Clone/download the repository and put the files in the document root (e.g. /var/www/html/)
• Rename .env.example to .env
• Create an empty database and provide your database information in .env
• Visit /manage/install in your browser and setup your account
• Done! That was ez right?

If you have any problems with the panel not showing up make sure you have headers, rewrite and curl modules enabled

• a2enmod rewrite headers
• apt-get install curl php-curl

Also check that .htaccess is also uploaded in your webroot, and AllowOverride All is present in your Apache config, most cases somewhere in /etc/apache2/apache2.conf.

Install with Docker

• Clone/download the repository and cd into it
• Rename .env.example to .env and update it with a secure randomly generated password
• If you want mail alerts, update SMTP info in msmtprc
• run docker-compose build && docker-compose up -d
• Visit /manage/install in your browser and setup your account
• Done! That was ez right?

Make sure you are using docker-compose version 1.26.0 or newer. Visit https://docs.docker.com/compose/install/ for installation instructions.

Install with nginx

• Clone the repository and put the files in the document root
• Setup your config (e.g. /etc/nginx/sites-enabled/default) like the example: nginx-rewrite.conf
• Rename .env.example to .env
• Create an empty database and provide your database information in .env
• Visit /manage/install in your browser and setup your account
• Done! That was ez right?