Lychee#

Lychee Lightweight, self-hosted, easy-to-use photo management

amd64
arm64
armv7

Information#

Docker Image: https://hub.docker.com/r/lycheeorg/lychee
Current Image Version: v4.2.1

SETUP#

Enabling lychee#

Command:#

vlab set lychee.enable True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

lychee
enable: True

Finalising changes:#

run: vlab update_one service=lychee

FIRST RUN#

COMPLETING INSTANCE SETUP#

On first run, an input box should appear, asking for a username and password. This will create the first user, whom is also the instance administrator. Always consider creating a user account, separate from the initial user/ administrator account.

SMTP/ MAIL#

  1. run vlab decrypt to decrypt the vault.yml file
  2. make some changes

SMTP Settings#

smtp:
host:
port:
user:
pass:
from_email:
from_name:
  1. run vlab update_one service=lychee to complete the changes

ACCESS#

lychee (HTTPS) link: https://lychee.vivumlab.xyz/ lychee (HTTP) link: http://lychee.vivumlab.xyz/

OPTIONS#

HTTPS_ONLY#

Default: False
Options: True/False

Command:#

vlab set lychee.https_only True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

lychee
https_only: True
Finalising changes:#

run: vlab update_one service=lychee

AUTH#

Default: False
Options: True/False

Command:#

vlab set lychee.auth True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

lychee
auth: True
Finalising changes:#

run: vlab update_one service=lychee

DOMAIN#

Default: False
NOTE: include the sitename and top level domain suffix. eg. name.com, site.net

Command:#

vlab set lychee.domain lychee.com

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

lychee
domain: lychee.com
Finalising changes:#

run: vlab update_one service=lychee

SUBDOMAIN#

Default: lychee
NOTE: Periods/ delimiters are not required. eg. 'media' will set the full URL as 'media.vivumlab.xyz'

Command:#

vlab set lychee.subdomain media

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

lychee
subdomain: media
Finalising changes:#

run: vlab update_one service=lychee

VERSION#

Default: v4.2.1
NOTE: Ensure that the version exists

Command:#

vlab set lychee.version 2.7

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

lychee
version: 2.7
Finalising changes:#

run: vlab update_one service=lychee

Need more help?#

Further information regarding services can be found. \ General Information can be found in the documentation. \ Additional assistance can be found on our Contact Us page.