From 92d12f49bbab059da548338dbb199ae0f089df0b Mon Sep 17 00:00:00 2001 From: <> Date: Sun, 14 Jan 2024 13:16:06 +0000 Subject: [PATCH] Deployed 97f8f5170 with MkDocs version: 1.5.3 --- images/docker-lychee/index.html | 8 ++++---- search/search_index.json | 2 +- sitemap.xml.gz | Bin 1867 -> 1867 bytes 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/images/docker-lychee/index.html b/images/docker-lychee/index.html index 8deeeef549..9b854b5f2c 100644 --- a/images/docker-lychee/index.html +++ b/images/docker-lychee/index.html @@ -17,7 +17,7 @@ - DB_DATABASE= - APP_NAME=Lychee #optional - APP_URL= #optional - - APP_FORCE_HTTPS= #optional + - TRUSTED_PROXIES= #optional volumes: - /path/to/lychee/config:/config - /path/to/pictures:/pictures @@ -37,13 +37,13 @@ -e DB_DATABASE= \ -e APP_NAME=Lychee `#optional` \ -e APP_URL= `#optional` \ - -e APP_FORCE_HTTPS= `#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 <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.

Ports (-p)

Parameter Function
80 http gui

Environment Variables (-e)

Env Function
PUID=1000 for UserID - see below for explanation
PGID=1000 for GroupID - see below for explanation
TZ=Etc/UTC specify a timezone to use, see this list.
DB_CONNECTION= DB type, from sqlite, mysql, pqsql.
DB_HOST= DB server hostname. For mysql and pgsql only.
DB_PORT= DB server port. For mysql and pgsql only.
DB_USERNAME= DB user. For mysql and pgsql only.
DB_PASSWORD= DB password. For mysql and pgsql only.
DB_DATABASE= Path to DB file for sqlite. DB name for mysql and pgsql.
APP_NAME=Lychee The gallery name.
APP_URL= The URL you will use to access Lychee including protocol, and port where appropriate.
APP_FORCE_HTTPS= Set to true if running behind an https reverse proxy.

Volume Mappings (-v)

Volume Function
/config Persistent config files.
/pictures Where lychee will store uploaded images.

Miscellaneous Options

Parameter Function

Environment variables from files (Docker secrets)

You can set any environment variable from a file by using a special prepend FILE__.

As an example:

-e FILE__MYVAR=/run/secrets/mysecretvariable
+

Parameters

Containers 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.

Ports (-p)

Parameter Function
80 http gui

Environment Variables (-e)

Env Function
PUID=1000 for UserID - see below for explanation
PGID=1000 for GroupID - see below for explanation
TZ=Etc/UTC specify a timezone to use, see this list.
DB_CONNECTION= DB type, from sqlite, mysql, pqsql.
DB_HOST= DB server hostname. For mysql and pgsql only.
DB_PORT= DB server port. For mysql and pgsql only.
DB_USERNAME= DB user. For mysql and pgsql only.
DB_PASSWORD= DB password. For mysql and pgsql only.
DB_DATABASE= Path to DB file for sqlite. DB name for mysql and pgsql.
APP_NAME=Lychee The gallery name.
APP_URL= The URL you will use to access Lychee including protocol, and port where appropriate.
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`).

Volume Mappings (-v)

Volume Function
/config Persistent config files.
/pictures Where lychee will store uploaded images.

Miscellaneous Options

Parameter Function

Environment variables from files (Docker secrets)

You can set any environment variable from a file by using a special prepend FILE__.

As an example:

-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 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:

id your_user

Example output:

uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)

Docker Mods

Docker Mods Docker Universal Mods

We publish various 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