Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/linuxserver/docker-lychee
https://github.com/linuxserver/docker-lychee
hacktoberfest
Last synced: 7 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/linuxserver/docker-lychee
- Owner: linuxserver
- License: gpl-3.0
- Created: 2017-01-28T11:53:00.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-10-26T21:35:23.000Z (18 days ago)
- Last Synced: 2024-10-29T21:06:22.815Z (15 days ago)
- Topics: hacktoberfest
- Language: Dockerfile
- Homepage:
- Size: 468 KB
- Stars: 43
- Watchers: 10
- Forks: 16
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
[](https://linuxserver.io)
[](https://blog.linuxserver.io "all the things you can do with our containers including How-To guides, opinions and much more!")
[](https://discord.gg/YWrKVTn "realtime support / chat with the community and the team.")
[](https://discourse.linuxserver.io "post on our community forum.")
[](https://fleet.linuxserver.io "an online web interface which displays all of our maintained images.")
[](https://github.com/linuxserver "view the source for all of our repositories.")
[](https://opencollective.com/linuxserver "please consider helping us by either donating or contributing to our budget")
The [LinuxServer.io](https://linuxserver.io) team brings you another container release featuring:
* regular and timely application updates
* easy user mappings (PGID, PUID)
* custom base image with s6 overlay
* weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
* regular security updates
Find us at:
* [Blog](https://blog.linuxserver.io) - all the things you can do with our containers including How-To guides, opinions and much more!
* [Discord](https://discord.gg/YWrKVTn) - realtime support / chat with the community and the team.
* [Discourse](https://discourse.linuxserver.io) - post on our community forum.
* [Fleet](https://fleet.linuxserver.io) - an online web interface which displays all of our maintained images.
* [GitHub](https://github.com/linuxserver) - view the source for all of our repositories.
* [Open Collective](https://opencollective.com/linuxserver) - please consider helping us by either donating or contributing to our budget
# [linuxserver/lychee](https://github.com/linuxserver/docker-lychee)
[](https://scarf.sh)
[](https://github.com/linuxserver/docker-lychee)
[](https://github.com/linuxserver/docker-lychee/releases)
[](https://github.com/linuxserver/docker-lychee/packages)
[](https://gitlab.com/linuxserver.io/docker-lychee/container_registry)
[](https://quay.io/repository/linuxserver.io/lychee)
[](https://hub.docker.com/r/linuxserver/lychee)
[](https://hub.docker.com/r/linuxserver/lychee)
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-lychee/job/master/)
[](https://ci-tests.linuxserver.io/linuxserver/lychee/latest/index.html)
[Lychee](https://lycheeorg.github.io/) 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."
[](https://lycheeorg.github.io/)
## Supported Architectures
We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://distribution.github.io/distribution/spec/manifest-v2-2/#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/).
Simply pulling `lscr.io/linuxserver/lychee:latest` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
The architectures supported by this image are:
| Architecture | Available | Tag |
| :----: | :----: | ---- |
| x86-64 | ✅ | amd64-\ |
| arm64 | ✅ | arm64v8-\ |
| armhf | ❌ | |
## Application Setup
**This image will not work with a prefilled `/pictures` mount, Lychee wants total control over this folder**
Setup account via the webui, accessible at http://SERVERIP:PORT
More info at [lychee](https://lycheeorg.github.io/).
### Customization
In certain scenarios, you might need to change the default settings of Lychee. For instance, if you encounter limitations when uploading large files, you can increase this limit.
#### Increasing Upload Limit
The upload limit is defined in the `user.ini` file located in the config directory (`/config`). You can increase this limit by modifying the following values:
```ini
post_max_size = 500M
upload_max_filesize = 500M
```
After making these changes, you'll need to restart the Docker container for the changes to take effect.
**Please note that these changes might have implications on your server's performance, depending on its available resources. Thus, it's recommended to modify these settings with caution.**
## Usage
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
### docker-compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose))
```yaml
---
services:
lychee:
image: lscr.io/linuxserver/lychee:latest
container_name: lychee
environment:
- PUID=1000
- PGID=1000
- TZ=Etc/UTC
- DB_CONNECTION=
- DB_HOST=
- DB_PORT=
- DB_USERNAME=
- DB_PASSWORD=
- DB_DATABASE=
- APP_NAME=Lychee #optional
- APP_URL= #optional
- TRUSTED_PROXIES= #optional
volumes:
- /path/to/lychee/config:/config
- /path/to/pictures:/pictures
ports:
- 80:80
restart: unless-stopped
```
### docker cli ([click here for more info](https://docs.docker.com/engine/reference/commandline/cli/))
```bash
docker run -d \
--name=lychee \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Etc/UTC \
-e DB_CONNECTION= \
-e DB_HOST= \
-e DB_PORT= \
-e DB_USERNAME= \
-e DB_PASSWORD= \
-e DB_DATABASE= \
-e APP_NAME=Lychee `#optional` \
-e APP_URL= `#optional` \
-e TRUSTED_PROXIES= `#optional` \
-p 80:80 \
-v /path/to/lychee/config:/config \
-v /path/to/pictures:/pictures \
--restart unless-stopped \
lscr.io/linuxserver/lychee:latest
```
## Parameters
Containers are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
| Parameter | Function |
| :----: | --- |
| `-p 80` | http gui |
| `-e PUID=1000` | for UserID - see below for explanation |
| `-e PGID=1000` | for GroupID - see below for explanation |
| `-e TZ=Etc/UTC` | specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). |
| `-e DB_CONNECTION=` | DB type, from `sqlite`, `mysql`, `pqsql`. |
| `-e DB_HOST=` | DB server hostname. For `mysql` and `pgsql` only. |
| `-e DB_PORT=` | DB server port. For `mysql` and `pgsql` only. |
| `-e DB_USERNAME=` | DB user. For `mysql` and `pgsql` only. |
| `-e DB_PASSWORD=` | DB password. For `mysql` and `pgsql` only. |
| `-e DB_DATABASE=` | Path to DB file for `sqlite`. DB name for `mysql` and `pgsql`. |
| `-e APP_NAME=Lychee` | The gallery name. |
| `-e APP_URL=` | The URL you will use to access Lychee including protocol, and port where appropriate. |
| `-e TRUSTED_PROXIES=` | Set to the IP or netmask covering your reverse proxy, if running behind one. Set to `*` to trust all IPs (**do not** use `*` if exposed to the internet`). |
| `-v /config` | Persistent config files. |
| `-v /pictures` | Where lychee will store uploaded images. |
## Environment variables from files (Docker secrets)
You can set any environment variable from a file by using a special prepend `FILE__`.
As an example:
```bash
-e FILE__MYVAR=/run/secrets/mysecretvariable
```
Will set the environment variable `MYVAR` based on the contents of the `/run/secrets/mysecretvariable` file.
## Umask for running applications
For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional `-e UMASK=022` setting.
Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up [here](https://en.wikipedia.org/wiki/Umask) before asking for support.
## User / Group Identifiers
When using volumes (`-v` flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user `PUID` and group `PGID`.
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id your_user` as below:
```bash
id your_user
```
Example output:
```text
uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)
```
## Docker Mods
[](https://mods.linuxserver.io/?mod=lychee "view available mods for this container.") [](https://mods.linuxserver.io/?mod=universal "view available universal mods.")
We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.
## Support Info
* Shell access whilst the container is running:
```bash
docker exec -it lychee /bin/bash
```
* To monitor the logs of the container in realtime:
```bash
docker logs -f lychee
```
* Container version number:
```bash
docker inspect -f '{{ index .Config.Labels "build_version" }}' lychee
```
* Image version number:
```bash
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/lychee:latest
```
## Updating Info
Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (noted in the relevant readme.md), we do not recommend or support updating apps inside the container. Please consult the [Application Setup](#application-setup) section above to see if it is recommended for the image.
Below are the instructions for updating containers:
### Via Docker Compose
* Update images:
* All images:
```bash
docker-compose pull
```
* Single image:
```bash
docker-compose pull lychee
```
* Update containers:
* All containers:
```bash
docker-compose up -d
```
* Single container:
```bash
docker-compose up -d lychee
```
* You can also remove the old dangling images:
```bash
docker image prune
```
### Via Docker Run
* Update the image:
```bash
docker pull lscr.io/linuxserver/lychee:latest
```
* Stop the running container:
```bash
docker stop lychee
```
* Delete the container:
```bash
docker rm lychee
```
* Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your `/config` folder and settings will be preserved)
* You can also remove the old dangling images:
```bash
docker image prune
```
### Image Update Notifications - Diun (Docker Image Update Notifier)
>[!TIP]
>We recommend [Diun](https://crazymax.dev/diun/) for update notifications. Other tools that automatically update containers unattended are not recommended or supported.
## Building locally
If you want to make local modifications to these images for development purposes or just to customize the logic:
```bash
git clone https://github.com/linuxserver/docker-lychee.git
cd docker-lychee
docker build \
--no-cache \
--pull \
-t lscr.io/linuxserver/lychee:latest .
```
The ARM variants can be built on x86_64 hardware using `multiarch/qemu-user-static`
```bash
docker run --rm --privileged multiarch/qemu-user-static:register --reset
```
Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64`.
## Versions
* **27.05.24:** - Rebase to Alpine 3.20. Existing users should update their nginx confs to avoid http2 deprecation warnings.
* **18.01.24:** - Add php-sodium.
* **13.01.24:** - Rebase to Alpine 3.19 with php 8.3.
* **27.12.23:** - Update image to support v5.
* **25.12.23:** - Existing users should update: site-confs/default.conf - Cleanup default site conf. Build npm dependencies into image.
* **25.05.23:** - Rebase to Alpine 3.18, deprecate armhf.
* **13.04.23:** - Move ssl.conf include to default.conf.
* **11.01.23:** - Rebasing to alpine 3.17 with php8.1. Restructure nginx configs ([see changes announcement](https://info.linuxserver.io/issues/2022-08-20-nginx-base)). Switch to git clone as builds fail with the release artifact.
* **13.05.21:** - Make readme clearer.
* **18.04.21:** - Add php-intl for v4.3.
* **31.01.21:** - Add jpegoptim.
* **15.01.21:** - Rebase to alpine 3.13, add php7-ctype.
* **10.07.20:** - Upgrade to Lychee v4 and rebased to alpine 3.12.
* **19.12.19:** - Rebasing to alpine 3.11.
* **23.10.19:** - Increase fastcgi timeouts (existing users need to manually update).
* **19.09.19:** - Update project website url.
* **28.06.19:** - Rebasing to alpine 3.10.
* **05.05.19:** - Rebase to alpine 3.9, use new armv7 image format.
* **21.01.18:** - Added ffmpeg for video thumbnail creation, switched to installing zip release instead of source tarball, created small thumbnails folder, switched to dynamic readme.
* **14.01.19:** - Adding pipeline logic and multi arch..
* **04.09.18:** - Rebase to alpine 3.8, switch to LycheeOrg repository.
* **08.01.18:** - Rebase to alpine 3.7.
* **25.05.17:** - Rebase to alpine 3.6.
* **03.05.17:** - Use repo pinning to better solve dependencies, use repo version of php7-imagick.
* **12.02.17:** - Initial Release.