Docs

Installation via installer (GNU/Linux)

Ferron can be installed on GNU/Linux systems using an installer script. This guide will walk you through the installation process.

Installation steps

1. Run the installer

To install Ferron web server, run the following command:

sudo bash -c "$(curl -fsSL https://get.ferron.sh/v2)"

You will be prompted to choose the installation type. You might be also prompted whether to install Ferron using a package manager (if packages are available).

2. Access the web server

By default, Ferron serves content from the /var/www/ferron directory. Open a web browser and navigate to http://localhost to check if the server is running and serving the default index.html file.

If you see a “Ferron is installed successfully!” message on the page, the web server is installed successfully and is up and running.

File structure

Ferron installed via the installer for GNU/Linux has following file structure:

  • /usr/sbin/ferron - Ferron web server
  • /usr/sbin/ferron-passwd - Ferron user password generation tool
  • /usr/sbin/ferron-precompress - Ferron static files precompression tool
  • /usr/sbin/ferron-yaml2kdl - Ferron configuration conversion tool
  • /var/log/ferron/access.log - Ferron access log in Combined Log Format
  • /var/log/ferron/error.log - Ferron error log
  • /var/www/ferron - Ferron’s web root
  • /etc/ferron.kdl - Ferron configuration

Updating Ferron

You can update Ferron to the latest version using the ferron-updater command.

Upgrading from Ferron 1.x to Ferron 2

To upgrade Ferron from 1.x to 2.x, run the following command:

sudo bash -c "$(curl -fsSL https://get.ferron.sh/v1-to-v2)"

Managing the Ferron service

Stopping the service

To stop the Ferron service, run:

sudo /etc/init.d/ferron stop # For non-systemd systems
sudo systemctl stop ferron # For systemd systems

Restarting the service

To restart the service:

sudo /etc/init.d/ferron restart # For non-systemd systems
sudo systemctl restart ferron # For systemd systems

Reloading the configuration

To reload the configuration without restarting the service:

sudo /etc/init.d/ferron reload # For non-systemd systems
sudo systemctl reload ferron # For systemd systems