How to Install Lychee with Nginx on Ubuntu 24.04

Install Nginx HTTP server on Ubuntu

Installing Nginx on Ubuntu is the first step to running Lychee. Nginx is a web server that helps your Lychee site be accessible online. You can easily install it using commands in the Ubuntu terminal, and once it’s set up, you can manage it to start, stop, or ensure it runs automatically.

To do that, open the Ubuntu terminal and run the commands below to install the Nginx web server.

sudo apt update
sudo apt install nginx

Once Nginx is installed, the commands below can start, stop, and enable the Nginx web server to start automatically when your server boots up.

sudo systemctl stop nginx
sudo systemctl start nginx
sudo systemctl enable nginx

You can test the Nginx web server by opening your web browser and browsing to the server’s localhost or IP address.

http://localhost

When you see the Welcome to nginx!, it means the Nginx HTTP server is successfully installed.

Additional help on installing Nginx on Ubuntu is in the link below.

How to install Nginx on Ubuntu

Install the MariaDB database server on Ubuntu

Lychee needs a database to store all its photos and information, and MariaDB is a great choice for Ubuntu. Installing the MariaDB database server is simple using commands in the Ubuntu terminal. This sets up the necessary system so Lychee can correctly save and manage its data.

To install and use the MariaDB database server, use the instructions below.

Open the Ubuntu terminal and run the commands below to install the MariaDB database server.

sudo apt update
sudo apt install mariadb-server

Once the MariaDB database server is installed, use the commands below to stop, start, and enable the MariaDB server to start automatically when the server boots.

sudo systemctl stop mariadb
sudo systemctl start mariadb
sudo systemctl enable mariadb

Run the following commands to validate and test if the MariaDB database server is installed successfully.

sudo mariadb

Once you run the commands above, it will log you onto the MariaDB console and display a message similar to the one below.

Welcome to the MariaDB monitor.  Commands end with ; or g.
Your MariaDB connection id is 32
Server version: 10.11.2-MariaDB-1 Ubuntu 23.04

Copyright (c) 2000, 2018, Oracle, MariaDB Corporation Ab and others.

Type 'help;' or 'h' for help. Type 'c' to clear the current input statement.

MariaDB [(none)]> 

The message tells you that the server is installed successfully.

Additional help on installing MariaDB.

• How to install MariaDB on Ubuntu Linux
• MariaDB without password prompt

Create a Lychee database

Once MariaDB is ready, you need to create a dedicated database for Lychee to use. This involves making a database named ‘lycheedb’ and a user called ‘lycheedbuser’. You’ll give this user full control over the ‘lycheedb’ database so Lychee can properly access and manage its data.

As part of the setup, we will create a lycheedb database and a user account called lycheedbuser.

Lychee database permissions will be set so that the `lycheedbuser` has full access to the `lycheedb` database, preventing potential errors during Lychee operation after installation on Ubuntu 24.04.

All the database steps above can be done using the commands below:

But first, log on to the MariaDB database server:

sudo mariadb

Then run the commands below to complete the steps:

CREATE DATABASE lycheedb CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci;
CREATE USER lycheedbuser@localhost IDENTIFIED BY 'type_your_password_here';
GRANT ALL ON lycheedb.* TO lycheedbuser@localhost WITH GRANT OPTION;
FLUSH PRIVILEGES;
exit

Install PHP on Ubuntu Linux

Lychee is built with PHP, so installing PHP and its required extensions on your Ubuntu system is the next crucial step. This ensures Lychee has all the tools it needs to run smoothly and efficiently. You can install the latest PHP version and its necessary extensions using a simple terminal command.

Then, run the commands below to install the latest PHP version.

sudo apt install php-fpm php-intl php-mysql php-curl php-cli php-zip php-xml php-gd php-common php-mbstring php-xmlrpc php-bcmath php-json php-sqlite3 php-soap php-zip

Additional help on installing PHP

How to install PHP on Ubuntu Linux

Download Lychee files

To get Lychee up and running, you must download its main application files onto your server. It’s best to get the latest version directly from the official Lychee download page. After downloading, you’ll unpack these files into the correct folder on your server, often starting in the /tmp/ directory.

To always install the latest version, check the download page for Lychee. Get the download link and download the archived package to your computer. Then, extract it.

First, navigate to the /tmp/ directory and download the Lychee files. Next, extract the content into the Lychee folder in the Nginx root directory.

cd /tmp/
wget https://github.com/LycheeOrg/Lychee/releases/download/v6.2.0/Lychee.zip
sudo unzip Lychee.zip -d /var/www
sudo chown -R www-data:www-data /var/www/Lychee

Next, run the command below to copy the ‘.env‘ file for Lychee and modify it using the ‘nano‘ editor.

sudo -u www-data cp /var/www/Lychee/.env.example /var/www/Lychee/.env
sudo -u www-data nano /var/www/Lychee/.env

Change the default APP_URL to match your domain name and the database info created above.

# Lychee domain URL
APP_URL=https://lychee.example.com

# DB_CONNECTION can be sqlite, mysql or pgsql. For sqlite the other entries are
# *not* be left blank.
DB_CONNECTION=mysql 
DB_HOST=localhost
DB_PORT=3306
DB_DATABASE=lycheedb
DB_USERNAME=lycheedbuser
DB_PASSWORD=type_password_here
DB_LOG_SQL=false
DB_LOG_SQL_EXPLAIN=false #only for MySQL

Save the file and exit the editor.

Once you have completed all the above steps, continue configuring the Nginx web server below to serve the Lychee content.

Run the commands below to create a Nginx virtual host file for Lychee.

sudo nano /etc/nginx/sites-available/lychee.conf

Then, copy and paste the content block below into the Nginx server block.

server {
    listen 80;
    listen [::]:80;
    root /var/www/Lychee/public;
    index  index.php;
    server_name  lychee.example.com;

    access_log /var/log/nginx/example.com.access.log;
    error_log /var/log/nginx/example.com.error.log;

    if (!-e $request_filename)
    {
        rewrite ^/(.*)$ /index.php?/$1 last;
        break;
    }

    location ~ .php$ {
         include snippets/fastcgi-php.conf;
         fastcgi_pass unix:/var/run/php/php8.3-fpm.sock;
         fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
         include fastcgi_params;
    }

    location ~ [^/].php(/|$) {
        return 403;
    }

    rewrite ^/(.+)/$ /$1 permanent;

}

Save the file.

You enable the Lychee virtual host by running the `sudo a2ensite lychee.conf` command. Afterwards, you restart the Nginx server using `sudo systemctl restart nginx` to apply these changes.

sudo ln -s /etc/nginx/sites-available/lychee.conf /etc/nginx/sites-enabled/
sudo systemctl restart nginx

Setup Let’s Encrypt SSL/TLS for Lychee

Securing your Lychee site with an SSL/TLS certificate from Let’s Encrypt is important for protecting visitor data. This encrypts the connection between users and your site. You can follow specific guides for setting up Let’s Encrypt with Nginx on Ubuntu. After this, you’ll restart Nginx to make your Lychee site secure.

Please read the post below for additional resources on installing and creating Let’s Encrypt SSL certificates for Nginx.

How to set up Let’s Encrypt SSL certificate for Nginx on Ubuntu Linux

Once you have restarted the Nginx web server, open your browser and browse to the server hostname or IP address defined in the Nginx server block.

http://lychee.example.com

A Lychee installation wizard page should appear. Click next to continue.

Ensure the information in the .env file is correct. Then, click Install.

Fix any errors and set up an account.

Create an admin account.

Lychee should be installed and ready to use.

That should do it!

Conclusion:

In conclusion, installing the Lychee Photo Management system with Nginx on Ubuntu 24.04 is a straightforward process that can significantly enhance your photo management capabilities. Here are the key takeaways:

• User-Friendly Interface: Lychee provides an intuitive interface for managing and sharing photos.
• Efficient Performance: Nginx is lightweight and can handle multiple connections, making it ideal for hosting photo galleries.
• Database Support: Using MariaDB ensures reliable data storage for your images.
• Secure Setup: Implementing SSL/TLS with Let’s Encrypt adds an essential layer of security to your installation.
• Configurability: The ability to customize settings via the .env file allows for tailored configurations based on your requirements.

With Lychee, Nginx, and Ubuntu 24.04 working together, you enjoy a secure photo gallery environment. Nginx, a web server that handles requests, and Lychee, photo management software, combine to protect your images.