Skip to content

Hosting Lychee on a Raspberry Pi

Hardware Required

  1. Raspberry Pi 4B
  2. power Adapter
  3. LAN Cable

Installing Ubuntu

  • Burn Ubuntu 20.04 using Raspberry Pi Imager on a 16GB Micro SD card

  • Insert the Micro SD Card into RaspBerry Pi, and LAN port into router.

  • Identify the IP address from the router or use an IP scanner to find the IP address.

  • Login to Ubuntu from Terminal using the IP address

    ssh ubuntu@192.168.1.27
    password: ubuntu
  • On the first run, you need to change the password. Remember the new password. The system will automatically log out once the password is changed.
  • Login again with new password
    ssh ubuntu@192.168.1.27
    password: <password>
  • Update OS
    sudo apt update
    sudo apt upgrade
  • Install utilities
    sudo apt install net-tools
    sudo apt  install tree
    sudo apt install unzip
    sudo apt install elinks
  • ffmpeg and imagemagick

These packages are useful to deal with media.

    sudo apt install exif ffmpeg imagemagick

Now the system is ready for further installations.

Setup Web Server

sudo apt install apache2

This installs the apache webserver and also starts the service. you may open [http://192.168.1.27] from the web browser to confirm this. This will display a default page.

We still need to move the document root folder to the storage mounted in /data, which we shall do it later. This is sufficient to proceed further.

To check the status of apache running, run the following

sudo apache2ctl start
sudo apache2ctl status

or

sudo systemctl status apache2.service -l --no-pager

To restart the apache service

    sudo service apache2 restart

Whenever you edit /etc/apache2/apache2.conf, check the syntax by running

sudo apachectl configtest

To list down the modules enabled in apache,

apache2ctl -M

Wireless access point

Now we are going to configure the RPi as an access point, into which we can connect other devices.

Install network-manager and check the status of the network devices using network manager command line interface (nmcli)

    $ sudo apt install network-manager
    $ nmcli d
    DEVICE         TYPE      STATE         CONNECTION
    wlan0          wifi      disconnected  --
    eth0           ethernet  unmanaged     --
    lo             loopback  unmanaged     --
    p2p-dev-wlan0  wifi-p2p  unmanaged     --

We are connected through LAN. We shall create an Access point on wlan0. Run the following command. 1

    $ sudo nmcli con add type wifi ifname wlan0 con-name Hotspot autoconnect yes ssid rpi_internet
    $ sudo nmcli con modify Hotspot 802-11-wireless.mode ap 802-11-wireless.band a ipv4.method shared
    $ sudo nmcli con modify Hotspot wifi-sec.key-mgmt wpa-psk
    $ sudo nmcli con modify Hotspot wifi-sec.psk "veryveryhardpassword1234"
    $ sudo nmcli con up Hotspot
    Connection successfully activated ....

Change the ssid and password as per your preference

Now, we can connect to the new network and browse the internet too. Internet through LAN is shared with the WiFi devices.

The connection file is stored in /etc/NetworkManager/system-connections/Hotspot.nmconnection.

Recommendation: Restart once to confirm that the access point is working After booting, if the Access point is not up, we can enable it either by

sudo nmcli con up Hotspot

or by

UUID=$(grep uuid /etc/NetworkManager/system-connections/Hotspot | cut -d= -f2)
nmcli con up uuid $UUID

DNS

At this point, you should be able to connect to the WiFi network and browse internet. We want to have a intranet that can be accessed with domain name, instead of the IP address. So, we need to work little more on DNS

We need to change the internal IP of the RPi as well the IP it assigned to clients by changing the dhcp settings. 2

Edit the file /etc/NetworkManager/system-connections/Hotspot.nmconnection to include the following line

[ipv4]
dns-search=
method=shared
address1=192.168.125.1/24,192.168.125.1

now restart the network manager

sudo service network-manager restart

you should be able to browse to connect any device, browse the internet. you may also browse to [http://192.168.125.1] and see the apache default page.

Let us name the device as 'ubuntu' by editing /etc/hostname

edit /etc/hosts and add the following3. We may add more subdomains later.

127.0.0.1 www.ubuntu.local
127.0.0.1 photos.ubuntu.local
127.0.0.1 listen.ubuntu.local

The Network manager runs its own dnsmasq, which we need to configure to redirect the traffic to .local domain from the WiFi clients.4 create a file /etc/NetworkManager/dnsmasq-shared.d/hosts.conf and add the following line.

address=/.local/192.168.125.1

Now, you can access from the browser with any of the following, all redirect to the default apachie page.

http://www.ubuntu.local
http://photos.ubuntu.local
http://listen.ubuntu.local

PHP

    sudo apt install php
    sudo apt install composer

To list down the php modules, use the following command.

    php -m

Check if the following modules are present, if not install them using apt.

sudo apt install php7.4-common
sudo apt install php7.4-bcmath
sudo apt install php7.4-gd
sudo apt install php7.4-json
sudo apt install php7.4-mbstring
sudo apt install php-imagick
sudo apt install php7.4-xml

To Test the PHP installation, create a file file /var/www/html/test.php with the following content and browse it through external browser. [http://www.ubuntu.local/test.php]

<?php phpinfo(); ?>

Database

We shall install sqlite3 for data base services. We also need to install its php module.

    sudo apt install sqlite3
    sudo apt install php-sqlite3

Now we have everything to start setting up our services. Remember:

  • LAN is used only for updating the software, and data transfer to and from the RPi
  • The web pages can still be accessed after removing the LAN cable, and connecting to rpi_internet.

the server name is *.ubuntu.local

Storage

Note: Storage is an optional, if you only want to try out and no plan to add many media, you may simply create a folder /data and move to next session.

The Micro SD card we have used is Not sufficient to store all the data. Hence we shall add a new Harddisk of 1TB to manage the data. Note, This procedure is to setup the Hard disk as a new device. If you already have content in the device, make sure you back it up. All the data will be lost in this step.

  • Connect the harddisk into the USB 3.0 port.
  • From the SSH terminal, run the following command to identify the device.
    $ fdisk -l | grep '^Disk'
    ....
    Disk /dev/sda: 931.53 GiB, 1000204883968 bytes, 1953525164 sectors
    Disk model: Hard Drive
    ...

From the list, identify the disk, e.g., /dev/sda

Create Partition

The basic fdisk commands you need are:

  • m – print help
  • p – print the partition table
  • n – create a new partition
  • d – delete a partition
  • q – quit without saving changes
  • w – write the new partition table and exit
  • Run,
    sudo fdisk /dev/sda

Use 'd' to delete older partition if any. Use 'n' to create a new partition. Preferably a single partition. Use 'w' to write into disk. Use 'p' to print and identify the partition. e.g., /dev/sda1

Format the disk

sudo mkfs.ext3 /dev/sda1

This will take sometime to format the disk

Mount

Mounting the harddisk on a folder is done as below.

    $ sudo mkdir /data
    $ sudo mount /dev/sda1 /data
    $ df | grep \/data
    /dev/sda1      960385036   74392 911472568   1% /data
    $ sudo chown -R ubuntu /data # this will give permission to the user 'ubuntu' to read and write

Label the device

    sudo e2label /dev/sda1 data

Add to File System Table (fstab)

Open the file /etc/fstab and add the following line.

    LABEL=data /data ext3 defaults 0 1

This will make sure the device is registered in the file system table and mounted during boot.

Recommendation: Restart once to confirm that the auto mount works

Setting up Lychee

Lychee is a free photo-management tool, which runs on your server. 8 9

Most of the basic requirements like, webserver, php and data base for Lychee is already taken care in [Setup XX.m d Point to correct document]. This document assumes, you have prepared RPi as per the Setup proceedure.

In this section, we shall configure our system ready for Lychee, install Lychee and test it.

Note: The original documentation [https://lycheeorg.github.io/docs/] has all the details, but few things are hidden / burried inside the huge documentation. This page extracts and provide the instructions specific for RPi.

Few important requirements for our installation

  1. We don't overwrite the default webserver running from /var/www/html. Lychee can be assigned a separate server [http://photo.ubuntu.local]. This way, we can add more services into our product.
  2. We need bigger storage as Lychee manages Media, which may not fit into the SD card over the time. So lets fix the folder /data/www/photos/lychee for Lychee
  3. Lychee uses .htaccess file. We need to permit it 10.

Prepare Directories

Apache webserver accesses the data with the user www-data:www-data. Add the current user into www-data group.

$ ll /data
...
drw-rw-r--  2 www-data www-data  4096 Aug  5 07:26 www/
...

If you don't see the permission, owner and group as above, make sure you correct them. The permission can be updated using chmod and the owner and group can be updated using chown.

    sudo chmod -R 664 /data/www
    sudo chown -R ubuntu:www-data /data/www

Note, we have given write permission to both the owner and group

Move yourself to www-data group

$ whoami
ubuntu
$ sudo adduser ubuntu www-data
Adding user 'ubuntu' to group 'www-data' ...
Adding user ubuntu to group www-data
Done.
$ groups ubuntu # make sure it displays www-data
ubuntu : ... www-data ...

Switch group and create /data/www/photos

$ newgrp www-data
$ mkdir -p /data/www/photos
$ ll /data/www
...
drwxrwxr-x 2 ubuntu www-data 4096 Aug  5 07:49 photos/
...

If the permission, owner and group are as above, move ahead.

create a new site pointing to /data/www/photos/lychee/public

cd /etc/apache2/sites-available
cp 000-default.conf 001-lychee.conf

Replace the content of 001-lychee.conf by

<VirtualHost *:80>

 DocumentRoot /data/www/photos/lychee/public
 ServerName photos.ubuntu.local

 <Directory /data/www/photos/lychee/public>
  Options Indexes FollowSymLinks
  AllowOverride All
  Require all granted
 </Directory>

 ErrorLog ${APACHE_LOG_DIR}/photo-error.log
 CustomLog ${APACHE_LOG_DIR}/photo-access.log combined

 RewriteEngine on
 RewriteOptions Inherit
 # RewriteCond %{SERVER_NAME} = photo.ubuntu.local
 # RewriteRule ^ https://%{SERVER_NAME}%{REQUEST_URI} [END,NE,R=permanent]

</VirtualHost>

Enable this site.

sudo a2ensite 001-lychee
sudo systemctl reload apache2

Download the Lychee

cd /data/www/photos
wget https://github.com/LycheeOrg/Lychee/releases/download/v4.3.4/Lychee.zip
unzip Lychee.zip
mv Lychee lychee
cd lychee
composer install --no-dev
cp .env.example .env
vi .env

Change APP_URL to [http://photos.ubuntu.local] and TIMEZONE to Asia/Kolkata in the .env file. Don't change anything else.

php artisan key:generate
php artisan migrate

now handover this folder to the user www-data.

sudo chown -R www-data:www-data .

Start browsing

In the browser, (from the device you have connected to rpi_internet), access [http://photos.ubuntu.local] and follow the instructions to setup and use.

Note, other than 'photos', everything else will be redirected to apache default page.

END OF THE DOCUMENT

Recommendation: You may backup the SD card at this point.

  1. https://gist.github.com/narate/d3f001c97e1c981a59f94cd76f041140#file-create-hotspot-md ↩

  2. https://people.freedesktop.org/~lkundrak/nm-docs/nm-settings.html ↩

  3. https://debian-handbook.info/browse/stable/sect.hostname-name-service.html ↩

  4. https://askubuntu.com/questions/992743/hotspot-with-dnsmasq-to-resolve-local-hosts ↩

  5. https://codeburst.io/configuring-a-subdomain-in-apache2-f7a8b316b42c ↩

  6. https://www.digitalocean.com/community/tutorials/apache-configuration-error-ah00558-could-not-reliably-determine-the-server-s-fully-qualified-domain-name#setting-a-global-servername-directive ↩

  7. https://help.ubuntu.com/community/EnablingUseOfApacheHtaccessFiles ↩

  8. https://lycheeorg.github.io ↩

  9. https://github.com/LycheeOrg/Lychee ↩

  10. https://help.ubuntu.com/community/EnablingUseOfApacheHtaccessFiles ↩