docker-documentation/images/docker-lychee/index.html

<!doctype html><html lang=en class=no-js> <head><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1"><meta name=description content="Welcome to the home of the LinuxServer.io documentation!"><meta name=author content=LinuxServer.io><link href=https://docs.linuxserver.io/images/docker-lychee/ rel=canonical><link href=../docker-limnoria/ rel=prev><link href=../docker-mariadb/ rel=next><link rel=icon href="https://gblobscdn.gitbook.com/spaces%2F-LWuIse8qFJj2MqDi90T%2Favatar-1590244439115.png?alt=media"><meta name=generator content="mkdocs-1.4.2, mkdocs-material-9.0.5"><title>lychee - LinuxServer.io</title><link rel=stylesheet href=../../assets/stylesheets/main.558e4712.min.css><link rel=stylesheet href=../../assets/stylesheets/palette.2505c338.min.css><link rel=preconnect href=https://fonts.gstatic.com crossorigin><link rel=stylesheet href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback"><style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style><script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script></head> <body dir=ltr data-md-color-scheme=default data-md-color-primary=purple data-md-color-accent=indigo> <script>var palette=__md_get("__palette");if(palette&&"object"==typeof palette.color)for(var key of Object.keys(palette.color))document.body.setAttribute("data-md-color-"+key,palette.color[key])</script> <input class=md-toggle data-md-toggle=drawer type=checkbox id=__drawer autocomplete=off> <input class=md-toggle data-md-toggle=search type=checkbox id=__search autocomplete=off> <label class=md-overlay for=__drawer></label> <div data-md-component=skip> <a href=#linuxserverlychee class=md-skip> Skip to content </a> </div> <div data-md-component=announce> </div> <header class=md-header data-md-component=header> <nav class="md-header__inner md-grid" aria-label=Header> <a href=../.. title=LinuxServer.io class="md-header__button md-logo" aria-label=LinuxServer.io data-md-component=logo> <img src="https://gblobscdn.gitbook.com/spaces%2F-LWuIse8qFJj2MqDi90T%2Favatar-1590244439115.png?alt=media" alt=logo> </a> <label class="md-header__button md-icon" for=__drawer> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg> </label> <div class=md-header__title data-md-component=header-title> <div class=md-header__ellipsis> <div class=md-header__topic> <span class=md-ellipsis> LinuxServer.io </span> </div> <div class=md-header__topic data-md-component=header-topic> <span class=md-ellipsis> lychee </span> </div> </div> </div> <form class=md-header__option data-md-component=palette> <input class=md-option data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme=default data-md-color-primary=purple data-md-color-accent=indigo aria-label="Switch to dark mode" type=radio name=__palette id=__palette_1> <label class="md-header__button md-icon" title="Switch to dark mode" for=__palette_2 hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M17 6H7c-3.31 0-6 2.69-6 6s2.69 6 6 6h10c3.31 0 6-2.69 6-6s-2.69-6-6-6zm0 10H7c-2.21 0-4-1.79-4-4s1.79-4 4-4h10c2.21 0 4 1.79 4 4s-1.79 4-4 4zM7 9c-1.66 0-3 1.34-3 3s1.34 3 3 3 3-1.34 3-3-1.34-3-3-3z"/></svg> </label> <input class=md-option data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme=slate data-md-color-primary=purple data-md-color-accent=indigo aria-label="Switch to light mode" type=radio name=__palette id=__palette_2> <label class="md-header__button md-icon" title="Switch to light mode" for=__palette_1 hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M17 7H7a5 5 0 0 0-5 5 5 5 0 0 0 5 5h10a5 5 0 0 0 5-5 5 5 0 0 0-5-5m0 8a3 3 0 0 1-3-3 3 3 0 0 1 3-3 3 3 0 0 1 3 3 3 3 0 0 1-3 3Z"/></svg> </label> </form> <label class="md-header__button md-icon" for=__search> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg> </label> <div class=md-search data-md-component=search role=dialog> <label class=md-search__overlay for=__search></label> <div class=md-search__inner role=search> <form class=md-search__form name=search> <input type=text class=md-search__input name=query aria-label=Search placeholder=Search autocapitalize=off autocorrect=off autocomplete=off spellcheck=false data-md-component=search-query required> <label class="md-search__icon md-icon" for=__search> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg> </label> <nav class=md-search__options aria-label=Search> <button type=reset class="md-search__icon md-icon" title=Clear aria-label=Clear tabindex=-1> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg> </button> </nav> </form> <div class=md-search__output> <div class=md-search__scrollwrap data-md-scrollfix> <div class=md-search-result data-md-component=search-result> <div class=md-search-result__meta> Initializing search </div> <ol class=md-search-result__list role=presentation></ol> </div> </div> </div> </div> </div> <div class=md-header__source> <a href=https://github.com/linuxserver/docker-documentation title="Go to repository" class=md-source data-md-component=source> <div class="md-source__icon md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 448 512"><!-- Font Awesome Free 6.2.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg> </div> <div class=md-source__repository> linuxserver/docker-documentation </div> </a> </div> </nav> </header> <div class=md-container data-md-component=container> <main class=md-main data-md-component=main> <div class="md-main__inner md-grid"> <div class="md-sidebar md-sidebar--primary" data-md-component=sidebar data-md-type=navigation> <div class=md-sidebar__scrollwrap> <div class=md-sidebar__inner> <nav class="md-nav md-nav--primary" aria-label=Navigation data-md-level=0> <label class=md-nav__title for=__drawer> <a href=../.. title=LinuxServer.io class="md-nav__button md-logo" aria-label=LinuxServer.io data-md-component=logo> <img src="https://gblobscdn.gitbook.com/spaces%2F-LWuIse8qFJj2MqDi90T%2Favatar-1590244439115.png?alt=media" alt=logo> </a> LinuxServer.io </label> <div class=md-nav__source> <a href=https://github.com/linuxserver/docker-documentation title="Go to repository" class=md-source data-md-component=source> <div class="md-source__icon md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 448 512"><!-- Font Awesome Free 6.2.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg> </div> <div class=md-source__repository> linuxserver/docker-documentation </div> </a> </div> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../.. class=md-nav__link> Introduction </a> </li> <li class=md-nav__item> <a href=../../FAQ/ class=md-nav__link> FAQ </a> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " data-md-toggle=__nav_3 type=checkbox id=__nav_3> <label class=md-nav__link for=__nav_3 tabindex=0 aria-expanded=false> General <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav aria-label=General data-md-level=1> <label class=md-nav__title for=__nav_3> <span class="md-nav__icon md-icon"></span> General </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../general/container-execution/ class=md-nav__link> Container Execution </a> </li> <li class=md-nav__item> <a href=../../general/containers-101/ class=md-nav__link> Docker Containers: 101 </a> </li> <li class=md-nav__item> <a href=../../general/running-our-containers/ class=md-nav__link> Running LinuxServer Containers </a> </li> <li class=md-nav__item> <a href=../../general/container-customization/ class=md-nav__link> Customizing LinuxServer Containers </a> </li> <li class=md-nav__item> <a href=../../general/docker-compose/ class=md-nav__link> Docker Compose </a> </li> <li class=md-nav__item> <a href=../../general/understanding-puid-and-pgid/ class=md-nav__link> Understanding PUID and PGID </a> </li> <li class=md-nav__item> <a href=../../general/updating-our-containers/ class=md-nav__link> Updating our containers </a> </li> <li class=md-nav__item> <a href=../../general/volumes/ class=md-nav__link> Volumes </a> </li> <li class=md-nav__item> <a href=../../general/fleet/ class=md-nav__link> Fleet </a> </li> <li class=md-nav__item> <a href=../../general/swag/ class=md-nav__link> SWAG </a> </li> <li class=md-nav__item> <a href=../../general/awesome-lsio/ class=md-nav__link> Awesome LSIO </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--active md-nav__item--nested"> <input class="md-nav__toggle md-toggle " data-md-toggle=__nav_4 type=checkbox id=__nav_4 checked> <label class=md-nav__link for=__nav_4 tabindex=0 aria-expanded=true> Images <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav aria-label=Images data-md-level=1> <label class=md-nav__title for=__nav_4> <span class="md-nav__icon md-icon"></span> Images </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../docker-adguardhome-sync/ class=md-nav__link> adguardhome-sync </a> </li> <li class=md-nav__item> <a href=../docker-airsonic-advanced/ class=md-nav__link> airsonic-advanced </a> </li> <li class=md-nav__item> <a href=../docker-airsonic/ class=md-nav__link> airsonic </a> </li> <li class=md-nav__item> <a href=../docker-apprise-api/ class=md-nav__link> apprise-api </a> </li> <li class=md-nav__item> <a href=../docker-audacity/ class=md-nav__link> audacity </a> </li> <li class=md-nav__item> <a href=../docker-babybuddy/ class=md-nav__link> babybuddy </a> </li> <li class=md-nav__item> <a href=../docker-bazarr/ class=md-nav__link> bazarr </a> </li> <li class=md-nav__item> <a href=../docker-beets/ class=md-nav__link> beets </a> </li> <li class=md-nav__item> <a href=../docker-blender/ class=md-nav__link> blender </a> </li> <li class=md-nav__item> <a href=../docker-boinc/ class=md-nav__link> boinc </a> </li> <li class=md-nav__item> <a href=../docker-booksonic-air/ class=md-nav__link> booksonic-air </a> </li> <li class=md-nav__item> <a href=../docker-booksonic/ class=md-nav__link> booksonic </a> </li> <li class=md-nav__item> <a href=../docker-bookstack/ class=md-nav__link> bookstack </a> </li> <li class=md-nav__item> <a href=../docker-budge/ class=md-nav__link> budge </a> </li> <li class=md-nav__item> <a href=../docker-calibre-web/ class=md-nav__link> calibre-web </a> </li> <li class=md-nav__item> <a href=../docker-calibre/ class=md-nav__link> calibre </a> </li> <li class=md-nav__item> <a href=../docker-cardigann/ class=md-nav__link> cardigann </a> </li> <li class=md-nav__item> <a href=../docker-changedetection.io/ class=md-nav__link> changedetection.io </a> </li> <li class=md-nav__item> <a href=../docker-chevereto/ class=md-nav__link> chevereto </a> </li> <li class=md-nav__item> <a href=../docker-clarkson/ class=md-nav__link> clarkson </a> </li> <li class=md-nav__item> <a href=../docker-cloud9/ class=md-nav__link> cloud9 </a> </li> <li class=md-nav__item> <a href=../docker-code-server/ class=md-nav__link> code-server </a> </li> <li class=md-nav__item> <a href=../docker-codiad/ class=md-nav__link> codiad </a> </li> <li class=md-nav__item> <a href=../docker-codimd/ class=md-nav__link> codimd </a> </li> <li class=md-nav__item> <a href=../docker-cops/ class=md-nav__link> cops </a> </li> <li class=md-nav__item> <a href=../docker-couchpotato/ class=md-nav__link> couchpotato </a> </li> <li class=md-nav__item> <a href=../docker-daapd/ class=md-nav__link> daapd </a> </li> <li class=md-nav__item> <a href=../docker-darktable/ class=md-nav__link> darktable </a> </li> <li class=md-nav__item> <a href=../docker-davos/ class=md-nav__link> davos </a> </li> <li class=md-nav__item> <a href=../docker-ddclient/ class=md-nav__link> ddclient </a> </li> <li class=md-nav__item> <a href=../docker-deluge/ class=md-nav__link> deluge </a> </li> <li class=md-nav__item> <a href=../docker-digikam/ class=md-nav__link> digikam </a> </li> <li class=md-nav__item> <a href=../docker-dillinger/ class=md-nav__link> dillinger </a> </li> <li class=md-nav__item> <a href=../docker-diskover/ class=md-nav__link> diskover </a> </li> <li class=md-nav__item> <a href=../docker-docker-compose/ class=md-nav__link> docker-compose </a> </li> <li class=md-nav__item> <a href=../docker-dokuwiki/ class=md-nav__link> dokuwiki </a> </li> <li class=md-nav__item> <a href=../docker-domoticz/ class=md-nav__link> domoticz </a> </li> <li class=md-nav__item> <a href=../docker-doplarr/ class=md-nav__link> doplarr </a> </li> <li class=md-nav__item> <a href=../docker-doublecommander/ class=md-nav__link> doublecommander </a> </li> <li class=md-nav__item> <a href=../docker-duckdns/ class=md-nav__link> duckdns </a> </li> <li class=md-nav__item> <a href=../docker-duplicati/ class=md-nav__link> duplicati </a> </li> <li class=md-nav__item> <a href=../docker-emby/ class=md-nav__link> emby </a> </li> <li class=md-nav__item> <a href=../docker-embystat/ class=md-nav__link> embystat </a> </li> <li class=md-nav__item> <a href=../docker-emulatorjs/ class=md-nav__link> emulatorjs </a> </li> <li class=md-nav__item> <a href=../docker-endlessh/ class=md-nav__link> endlessh </a> </li> <li class=md-nav__item> <a href=../docker-fail2ban/ class=md-nav__link> fail2ban </a> </li> <li class=md-nav__item> <a href=../docker-feed2toot/ class=md-nav__link> feed2toot </a> </li> <li class=md-nav__item> <a href=../docker-ffmpeg/ class=md-nav__link> ffmpeg </a> </li> <li class=md-nav__item> <a href=../docker-filezilla/ class=md-nav__link> filezilla </a> </li> <li class=md-nav__item> <a href=../docker-firefox/ class=md-nav__link> firefox </a> </li> <li class=md-nav__item> <a href=../docker-fleet/ class=md-nav__link> fleet </a> </li> <li class=md-nav__item> <a href=../docker-foldingathome/ class=md-nav__link> foldingathome </a> </li> <li class=md-nav__item> <a href=../docker-freshrss/ class=md-nav__link> freshrss </a> </li> <li class=md-nav__item> <a href=../docker-grav/ class=md-nav__link> grav </a> </li> <li class=md-nav__item> <a href=../docker-grocy/ class=md-nav__link> grocy </a> </li> <li class=md-nav__item> <a href=../docker-guacd/ class=md-nav__link> guacd </a> </li> <li class=md-nav__item> <a href=../docker-habridge/ class=md-nav__link> habridge </a> </li> <li class=md-nav__item> <a href=../docker-headphones/ class=md-nav__link> headphones </a> </li> <li class=md-nav__item> <a href=../docker-healthchecks/ class=md-nav__link> healthchecks </a> </li> <li class=md-nav__item> <a href=../docker-hedgedoc/ class=md-nav__link> hedgedoc </a> </li> <li class=md-nav__item> <a href=../docker-heimdall/ class=md-nav__link> heimdall </a> </li> <li class=md-nav__item> <a href=../docker-homeassistant/ class=md-nav__link> homeassistant </a> </li> <li class=md-nav__item> <a href=../docker-htpcmanager/ class=md-nav__link> htpcmanager </a> </li> <li class=md-nav__item> <a href=../docker-ipfs/ class=md-nav__link> ipfs </a> </li> <li class=md-nav__item> <a href=../docker-jackett/ class=md-nav__link> jackett </a> </li> <li class=md-nav__item> <a href=../docker-jellyfin/ class=md-nav__link> jellyfin </a> </li> <li class=md-nav__item> <a href=../docker-kanzi/ class=md-nav__link> kanzi </a> </li> <li class=md-nav__item> <a href=../docker-kasm/ class=md-nav__link> kasm </a> </li> <li class=md-nav__item> <a href=../docker-kdenlive/ class=md-nav__link> kdenlive </a> </li> <li class=md-nav__item> <a href=../docker-lazylibrarian/ class=md-nav__link> lazylibrarian </a> </li> <li class=md-nav__item> <a href=../docker-ldap-auth/ class=md-nav__link> ldap-auth </a> </li> <li class=md-nav__item> <a href=../docker-libreoffice/ class=md-nav__link> libreoffice </a> </li> <li class=md-nav__item> <a href=../docker-libresonic/ class=md-nav__link> libresonic </a> </li> <li class=md-nav__item> <a href=../docker-librespeed/ class=md-nav__link> librespeed </a> </li> <li class=md-nav__item> <a href=../docker-lidarr/ class=md-nav__link> lidarr </a> </li> <li class=md-nav__item> <a href=../docker-limnoria/ class=md-nav__link> limnoria </a> </li> <li class="md-nav__item md-nav__item--active"> <input class="md-nav__toggle md-toggle" data-md-toggle=toc type=checkbox id=__toc> <label class="md-nav__link md-nav__link--active" for=__toc> lychee <span class="md-nav__icon md-icon"></span> </label> <a href=./ class="md-nav__link md-nav__link--active"> lychee </a> <nav class="md-nav md-nav--secondary" aria-label="Table of contents"> <label class=md-nav__title for=__toc> <span class="md-nav__icon md-icon"></span> Table of contents </label> <ul class=md-nav__list data-md-component=toc data-md-scrollfix> <li class=md-nav__item> <a href=#upgrade-warning class=md-nav__link> UPGRADE WARNING </a> </li> <li class=md-nav__item> <a href=#supported-architectures class=md-nav__link> Supported Architectures </a> </li> <li class=md-nav__item> <a href=#application-setup class=md-nav__link> Application Setup </a> </li> <li class=md-nav__item> <a href=#usage class=md-nav__link> Usage </a> <nav class=md-nav aria-label=Usage> <ul class=md-nav__list> <li class=md-nav__item> <a href=#docker-compose-recommended-click-here-for-more-info class=md-nav__link> docker-compose (recommended, click here for more info) </a> </li> <li class=md-nav__item> <a href=#docker-cli-click-here-for-more-info class=md-nav__link> docker cli (click here for more info) </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#parameters class=md-nav__link> Parameters </a> <nav class=md-nav aria-label=Parameters> <ul class=md-nav__list> <li class=md-nav__item> <a href=#ports-p class=md-nav__link> Ports (-p) </a> </li> <li class=md-nav__item> <a href=#environment-variables-e class=md-nav__link> Environment Variables (-e) </a> </li> <li class=md-nav__item> <a href=#volume-mappings-v class=md-nav__link> Volume Mappings (-v) </a> <nav class=md-nav aria-label="Volume Mappings (-v)"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#miscellaneous-options class=md-nav__link> Miscellaneous Options </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#environment-variables-from-files-docker-secrets class=md-nav__link> Environment variables from files (Docker secrets) </a> </li> <li class=md-nav__item> <a href=#umask-for-running-applications class=md-nav__link> Umask for running applications </a> </li> <li class=md-nav__item> <a href=#user-group-identifiers class=md-nav__link> User / Group Identifiers </a> </li> <li class=md-nav__item> <a href=#docker-mods class=md-nav__link> Docker Mods </a> </li> <li class=md-nav__item> <a href=#support-info class=md-nav__link> Support Info </a> </li> <li class=md-nav__item> <a href=#versions class=md-nav__link> Versions </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=../docker-mariadb/ class=md-nav__link> mariadb </a> </li> <li class=md-nav__item> <a href=../docker-mastodon/ class=md-nav__link> mastodon </a> </li> <li class=md-nav__item> <a href=../docker-medusa/ class=md-nav__link> medusa </a> </li> <li class=md-nav__item> <a href=../docker-minetest/ class=md-nav__link> minetest </a> </li> <li class=md-nav__item> <a href=../docker-minisatip/ class=md-nav__link> minisatip </a> </li> <li class=md-nav__item> <a href=../docker-mstream/ class=md-nav__link> mstream </a> </li> <li class=md-nav__item> <a href=../docker-muximux/ class=md-nav__link> muximux </a> </li> <li class=md-nav__item> <a href=../docker-mylar3/ class=md-nav__link> mylar3 </a> </li> <li class=md-nav__item> <a href=../docker-mysql-workbench/ class=md-nav__link> mysql-workbench </a> </li> <li class=md-nav__item> <a href=../docker-nano-discord-bot/ class=md-nav__link> nano-discord-bot </a> </li> <li class=md-nav__item> <a href=../docker-nano-wallet/ class=md-nav__link> nano-wallet </a> </li> <li class=md-nav__item> <a href=../docker-nano/ class=md-nav__link> nano </a> </li> <li class=md-nav__item> <a href=../docker-netbootxyz/ class=md-nav__link> netbootxyz </a> </li> <li class=md-nav__item> <a href=../docker-netbox/ class=md-nav__link> netbox </a> </li> <li class=md-nav__item> <a href=../docker-nextcloud/ class=md-nav__link> nextcloud </a> </li> <li class=md-nav__item> <a href=../docker-nginx/ class=md-nav__link> nginx </a> </li> <li class=md-nav__item> <a href=../docker-ngircd/ class=md-nav__link> ngircd </a> </li> <li class=md-nav__item> <a href=../docker-nntp2nntp/ class=md-nav__link> nntp2nntp </a> </li> <li class=md-nav__item> <a href=../docker-nzbget/ class=md-nav__link> nzbget </a> </li> <li class=md-nav__item> <a href=../docker-nzbhydra2/ class=md-nav__link> nzbhydra2 </a> </li> <li class=md-nav__item> <a href=../docker-ombi/ class=md-nav__link> ombi </a> </li> <li class=md-nav__item> <a href=../docker-openssh-server/ class=md-nav__link> openssh-server </a> </li> <li class=md-nav__item> <a href=../docker-openvpn-as/ class=md-nav__link> openvpn-as </a> </li> <li class=md-nav__item> <a href=../docker-openvscode-server/ class=md-nav__link> openvscode-server </a> </li> <li class=md-nav__item> <a href=../docker-organizr/ class=md-nav__link> organizr </a> </li> <li class=md-nav__item> <a href=../docker-oscam/ class=md-nav__link> oscam </a> </li> <li class=md-nav__item> <a href=../docker-overseerr/ class=md-nav__link> overseerr </a> </li> <li class=md-nav__item> <a href=../docker-paperless-ng/ class=md-nav__link> paperless-ng </a> </li> <li class=md-nav__item> <a href=../docker-paperless-ngx/ class=md-nav__link> paperless-ngx </a> </li> <li class=md-nav__item> <a href=../docker-papermerge/ class=md-nav__link> papermerge </a> </li> <li class=md-nav__item> <a href=../docker-photoshow/ class=md-nav__link> photoshow </a> </li> <li class=md-nav__item> <a href=../docker-phpmyadmin/ class=md-nav__link> phpmyadmin </a> </li> <li class=md-nav__item> <a href=../docker-pidgin/ class=md-nav__link> pidgin </a> </li> <li class=md-nav__item> <a href=../docker-piwigo/ class=md-nav__link> piwigo </a> </li> <li class=md-nav__item> <a href=../docker-pixapop/ class=md-nav__link> pixapop </a> </li> <li class=md-nav__item> <a href=../docker-plex-meta-manager/ class=md-nav__link> plex-meta-manager </a> </li> <li class=md-nav__item> <a href=../docker-plex/ class=md-nav__link> plex </a> </li> <li class=md-nav__item> <a href=../docker-projectsend/ class=md-nav__link> projectsend </a> </li> <li class=md-nav__item> <a href=../docker-prowlarr/ class=md-nav__link> prowlarr </a> </li> <li class=md-nav__item> <a href=../docker-pwndrop/ class=md-nav__link> pwndrop </a> </li> <li class=md-nav__item> <a href=../docker-pydio-cells/ class=md-nav__link> pydio-cells </a> </li> <li class=md-nav__item> <a href=../docker-pyload-ng/ class=md-nav__link> pyload-ng </a> </li> <li class=md-nav__item> <a href=../docker-pyload/ class=md-nav__link> pyload </a> </li> <li class=md-nav__item> <a href=../docker-pylon/ class=md-nav__link> pylon </a> </li> <li class=md-nav__item> <a href=../docker-qbittorrent/ class=md-nav__link> qbittorrent </a> </li> <li class=md-nav__item> <a href=../docker-qdirstat/ class=md-nav__link> qdirstat </a> </li> <li class=md-nav__item> <a href=../docker-quassel-core/ class=md-nav__link> quassel-core </a> </li> <li class=md-nav__item> <a href=../docker-quassel-web/ class=md-nav__link> quassel-web </a> </li> <li class=md-nav__item> <a href=../docker-radarr/ class=md-nav__link> radarr </a> </li> <li class=md-nav__item> <a href=../docker-raneto/ class=md-nav__link> raneto </a> </li> <li class=md-nav__item> <a href=../docker-rdesktop/ class=md-nav__link> rdesktop </a> </li> <li class=md-nav__item> <a href=../docker-readarr/ class=md-nav__link> readarr </a> </li> <li class=md-nav__item> <a href=../docker-remmina/ class=md-nav__link> remmina </a> </li> <li class=md-nav__item> <a href=../docker-requestrr/ class=md-nav__link> requestrr </a> </li> <li class=md-nav__item> <a href=../docker-resilio-sync/ class=md-nav__link> resilio-sync </a> </li> <li class=md-nav__item> <a href=../docker-rsnapshot/ class=md-nav__link> rsnapshot </a> </li> <li class=md-nav__item> <a href=../docker-sabnzbd/ class=md-nav__link> sabnzbd </a> </li> <li class=md-nav__item> <a href=../docker-scrutiny/ class=md-nav__link> scrutiny </a> </li> <li class=md-nav__item> <a href=../docker-shout-irc/ class=md-nav__link> shout-irc </a> </li> <li class=md-nav__item> <a href=../docker-sickchill/ class=md-nav__link> sickchill </a> </li> <li class=md-nav__item> <a href=../docker-sickgear/ class=md-nav__link> sickgear </a> </li> <li class=md-nav__item> <a href=../docker-smokeping/ class=md-nav__link> smokeping </a> </li> <li class=md-nav__item> <a href=../docker-snapdrop/ class=md-nav__link> snapdrop </a> </li> <li class=md-nav__item> <a href=../docker-snipe-it/ class=md-nav__link> snipe-it </a> </li> <li class=md-nav__item> <a href=../docker-sonarr/ class=md-nav__link> sonarr </a> </li> <li class=md-nav__item> <a href=../docker-sqlitebrowser/ class=md-nav__link> sqlitebrowser </a> </li> <li class=md-nav__item> <a href=../docker-swag/ class=md-nav__link> swag </a> </li> <li class=md-nav__item> <a href=../docker-synclounge/ class=md-nav__link> synclounge </a> </li> <li class=md-nav__item> <a href=../docker-syncthing/ class=md-nav__link> syncthing </a> </li> <li class=md-nav__item> <a href=../docker-syslog-ng/ class=md-nav__link> syslog-ng </a> </li> <li class=md-nav__item> <a href=../docker-taisun/ class=md-nav__link> taisun </a> </li> <li class=md-nav__item> <a href=../docker-tautulli/ class=md-nav__link> tautulli </a> </li> <li class=md-nav__item> <a href=../docker-thelounge/ class=md-nav__link> thelounge </a> </li> <li class=md-nav__item> <a href=../docker-transmission/ class=md-nav__link> transmission </a> </li> <li class=md-nav__item> <a href=../docker-tvheadend/ class=md-nav__link> tvheadend </a> </li> <li class=md-nav__item> <a href=../docker-ubooquity/ class=md-nav__link> ubooquity </a> </li> <li class=md-nav__item> <a href=../docker-unifi-controller/ class=md-nav__link> unifi-controller </a> </li> <li class=md-nav__item> <a href=../docker-webgrabplus/ class=md-nav__link> webgrabplus </a> </li> <li class=md-nav__item> <a href=../docker-webtop/ class=md-nav__link> webtop </a> </li> <li class=md-nav__item> <a href=../docker-wikijs/ class=md-nav__link> wikijs </a> </li> <li class=md-nav__item> <a href=../docker-wireguard/ class=md-nav__link> wireguard </a> </li> <li class=md-nav__item> <a href=../docker-wireshark/ class=md-nav__link> wireshark </a> </li> <li class=md-nav__item> <a href=../docker-xbackbone/ class=md-nav__link> xbackbone </a> </li> <li class=md-nav__item> <a href=../docker-yq/ class=md-nav__link> yq </a> </li> <li class=md-nav__item> <a href=../docker-znc/ class=md-nav__link> znc </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " data-md-toggle=__nav_5 type=checkbox id=__nav_5> <label class=md-nav__link for=__nav_5 tabindex=0 aria-expanded=false> Misc <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav aria-label=Misc data-md-level=1> <label class=md-nav__title for=__nav_5> <span class="md-nav__icon md-icon"></span> Misc </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../misc/finances/ class=md-nav__link> Finances </a> </li> </ul> </nav> </li> </ul> </nav> </div> </div> </div> <div class="md-sidebar md-sidebar--secondary" data-md-component=sidebar data-md-type=toc> <div class=md-sidebar__scrollwrap> <div class=md-sidebar__inner> <nav class="md-nav md-nav--secondary" aria-label="Table of contents"> <label class=md-nav__title for=__toc> <span class="md-nav__icon md-icon"></span> Table of contents </label> <ul class=md-nav__list data-md-component=toc data-md-scrollfix> <li class=md-nav__item> <a href=#upgrade-warning class=md-nav__link> UPGRADE WARNING </a> </li> <li class=md-nav__item> <a href=#supported-architectures class=md-nav__link> Supported Architectures </a> </li> <li class=md-nav__item> <a href=#application-setup class=md-nav__link> Application Setup </a> </li> <li class=md-nav__item> <a href=#usage class=md-nav__link> Usage </a> <nav class=md-nav aria-label=Usage> <ul class=md-nav__list> <li class=md-nav__item> <a href=#docker-compose-recommended-click-here-for-more-info class=md-nav__link> docker-compose (recommended, click here for more info) </a> </li> <li class=md-nav__item> <a href=#docker-cli-click-here-for-more-info class=md-nav__link> docker cli (click here for more info) </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#parameters class=md-nav__link> Parameters </a> <nav class=md-nav aria-label=Parameters> <ul class=md-nav__list> <li class=md-nav__item> <a href=#ports-p class=md-nav__link> Ports (-p) </a> </li> <li class=md-nav__item> <a href=#environment-variables-e class=md-nav__link> Environment Variables (-e) </a> </li> <li class=md-nav__item> <a href=#volume-mappings-v class=md-nav__link> Volume Mappings (-v) </a> <nav class=md-nav aria-label="Volume Mappings (-v)"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#miscellaneous-options class=md-nav__link> Miscellaneous Options </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#environment-variables-from-files-docker-secrets class=md-nav__link> Environment variables from files (Docker secrets) </a> </li> <li class=md-nav__item> <a href=#umask-for-running-applications class=md-nav__link> Umask for running applications </a> </li> <li class=md-nav__item> <a href=#user-group-identifiers class=md-nav__link> User / Group Identifiers </a> </li> <li class=md-nav__item> <a href=#docker-mods class=md-nav__link> Docker Mods </a> </li> <li class=md-nav__item> <a href=#support-info class=md-nav__link> Support Info </a> </li> <li class=md-nav__item> <a href=#versions class=md-nav__link> Versions </a> </li> </ul> </nav> </div> </div> </div> <div class=md-content data-md-component=content> <article class="md-content__inner md-typeset"> <!-- DO NOT EDIT THIS FILE MANUALLY  --> <!-- Please read the https://github.com/linuxserver/docker-lychee/blob/master/.github/CONTRIBUTING.md --> <h1 id=linuxserverlychee><a href=https://github.com/linuxserver/docker-lychee>linuxserver/lychee</a></h1> <p><a href=https://scarf.sh/gateway/linuxserver-ci/docker/linuxserver%2Flychee><img alt="Scarf.io pulls" src="https://scarf.sh/installs-badge/linuxserver-ci/linuxserver%2Flychee?color=94398d&label-color=555555&logo-color=ffffff&style=for-the-badge&package-type=docker"></a> <a href=https://github.com/linuxserver/docker-lychee><img alt="GitHub Stars" src="https://img.shields.io/github/stars/linuxserver/docker-lychee.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github"></a> <a href=https://github.com/linuxserver/docker-lychee/releases><img alt="GitHub Release" src="https://img.shields.io/github/release/linuxserver/docker-lychee.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github"></a> <a href=https://github.com/linuxserver/docker-lychee/packages><img alt="GitHub Package Repository" src="https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitHub%20Package&logo=github"></a> <a href=https://gitlab.com/linuxserver.io/docker-lychee/container_registry><img alt="GitLab Container Registry" src="https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab"></a> <a href=https://quay.io/repository/linuxserver.io/lychee><img alt=Quay.io src="https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=Quay.io"></a> <a href=https://hub.docker.com/r/linuxserver/lychee><img alt="Docker Pulls" src="https://img.shields.io/docker/pulls/linuxserver/lychee.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker"></a> <a href=https://hub.docker.com/r/linuxserver/lychee><img alt="Docker Stars" src="https://img.shields.io/docker/stars/linuxserver/lychee.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=stars&logo=docker"></a> <a href=https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-lychee/job/master/ ><img alt="Jenkins Build" src="https://img.shields.io/jenkins/build?labelColor=555555&logoColor=ffffff&style=for-the-badge&jobUrl=https%3A%2F%2Fci.linuxserver.io%2Fjob%2FDocker-Pipeline-Builders%2Fjob%2Fdocker-lychee%2Fjob%2Fmaster%2F&logo=jenkins"></a> <a href=https://ci-tests.linuxserver.io/linuxserver/lychee/latest/index.html><img alt="LSIO CI" src="https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=CI&query=CI&url=https%3A%2F%2Fci-tests.linuxserver.io%2Flinuxserver%2Flychee%2Flatest%2Fci-status.yml"></a></p> <p><a href=https://lycheeorg.github.io/ >Lychee</a> 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."</p> <h3 id=upgrade-warning>UPGRADE WARNING</h3> <p>Please note that the v4 upgrade process resets ALL password-protected albums. Any albums that were made public with a password will need to be re-secured.</p> <h2 id=supported-architectures>Supported Architectures</h2> <p>We utilise the docker manifest for multi-platform awareness. More information is available from docker <a href=https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list>here</a> and our announcement <a href=https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/ >here</a>.</p> <p>Simply pulling <code>lscr.io/linuxserver/lychee:latest</code> should retrieve the correct image for your arch, but you can also pull specific arch images via tags.</p> <p>The architectures supported by this image are:</p> <table> <thead> <tr> <th align=center>Architecture</th> <th align=center>Available</th> <th>Tag</th> </tr> </thead> <tbody> <tr> <td align=center>x86-64</td> <td align=center>✅</td> <td>amd64-\&lt;version tag></td> </tr> <tr> <td align=center>arm64</td> <td align=center>✅</td> <td>arm64v8-\&lt;version tag></td> </tr> <tr> <td align=center>armhf</td> <td align=center>✅</td> <td>arm32v7-\&lt;version tag></td> </tr> </tbody> </table> <h2 id=application-setup>Application Setup</h2> <p><strong>This image will not work with a prefilled <code>/pictures</code> mount, lychee wants total control over this folder</strong></p> <p>Setup mysql/mariadb and account via the webui, accessible at http://SERVERIP:PORT More info at <a href=https://lycheeorg.github.io/ >lychee</a>.</p> <h2 id=usage>Usage</h2> <p>To help you get started creating a container from this image you can either use docker-compose or the docker cli.</p> <h3 id=docker-compose-recommended-click-here-for-more-info>docker-compose (recommended, <a href=https://docs.linuxserver.io/general/docker-compose>click here for more info</a>)</h3> <div class=highlight><pre><span></span><code><span class=nt>version</span><span class=p>:</span><span class=w> </span><span class=s>&quot;3&quot;</span>
<span class=nt>services</span><span class=p>:</span>
<span class=w>  </span><span class=nt>mariadb</span><span class=p>:</span>
<span class=w>    </span><span class=nt>image</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">lscr.io/linuxserver/mariadb:latest</span>
<span class=w>    </span><span class=nt>container_name</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">lychee_mariadb</span>
<span class=w>    </span><span class=nt>restart</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">always</span>
<span class=w>    </span><span class=nt>volumes</span><span class=p>:</span>
<span class=w>      </span><span class="p p-Indicator">-</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">/path/to/mariadb/data:/config</span>
<span class=w>    </span><span class=nt>environment</span><span class=p>:</span>
<span class=w>      </span><span class="p p-Indicator">-</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">MYSQL_ROOT_PASSWORD=rootpassword</span>
<span class=w>      </span><span class="p p-Indicator">-</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">MYSQL_DATABASE=lychee</span>
<span class=w>      </span><span class="p p-Indicator">-</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">MYSQL_USER=lychee</span>
<span class=w>      </span><span class="p p-Indicator">-</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">MYSQL_PASSWORD=dbpassword</span>
<span class=w>      </span><span class="p p-Indicator">-</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">PGID=1000</span>
<span class=w>      </span><span class="p p-Indicator">-</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">PUID=1000</span>
<span class=w>      </span><span class="p p-Indicator">-</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">TZ=Europe/London</span>
<span class=w>  </span><span class=nt>lychee</span><span class=p>:</span>
<span class=w>    </span><span class=nt>image</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">lscr.io/linuxserver/lychee:latest</span>
<span class=w>    </span><span class=nt>container_name</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">lychee</span>
<span class=w>    </span><span class=nt>restart</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">always</span>
<span class=w>    </span><span class=nt>depends_on</span><span class=p>:</span>
<span class=w>      </span><span class="p p-Indicator">-</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">mariadb</span>
<span class=w>    </span><span class=nt>volumes</span><span class=p>:</span>
<span class=w>      </span><span class="p p-Indicator">-</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">/path/to/config:/config</span>
<span class=w>      </span><span class="p p-Indicator">-</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">/path/to/pictures:/pictures</span>
<span class=w>    </span><span class=nt>environment</span><span class=p>:</span>
<span class=w>      </span><span class="p p-Indicator">-</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">DB_HOST=mariadb</span>
<span class=w>      </span><span class="p p-Indicator">-</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">DB_USERNAME=lychee</span>
<span class=w>      </span><span class="p p-Indicator">-</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">DB_PASSWORD=dbpassword</span>
<span class=w>      </span><span class="p p-Indicator">-</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">DB_DATABASE=lychee</span>
<span class=w>      </span><span class="p p-Indicator">-</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">DB_PORT=3306</span>
<span class=w>      </span><span class="p p-Indicator">-</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">PGID=1000</span>
<span class=w>      </span><span class="p p-Indicator">-</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">PUID=1000</span>
<span class=w>      </span><span class="p p-Indicator">-</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">TZ=Europe/London</span>
<span class=w>    </span><span class=nt>ports</span><span class=p>:</span>
<span class=w>      </span><span class="p p-Indicator">-</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">80:80</span>
</code></pre></div> <h3 id=docker-cli-click-here-for-more-info>docker cli (<a href=https://docs.docker.com/engine/reference/commandline/cli/ >click here for more info</a>)</h3> <div class=highlight><pre><span></span><code>docker<span class=w> </span>run<span class=w> </span>-d<span class=w> </span><span class=se>\</span>
<span class=w>  </span>--name<span class=o>=</span>lychee<span class=w> </span><span class=se>\</span>
<span class=w>  </span>-e<span class=w> </span><span class=nv>PUID</span><span class=o>=</span><span class=m>1000</span><span class=w> </span><span class=se>\</span>
<span class=w>  </span>-e<span class=w> </span><span class=nv>PGID</span><span class=o>=</span><span class=m>1000</span><span class=w> </span><span class=se>\</span>
<span class=w>  </span>-e<span class=w> </span><span class=nv>TZ</span><span class=o>=</span>Europe/London<span class=w> </span><span class=se>\</span>
<span class=w>  </span>-e<span class=w> </span><span class=nv>DB_HOST</span><span class=o>=</span>mariadb<span class=w> </span><span class=se>\</span>
<span class=w>  </span>-e<span class=w> </span><span class=nv>DB_USERNAME</span><span class=o>=</span>lychee<span class=w> </span><span class=se>\</span>
<span class=w>  </span>-e<span class=w> </span><span class=nv>DB_PASSWORD</span><span class=o>=</span>dbpassword<span class=w> </span><span class=se>\</span>
<span class=w>  </span>-e<span class=w> </span><span class=nv>DB_DATABASE</span><span class=o>=</span>lychee<span class=w> </span><span class=se>\</span>
<span class=w>  </span>-p<span class=w> </span><span class=m>80</span>:80<span class=w> </span><span class=se>\</span>
<span class=w>  </span>-v<span class=w> </span>/path/to/config:/config<span class=w> </span><span class=se>\</span>
<span class=w>  </span>-v<span class=w> </span>/path/to/pictures:/pictures<span class=w> </span><span class=se>\</span>
<span class=w>  </span>--restart<span class=w> </span>unless-stopped<span class=w> </span><span class=se>\</span>
<span class=w>  </span>lscr.io/linuxserver/lychee:latest
</code></pre></div> <h2 id=parameters>Parameters</h2> <p>Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <code>&lt;external&gt;:&lt;internal&gt;</code> respectively. For example, <code>-p 8080:80</code> would expose port <code>80</code> from inside the container to be accessible from the host's IP on port <code>8080</code> outside the container.</p> <h3 id=ports-p>Ports (<code>-p</code>)</h3> <table> <thead> <tr> <th align=center>Parameter</th> <th>Function</th> </tr> </thead> <tbody> <tr> <td align=center><code>80</code></td> <td>http gui</td> </tr> </tbody> </table> <h3 id=environment-variables-e>Environment Variables (<code>-e</code>)</h3> <table> <thead> <tr> <th align=center>Env</th> <th>Function</th> </tr> </thead> <tbody> <tr> <td align=center><code>PUID=1000</code></td> <td>for UserID - see below for explanation</td> </tr> <tr> <td align=center><code>PGID=1000</code></td> <td>for GroupID - see below for explanation</td> </tr> <tr> <td align=center><code>TZ=Europe/London</code></td> <td>Specify a timezone to use EG Europe/London</td> </tr> <tr> <td align=center><code>DB_HOST=mariadb</code></td> <td>for specifying the database host</td> </tr> <tr> <td align=center><code>DB_USERNAME=lychee</code></td> <td>for specifying the database user</td> </tr> <tr> <td align=center><code>DB_PASSWORD=dbpassword</code></td> <td>for specifying the database password</td> </tr> <tr> <td align=center><code>DB_DATABASE=lychee</code></td> <td>for specifying the database to be used</td> </tr> </tbody> </table> <h3 id=volume-mappings-v>Volume Mappings (<code>-v</code>)</h3> <table> <thead> <tr> <th align=center>Volume</th> <th>Function</th> </tr> </thead> <tbody> <tr> <td align=center><code>/config</code></td> <td>Contains all relevant configuration files.</td> </tr> <tr> <td align=center><code>/pictures</code></td> <td>Where lychee will store uploaded data.</td> </tr> </tbody> </table> <h4 id=miscellaneous-options>Miscellaneous Options</h4> <table> <thead> <tr> <th align=center>Parameter</th> <th>Function</th> </tr> </thead> <tbody> <tr> <td></td> <td></td> </tr> </tbody> </table> <h2 id=environment-variables-from-files-docker-secrets>Environment variables from files (Docker secrets)</h2> <p>You can set any environment variable from a file by using a special prepend <code>FILE__</code>.</p> <p>As an example:</p> <div class=highlight><pre><span></span><code>-e<span class=w> </span><span class=nv>FILE__PASSWORD</span><span class=o>=</span>/run/secrets/mysecretpassword
</code></pre></div> <p>Will set the environment variable <code>PASSWORD</code> based on the contents of the <code>/run/secrets/mysecretpassword</code> file.</p> <h2 id=umask-for-running-applications>Umask for running applications</h2> <p>For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional <code>-e UMASK=022</code> setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up <a href=https://en.wikipedia.org/wiki/Umask>here</a> before asking for support.</p> <h2 id=user-group-identifiers>User / Group Identifiers</h2> <p>When using volumes (<code>-v</code> flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user <code>PUID</code> and group <code>PGID</code>.</p> <p>Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.</p> <p>In this instance <code>PUID=1000</code> and <code>PGID=1000</code>, to find yours use <code>id user</code> as below:</p> <div class=highlight><pre><span></span><code><span class=w>  </span>$<span class=w> </span>id<span class=w> </span>username
<span class=w>    </span><span class=nv>uid</span><span class=o>=</span><span class=m>1000</span><span class=o>(</span>dockeruser<span class=o>)</span><span class=w> </span><span class=nv>gid</span><span class=o>=</span><span class=m>1000</span><span class=o>(</span>dockergroup<span class=o>)</span><span class=w> </span><span class=nv>groups</span><span class=o>=</span><span class=m>1000</span><span class=o>(</span>dockergroup<span class=o>)</span>
</code></pre></div> <h2 id=docker-mods>Docker Mods</h2> <p><a href="https://mods.linuxserver.io/?mod=lychee" title="view available mods for this container."><img alt="Docker Mods" src="https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=lychee&query=%24.mods%5B%27lychee%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml"></a> <a href="https://mods.linuxserver.io/?mod=universal" title="view available universal mods."><img alt="Docker Universal Mods" src="https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=universal&query=%24.mods%5B%27universal%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml"></a></p> <p>We publish various <a href=https://github.com/linuxserver/docker-mods>Docker Mods</a> 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.</p> <h2 id=support-info>Support Info</h2> <ul> <li>Shell access whilst the container is running:</li> <li><code>docker exec -it lychee /bin/bash</code></li> <li>To monitor the logs of the container in realtime:</li> <li><code>docker logs -f lychee</code></li> <li>Container version number</li> <li><code>docker inspect -f '{{ index .Config.Labels "build_version" }}' lychee</code></li> <li>Image version number</li> <li><code>docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/lychee:latest</code></li> </ul> <h2 id=versions>Versions</h2> <ul> <li><strong>04.12.21:</strong> - Rebase to alpine 3.15 with php8.</li> <li><strong>13.05.21:</strong> - Make readme clearer.</li> <li><strong>18.04.21:</strong> - Add php-intl for v4.3.</li> <li><strong>31.01.21:</strong> - Add jpegoptim.</li> <li><strong>15.01.21:</strong> - Rebase to alpine 3.13, add php7-ctype.</li> <li><strong>10.07.20:</strong> - Upgrade to Lychee v4 and rebased to alpine 3.12.</li> <li><strong>19.12.19:</strong> - Rebasing to alpine 3.11.</li> <li><strong>23.10.19:</strong> - Increase fastcgi timeouts (existing users need to manually update).</li> <li><strong>19.09.19:</strong> - Update project website url.</li> <li><strong>28.06.19:</strong> - Rebasing to alpine 3.10.</li> <li><strong>05.05.19:</strong> - Rebase to alpine 3.9, use new armv7 image format.</li> <li><strong>21.01.18:</strong> - Added ffmpeg for video thumbnail creation, switched to installing zip release instead of source tarball, created small thumbnails folder, switched to dynamic readme.</li> <li><strong>14.01.19:</strong> - Adding pipeline logic and multi arch..</li> <li><strong>04.09.18:</strong> - Rebase to alpine 3.8, switch to LycheeOrg repository.</li> <li><strong>08.01.18:</strong> - Rebase to alpine 3.7.</li> <li><strong>25.05.17:</strong> - Rebase to alpine 3.6.</li> <li><strong>03.05.17:</strong> - Use repo pinning to better solve dependencies, use repo version of php7-imagick.</li> <li><strong>12.02.17:</strong> - Initial Release.</li> </ul> </article> </div> </div> </main> <footer class=md-footer> <div class="md-footer-meta md-typeset"> <div class="md-footer-meta__inner md-grid"> <div class=md-copyright> <div class=md-copyright__highlight> Copyright &copy; 2022 LinuxServer.io </div> Made with <a href=https://squidfunk.github.io/mkdocs-material/ target=_blank rel=noopener> Material for MkDocs </a> </div> <div class=md-social> <a href=https://github.com/linuxserver target=_blank rel=noopener title=github.com class=md-social__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 448 512"><!-- Font Awesome Free 6.2.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M400 32H48C21.5 32 0 53.5 0 80v352c0 26.5 21.5 48 48 48h352c26.5 0 48-21.5 48-48V80c0-26.5-21.5-48-48-48zM277.3 415.7c-8.4 1.5-11.5-3.7-11.5-8 0-5.4.2-33 .2-55.3 0-15.6-5.2-25.5-11.3-30.7 37-4.1 76-9.2 76-73.1 0-18.2-6.5-27.3-17.1-39 1.7-4.3 7.4-22-1.7-45-13.9-4.3-45.7 17.9-45.7 17.9-13.2-3.7-27.5-5.6-41.6-5.6-14.1 0-28.4 1.9-41.6 5.6 0 0-31.8-22.2-45.7-17.9-9.1 22.9-3.5 40.6-1.7 45-10.6 11.7-15.6 20.8-15.6 39 0 63.6 37.3 69 74.3 73.1-4.8 4.3-9.1 11.7-10.6 22.3-9.5 4.3-33.8 11.7-48.3-13.9-9.1-15.8-25.5-17.1-25.5-17.1-16.2-.2-1.1 10.2-1.1 10.2 10.8 5 18.4 24.2 18.4 24.2 9.7 29.7 56.1 19.7 56.1 19.7 0 13.9.2 36.5.2 40.6 0 4.3-3 9.5-11.5 8-66-22.1-112.2-84.9-112.2-158.3 0-91.8 70.2-161.5 162-161.5S388 165.6 388 257.4c.1 73.4-44.7 136.3-110.7 158.3zm-98.1-61.1c-1.9.4-3.7-.4-3.9-1.7-.2-1.5 1.1-2.8 3-3.2 1.9-.2 3.7.6 3.9 1.9.3 1.3-1 2.6-3 3zm-9.5-.9c0 1.3-1.5 2.4-3.5 2.4-2.2.2-3.7-.9-3.7-2.4 0-1.3 1.5-2.4 3.5-2.4 1.9-.2 3.7.9 3.7 2.4zm-13.7-1.1c-.4 1.3-2.4 1.9-4.1 1.3-1.9-.4-3.2-1.9-2.8-3.2.4-1.3 2.4-1.9 4.1-1.5 2 .6 3.3 2.1 2.8 3.4zm-12.3-5.4c-.9 1.1-2.8.9-4.3-.6-1.5-1.3-1.9-3.2-.9-4.1.9-1.1 2.8-.9 4.3.6 1.3 1.3 1.8 3.3.9 4.1zm-9.1-9.1c-.9.6-2.6 0-3.7-1.5s-1.1-3.2 0-3.9c1.1-.9 2.8-.2 3.7 1.3 1.1 1.5 1.1 3.3 0 4.1zm-6.5-9.7c-.9.9-2.4.4-3.5-.6-1.1-1.3-1.3-2.8-.4-3.5.9-.9 2.4-.4 3.5.6 1.1 1.3 1.3 2.8.4 3.5zm-6.7-7.4c-.4.9-1.7 1.1-2.8.4-1.3-.6-1.9-1.7-1.5-2.6.4-.6 1.5-.9 2.8-.4 1.3.7 1.9 1.8 1.5 2.6z"/></svg> </a> <a href=https://gitlab.com/linuxserver.io target=_blank rel=noopener title=gitlab.com class=md-social__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 448 512"><!-- Font Awesome Free 6.2.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M48 32h352c26.5 0 48 21.5 48 48v352c0 26.5-21.5 48-48 48H48c-26.5 0-48-21.5-48-48V80c0-26.5 21.5-48 48-48zm334.1 192.9-44.6-116.4c-.9-2.3-2.6-4.3-4.6-5.6-1.6-1-3.4-1.6-5.2-1.8-1.8-.2-3.7.1-5.4.7-1.7.7-3.3 1.7-4.5 3.1-1.2 1.4-2.1 3-2.6 4.8L285 201.9H162.1l-29.2-92.2c-.5-1.8-1.5-3.4-2.7-4.8-2.1-1.3-2.8-2.4-4.5-3-2.6-.7-3.6-1.8-5.4-.8-1.8.2-3.6.8-5.2 1.8-2 1.3-3.6 3.3-4.5 5.6L65.94 224.9l-.47 1.2a82.94 82.94 0 0 0-2.25 52.5c4.96 17.3 15.4 32.5 29.75 43.3l.17.1.38.3 67.88 50.9 54.2 40.9c1.5 1 5.3 2.8 8.3 2.8 3 0 6-1.8 8.4-2.8l54.1-40.9 68.4-51.2.2-.1c14.4-10.9 24.8-26.1 29.8-43.3 4.9-17.3 3.3-35.7-2.3-52.5l-.4-1.2z"/></svg> </a> <a href=https://twitter.com/linuxserverio target=_blank rel=noopener title=twitter.com class=md-social__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 448 512"><!-- Font Awesome Free 6.2.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M400 32H48C21.5 32 0 53.5 0 80v352c0 26.5 21.5 48 48 48h352c26.5 0 48-21.5 48-48V80c0-26.5-21.5-48-48-48zm-48.9 158.8c.2 2.8.2 5.7.2 8.5 0 86.7-66 186.6-186.6 186.6-37.2 0-71.7-10.8-100.7-29.4 5.3.6 10.4.8 15.8.8 30.7 0 58.9-10.4 81.4-28-28.8-.6-53-19.5-61.3-45.5 10.1 1.5 19.2 1.5 29.6-1.2-30-6.1-52.5-32.5-52.5-64.4v-.8c8.7 4.9 18.9 7.9 29.6 8.3a65.447 65.447 0 0 1-29.2-54.6c0-12.2 3.2-23.4 8.9-33.1 32.3 39.8 80.8 65.8 135.2 68.6-9.3-44.5 24-80.6 64-80.6 18.9 0 35.9 7.9 47.9 20.7 14.8-2.8 29-8.3 41.6-15.8-4.9 15.2-15.2 28-28.8 36.1 13.2-1.4 26-5.1 37.8-10.2-8.9 13.1-20.1 24.7-32.9 34z"/></svg> </a> </div> </div> </div> </footer> </div> <div class=md-dialog data-md-component=dialog> <div class="md-dialog__inner md-typeset"></div> </div> <script id=__config type=application/json>{"base": "../..", "features": ["navigation.instant"], "search": "../../assets/javascripts/workers/search.e5c33ebb.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script> <script src=../../assets/javascripts/bundle.51d95adb.min.js></script> </body> </html>