docker-documentation/images/docker-lychee.md

141 wiersze
5.6 KiB
Markdown
Czysty Zwykły widok Historia

2019-03-31 04:43:09 +00:00
# [linuxserver/lychee](https://github.com/linuxserver/docker-lychee)
2019-02-10 05:44:05 +00:00
2019-09-01 04:43:14 +00:00
[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-lychee.svg?style=flat-square&color=E68523)](https://github.com/linuxserver/docker-lychee/releases)
[![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/lychee.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/lychee "Get your own version badge on microbadger.com")
[![MicroBadger Size](https://img.shields.io/microbadger/image-size/linuxserver/lychee.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/lychee "Get your own version badge on microbadger.com")
[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/lychee.svg?style=flat-square&color=E68523)](https://hub.docker.com/r/linuxserver/lychee)
[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/lychee.svg?style=flat-square&color=E68523)](https://hub.docker.com/r/linuxserver/lychee)
[![Build Status](https://ci.linuxserver.io/view/all/job/Docker-Pipeline-Builders/job/docker-lychee/job/master/badge/icon?style=flat-square)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-lychee/job/master/)
2019-03-31 04:43:09 +00:00
[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/lychee/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/lychee/latest/index.html)
2019-02-10 05:44:05 +00:00
[Lychee](https://lychee.electerious.com/) 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.
## Supported Architectures
2019-09-01 04:43:14 +00:00
Our images support multiple architectures such as `x86-64`, `arm64` and `armhf`. We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/).
2019-02-10 05:44:05 +00:00
Simply pulling `linuxserver/lychee` 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 | Tag |
2019-03-31 04:43:09 +00:00
| :----: | --- |
2019-02-10 05:44:05 +00:00
| x86-64 | amd64-latest |
| arm64 | arm64v8-latest |
2019-05-05 15:20:18 +00:00
| armhf | arm32v7-latest |
2019-02-10 05:44:05 +00:00
2019-03-31 04:43:09 +00:00
2019-02-10 05:44:05 +00:00
## Usage
Here are some example snippets to help you get started creating a container from this image.
### docker
2019-03-31 04:43:09 +00:00
```
2019-02-10 05:44:05 +00:00
docker create \
--name=lychee \
2019-03-03 05:43:00 +00:00
-e PUID=1000 \
-e PGID=1000 \
2019-02-10 05:44:05 +00:00
-e TZ=Europe/London \
-p 80:80 \
-v </path/to/appdata/config>:/config \
-v </path/to/pictures>:/pictures \
--restart unless-stopped \
linuxserver/lychee
```
2019-03-31 04:43:09 +00:00
2019-02-10 05:44:05 +00:00
### docker-compose
Compatible with docker-compose v2 schemas.
```yaml
---
version: "2"
services:
lychee:
image: linuxserver/lychee
container_name: lychee
environment:
2019-03-03 05:43:00 +00:00
- PUID=1000
- PGID=1000
2019-02-10 05:44:05 +00:00
- TZ=Europe/London
volumes:
- </path/to/appdata/config>:/config
- </path/to/pictures>:/pictures
ports:
- 80:80
restart: unless-stopped
```
## Parameters
2019-03-31 04:43:09 +00:00
Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `<external>:<internal>` 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.
2019-02-10 05:44:05 +00:00
2019-03-31 04:43:09 +00:00
### Ports (`-p`)
2019-02-10 05:44:05 +00:00
| Parameter | Function |
2019-03-31 04:43:09 +00:00
| :----: | --- |
2019-02-10 05:44:05 +00:00
| `80` | http gui |
2019-03-31 04:43:09 +00:00
### Environment Variables (`-e`)
2019-02-10 05:44:05 +00:00
| Env | Function |
2019-03-31 04:43:09 +00:00
| :----: | --- |
2019-03-03 05:43:00 +00:00
| `PUID=1000` | for UserID - see below for explanation |
| `PGID=1000` | for GroupID - see below for explanation |
2019-02-10 05:44:05 +00:00
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London |
2019-03-31 04:43:09 +00:00
### Volume Mappings (`-v`)
2019-02-10 05:44:05 +00:00
| Volume | Function |
2019-03-31 04:43:09 +00:00
| :----: | --- |
2019-02-10 05:44:05 +00:00
| `/config` | Contains all relevant configuration files. |
| `/pictures` | Where lychee will store uploaded data. |
2019-03-31 04:43:09 +00:00
2019-02-10 05:44:05 +00:00
## User / Group Identifiers
2019-03-31 04:43:09 +00:00
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`.
2019-02-10 05:44:05 +00:00
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
2019-03-03 05:43:00 +00:00
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
2019-02-10 05:44:05 +00:00
2019-03-31 04:43:09 +00:00
```
2019-02-10 05:44:05 +00:00
$ id username
2019-03-03 05:43:00 +00:00
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
2019-02-10 05:44:05 +00:00
```
## Application Setup
2019-03-31 04:43:09 +00:00
Setup mysql/mariadb and account via the webui, accessible at http://SERVERIP:PORT
More info at [lychee](https://lychee.electerious.com/).
2019-02-10 05:44:05 +00:00
## Support Info
2019-09-01 04:43:14 +00:00
* Shell access whilst the container is running:
2019-02-10 05:44:05 +00:00
* `docker exec -it lychee /bin/bash`
2019-09-01 04:43:14 +00:00
* To monitor the logs of the container in realtime:
2019-02-10 05:44:05 +00:00
* `docker logs -f lychee`
2019-09-01 04:43:14 +00:00
* Container version number
2019-02-10 05:44:05 +00:00
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' lychee`
* Image version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/lychee`
## Versions
2019-06-30 19:13:45 +00:00
* **28.06.19:** - Rebasing to alpine 3.10.
2019-05-05 15:20:18 +00:00
* **05.05.19:** - Rebase to alpine 3.9, use new armv7 image format.
2019-02-10 05:44:05 +00:00
* **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.