Skip to content

LycheeOrg/Lychee.deb

Repository files navigation

Lychee.deb

This repository provides a .deb package for a seamless installation of Lychee with Apache2 and SQLITE.

@LycheeOrg

GitHub Release MIT License Downloads
Website Documentation Changelog Gitter

A great looking and easy-to-use photo-management-system.

Since the 1st of April 2018 this project has moved to it's own Organisation (https://github.com/LycheeOrg) where people are able to submit their fixes to it. We, the Organisation owners, want to thank electerious (Tobias Reich) for the opportunity to make this project live on.

Lychee Lychee

Lychee is a free photo-management tool, which runs on your server or web-space. Installing is a matter of seconds. Upload, manage and share photos like from a native application. Lychee comes with everything you need and all your photos are stored securely. Read more on our website.

Installation

  1. Download the Lychee-<version>-<patch>_amd64.deb file.
  2. sudo apt install Lychee-<version>-<patch>_amd64.deb.

What does this .deb file do ?

This debian installer provides you a setup with the followings:

  • It will install apache2 and libapache2-mod-php8.2 (and apt will download the required dependency).
  • It will serve Lychee on port 8080 (which you can change later in /etc/sites-available/001-lychee-test.conf)
  • It will set up a DB with SQLITE: no MariaDB/MySQL and migrate the database.
  • It will install lychee in /var/www/html/Lychee

What does this .deb file does not do?

We provide a minimal setup but we leave it to the user to securize their installation.

  • It does not enable HTTPS / provide a certificate with let's encrypt.
  • It does not provides you with a domain name associated to Lychee.

⚠️ Uninstall

This .deb file WILL REMOVE ALL INSTALLED FILE. We assume that if you are removing Lychee, it means that you are not happy with it. For this reason, any files in /var/www/html/Lychee will be removed, including uploaded pictures and database.

How to manually build the .deb file ?

In order to build the .deb file run export.sh

Dockerfile & Makefile

This requires a basic docker installation.

.deb files are run as root and can do a lot of damage if mistakes are made. E.g. a chown -R www-data:www-data . at the wrong place can easilly break your full setup.

For this reason, in order to test the deb package there is a Dockerfile which allows to install it from scratch without compromising the safety of your machine.

After creating the .deb use docker build . -t lychee-package --progress plain to build the Docker image.

Run the Docker image with the following command: docker run -d -p 8080:8080 lychee-package
This will expose port 8080 on your laptop and you can verify that Lychee is properly installed.

Alternatively, you can use make build and make run to execute those commands.

Update

It is unclear how updating works. To be explored.

Troubleshooting

Take a look at the Documentation, particularly the FAQ if you have problems. Discovered a bug? Please create an issue here on GitHub! You can also contact us directly on gitter (login with your github account). »

Open Source Community Support

PhpStorm

We would like to thank Jetbrains for supporting us with their Open Source Development - Community Support program.