Home Explore Help
Sign In
pixelfed
/
docs
mirror of https://github.com/pixelfed/docs
Watch 2
Star 0
Fork 0
Files Issues 0 Wiki
Branch: gh-pages
Branches Tags
docs
/
technical-documentation
/
config
/
index.html

index.html 133 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385 
  1. <!doctype html><html lang=en xml:lang=en><head><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1"><meta charset=utf-8><meta http-equiv=x-ua-compatible content="IE=edge,chrome=1"><link rel=stylesheet href=https://docs.pixelfed.org/styles/print.min.dc0d6585f80ac3487ec834e22482492dcf4aec4c38ea795d9b6f83e6615551b7.css integrity="sha256-3A1lhfgKw0h+yDTiJIJJLc9K7Ew46nldm2+D5mFVUbc=" media=print><link rel=stylesheet href=https://docs.pixelfed.org/styles/screen.min.917b8cfa6ed3955f1e96a220e5fd183ab42e1c99a38bc389103f8d62503368a8.css integrity="sha256-kXuM+m7TlV8elqIg5f0YOrQuHJmji8OJED+NYlAzaKg=" media=screen><script type=text/javascript src=https://docs.pixelfed.org/script.min.e809ed8b184bc6655b59d21c4cf23f06fad834541fa8387f81f4735ce8e89c6d.js integrity="sha256-6AntixhLxmVbWdIcTPI/BvrYNFQfqDh/gfRzXOjonG0="></script><style>a[href^="https\3a\2f\2f docs.pixelfed.org\2f "] svg{display:none!important}a[href^="http://localhost"] svg{display:none!important}</style><title itemprop=name>Configuration • Pixelfed Documentation</title><meta property="og:title" content="Configuration"><meta name=twitter:title content="Configuration"><meta name=application-name content="Pixelfed Documentation"><meta property="og:site_name" content="Pixelfed Documentation"><meta name=description content="A list of environment variables"><meta itemprop=description content="A list of environment variables"><meta property="og:description" content="A list of environment variables"><meta name=twitter:description content="A list of environment variables"><base href=https://docs.pixelfed.org/technical-documentation/config/><link rel=canonical href=https://docs.pixelfed.org/technical-documentation/config/ itemprop=url><meta name=url content="https://docs.pixelfed.org/technical-documentation/config/"><meta name=twitter:url content="https://docs.pixelfed.org/technical-documentation/config/"><meta property="og:url" content="https://docs.pixelfed.org/technical-documentation/config/"><meta itemprop=image content="https://docs.pixelfed.org/icon.png"><meta property="og:image" content="https://docs.pixelfed.org/icon.png"><meta name=twitter:image content="https://docs.pixelfed.org/icon.png"><meta name=twitter:image:src content="https://docs.pixelfed.org/icon.png"><meta property="og:updated_time" content="2023-10-23T03:04:07-0600"><meta property="og:type" content="website"><script defer type=application/ld+json>{"@context":"http://schema.org","@type":"WebSite","url":"https://docs.pixelfed.org/technical-documentation/config/","name":"Pixelfed Documentation","logo":"https://docs.pixelfed.org/icon.png"}</script><link rel="shortcut icon" href=https://docs.pixelfed.org/icon.png sizes=512x512><meta name=theme-color content="#ffffff"><meta name=msapplication-TileColor content="#ffffff"><link rel=sitemap type=application/xml title=Sitemap href=https://docs.pixelfed.org/sitemap.xml><meta name=robots content="index,follow"><meta name=googlebot content="index,follow"></head><body><header class=site-header><div class=container><div class=hang-left><a href=/ class=site-masthead><p class=site-title>Pixelfed Documentation</p></a><div class=color-switcher><div class=js-toggle-wrapper><div class=js-toggle style=display:none><div class=js-toggle-track><div class=js-toggle-track-check><img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAAAXNSR0IArs4c6QAAAAlwSFlzAAALEwAACxMBAJqcGAAAAVlpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IlhNUCBDb3JlIDUuNC4wIj4KICAgPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4KICAgICAgPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIKICAgICAgICAgICAgeG1sbnM6dGlmZj0iaHR0cDovL25zLmFkb2JlLmNvbS90aWZmLzEuMC8iPgogICAgICAgICA8dGlmZjpPcmllbnRhdGlvbj4xPC90aWZmOk9yaWVudGF0aW9uPgogICAgICA8L3JkZjpEZXNjcmlwdGlvbj4KICAgPC9yZGY6UkRGPgo8L3g6eG1wbWV0YT4KTMInWQAABlJJREFUWAm1V3tsFEUcntnXvXu0tBWo1ZZHihBjCEWqkHiNaMLDRKOtQSKaiCFKQtS/SbxiFCHGCIkmkBSMwZhQNTFoQZD0DFiwtCDFAkdDqBBBKFj63rvdnfH7zfVo5aFBj0l2Z/dm5vd98/0es8dYjlpr62azufnDQNZcU1PciMfjWvb9rvZSMk4Ayfb36pLH13189GC8LAtIRLLPt+pzwrCuLq4ISEv/gHmitrAwfPbEkXc/ad4dL6iujrvyX0jcitgd/yZlZqftP6995Mr5TVLa22Tn8XVX2g/XLSRjUu7Q79jonS7I7hS7/0oOb5VyqF52n98oj7esXX07EjlxwXWisRmSnm3b29TTM8iYrjmFBWExubxwY/uhNas4r/WySl1fc5cetDMd7ydl+lMJJRw5WC8ud62Xx5rfepzwxgZmbhUYNS5Stvsj4yo2GXJEFBVHWDBkfdbR9HpYBaaUajDnBLKKpl1xRKYcgGtMCqEzTaSnThk/SQT0uJqTqFNBmXMCsZE48DzRZRMBRjv1GHNdk3HBImF9ZUvTyxM40pMKVc4JZBXQOLOFoDeKSxdp6HIQcO4rjYT9fn0pjbz9GLt7BAAODmjSVReXUMFzNW5x5vfxp2mIxZjIuQKJxAmFa+is2DQJJQ0JyBVExNOYcJnPxx/6/utnijmP555ALEagKAGGnGn64QORBjARcIA/yJk7JMJBLRrNtybTvH88KGjCf2jK86bhzmMcwDKFZEQvbIhxFYhChoMWMzU2iWznlIBEVJOsP+1bdX/ALx9l7jApADeDAEcMkE90JnUmmGl4USKQ0xhoW3JB5XY0YrxYWhLwMZZypUyjDGH35AbNwgUGiFBPpuGbHCpAOV1ZGXf2f/taftAv31DyeymN2d1IhAFAwTOmnzF/kKcdh3me7CYCOVNgycju84u8DeVlwfFq9/ZlTfldYrMUjOlrkjkD+rU+WzCROkcEchIDHR011syZW9JHD7y07N6JvhWMpz3pugaTkB6lWFVCKkhck0zzeMp2utq+uHrmfxOgoCO/Z8CXPlEQ1bdH8wgvhSIkEG0ICcQeExIFGdimjvKka7btJFZuaXOammIGKUCFQ53j9EN1dYKWqHf0t2w407W2tgs6h89ZnImjB55flh81tt9XirjjDuSl+oIPRQ0iWPgNZ5GqTqbBe3vSzEl5n5PhWKwocyR2HlqYN61qV18WjYjE8JLARZPQsUSim8foIRYTlGr02Ly7piASFRtKJ4VfieYhxdS2JcDVMN6xVOKZyrCGm8b108lrLRVzvptLH7IoEFLFANes6KnDi+uxfmvFnF17oALq5u1agu3/YfHkcSFzeSggV5eXRfIB7CHNcO5SUI+Ih5Ir7f4MAV9IqdFzdZgNpZw1Gcs1mNvgGbTbqQ9/cz7ZuuhgyYRQ49ljTyWHhr2DwpNHHFf+5gnWZ3Bharo+0TD5dNMw5vv9RlVpSRDHK4TlnoukhtYApuOHejSZQuo5g/A9BysdKRCyLl6062fN37OXMDlvUJtUrtmxo0avrW3wTrYs3jJ9RvRVChrmSmanPMpX2OXMsmDGh6AiEIwBAlvkOqIdBy+8JyAz8pz7QxiDth4KDy5uAlwzrWTnwC8Vc4KVAMZ3YUZ+IqoIjP3h5KFFX1ZMy3uW+7RhEDHgTi0zC9rS7uhPCDiNrGFyqBeERtKN/B0YlyFCkw0NJ5C0Ojv7zvT1a1WV1TuvZDdL4NTgB7CASYpsen6gqvG5jmTf5qHedADgkBl3D0nkSgNhZACDyi0FUKZRr3IdRjgN4WPPoFMIIegIK3mqd38fS80mcJKelM4szNyzZtQbkchGePuBRS8Eg9pHU8ojRQpSqs+ajAIwTjjUMQ/nvTNM0kicwYxZIYMh/891DYi+fvedB+c1xsm4lDU6ya+Axtz+RiAzEVYbajQOpq17F0R9QevNcEhfcU+xvyQQUalGJBSesqOkgPQ4YNyUZL9fSvUPDjoNAwN8/dwFjaczNkc3ptaMud1EIDtGcmXTcefO2cGSvKIFfp/2JIJxlq7xEl3nVPM4fDeIbPkD16/ptNc0bDu7qxbsu0R2JGywWMIjF2ft3tjfloAyQAGXiOn8hrqwbVvMXzaO+QeHXP6nF0wvX74Hf4NGG5GPjSlYoyM3P/0FbCT6zvM/yYoAAAAASUVORK5CYII=" role=presentation style=pointer-events:none width=16 height=16></div><div class=js-toggle-track-x><img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAAAXNSR0IArs4c6QAAAAlwSFlzAAALEwAACxMBAJqcGAAAAVlpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IlhNUCBDb3JlIDUuNC4wIj4KICAgPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4KICAgICAgPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIKICAgICAgICAgICAgeG1sbnM6dGlmZj0iaHR0cDovL25zLmFkb2JlLmNvbS90aWZmLzEuMC8iPgogICAgICAgICA8dGlmZjpPcmllbnRhdGlvbj4xPC90aWZmOk9yaWVudGF0aW9uPgogICAgICA8L3JkZjpEZXNjcmlwdGlvbj4KICAgPC9yZGY6UkRGPgo8L3g6eG1wbWV0YT4KTMInWQAABwNJREFUWAmtV1tsFFUY/s6Z2d22zLYlZakUCRVaQcqlWIiCiS1gTEB9UAO+GR9En3iQGI0xJiSiRB98MjEq8cEQTSBeHhQM0V7whtEGDWC90BYitxahtNtu25058/v/ZzvLbilawJNM5+yZ89+//1LgJhYRNLW1uDfBAvpGiIk2O5auvfFxqIH3ZJ8/u06GN6Z9+wVl5SjcD1IbZa/UPkPyYl2uR4dreoD2bnbYxTlBBRytkHXtAREphP5KuH4lddx9h70yxX05t7yYXwGb6W8nx1jibpl2rFlGBxcG9M18okOrn7Bnk/BAO/4bI0UeEE1zjBp3UmvjOxJXJdaKN/ZiIu4tOZrAb4aTdZAZArKmWeiiJZ6jt5tiagdCS9+6cgO1Ne6Mvhe+ixTIfyDVhipnK9p+P0Edqx9RW/YZtQVGmOLChRxNNlyPsTEgPQKMB3dbEHa0h1awYmQ83enTd2vmUtvKd1Glv2RkzBb+kZGRrKtjzG60Wguhd/lJZBingbcfWWe72vjT75bJDrhYtvA0hrurETDr5HyF2Knb1MM4ab//xIoOqueA0edRnkkinTyJdYvqLFDZO4zUPFCvVoDjJq4T7TE61IWh4x5KqxX5KVKkX8WZ/t2ov2cb3MHt4dhIyOxIJxJOOF6xRx/99BksXLoecWcXytILMNBDqKpnGZWPquYfPxY8iXGR9fK+SgFrgcRPXPjVqhehL+3EmZ5RGJQi1QBU8TPThQnOQzm+5UXGIcetUeEAfP13VwzpI+w1jGJWdSliNfvVhiMPiOsllJag4M/UGHiqM6dlBb2OTLKHHV6KkvogrJ4XhBWniWK/Gp1MQyf93FOeUXKmKk/FzJxbQtKLjFXYT4USupy8fQVir2ynVEBiZMG0qtOHMS/AW4Gwrk7BG3C1F0B5nqNKE0CME4MfVRLPnXkBKe+ipvoFhNQywOhdghvLi0F8ReyVXV4BKTBRbbe5f64zR/DHsdZw1hJfeWlHl/GNRJzDxrd5m192z78TMaVnKELZoINZS4BzQ7vtnZljSnha/pPCbkuxzXcupYwI5tIeCpGc0Yp9tWHZQy/rmYhRfNgg4bHJBYLzGkxsRJF4XKlE2jBOHNSv3kY7Tj6vthzPFl61BrYwqFlmEQhtSVXmLiksxLmtRgYXI1ULU61JJ4eVKmG3/5sCVgpbMT6OMJ2E08/29Xf3w6v4FnHdCjfWgXu/O8Z5mLdCkeRs2khHe1DqOtQwbHWTAnM5S2HNmhALYo5KjkPFrMMKjZl6HxhWIAb0BqE+/73GrBRQUsKYiBu4JX8ycI6wtw+i5ef3NZpsrKVSHYCP37jwGDgeE1SA0S/xtl5SU2fs1ApEp0qTLVRjgyycDSsLHMSwmFltZMStR3uLLg6BdLhDa5dC6ryU2pHBe1BVO9tUcwfitJt2CLJZUHoG6T7Op75u0IyK31TCPcwFqgPk/KCaD3dFOuZBCO7xvCT/j048b3I3c7F2+WuOW7qdgkucFYlcQ4qop3yzTX7WaKfOCccye3Ts1Etq0+a/BHCF1yPgF3tAUkR6OrtGmo6gl94qqcXKh3rDyrOkPa58URoWcov2Mo6M+0QjrqKB+b7++oMa9Sz+ZkM0mie6aAtnGUvhmxaI+TogPOSQedgWioGSHFLn3v4kLh4HRspNmOGv41k+55siLFp2z6xYeJjhljFcbmxJlr4ga06TbevSByz/glQq4BJx46/c+237PbBqEYKxX3HpmKZEnQnr65X20hqJYaNcLoFOLiJk2LuBbyg7Q0OEn+hm0P3honxFD6rdxYorKpeIoi4YSSvyQHQIbM5t4+YNxLj/OxhVOOE4585qGpjnq+wSx6Q9CtNxTjd5klB+g6Mv36r0+b9cZFi44WYkHdG2ZWb3TtOUOXyVAlKlpGvJIAJ3eBMyfYS5C0qRZGtC85j+4sOasDe9xznPYezhhO/2Q6eP2fSOvYHOjtuQ1a9Q1VKynVDaMc8E0tptdxUsTFpFIYjcZKcbnoaQTNdiqCwNlL4G7oziSqGnT1ALf34vhk4R5zU3qYV9ONp9K88RtouShE68JwaU8dFw5W617shWa9ykeaBIn2hcsvPgL00k45QdTCZuSVcTRNs+8fnyLvooQfR5iujAnR9bxfY2xOVOxFS8SK3Le0l48VyYu1M8HRe5JD8wKPTjYnifaK3Wfn/GChYQ8ZAi6WRzWgqLV5YrsVLnZaVSoXU1g9gOIDwFySiGi+Zdrnzr7J3r+SMuszlcQCRn8lNGcTuSy2jOI7o9mxjZo+vR3ej3tN+ifRSOyUTS0+VMOid93cCubeiy/6TImS0QxRSCq2vxKr45zV+FQnjWH6D2xg+E9EatLcLAdHTgtGGD80D6jM0+aOl4wJgO/f96R2aJKCQ3yvgftRhdFMOpd6oAAAAASUVORK5CYII=" role=presentation style=pointer-events:none width=16 height=16></div></div><div class=js-toggle-thumb></div><input class=js-toggle-screenreader-only type=checkbox aria-label="Switch between Dark and Light mode"></div></div></div><style>.js-toggle-wrapper{display:table;margin:0 auto}.js-toggle{touch-action:pan-x;display:inline-block;position:relative;cursor:pointer;background-color:transparent;border:0;padding:0;-webkit-touch-callout:none;user-select:none;-webkit-tap-highlight-color:transparent;-webkit-tap-highlight-color:transparent}.js-toggle-screenreader-only{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.js-toggle-track{width:50px;height:24px;padding:0;border-radius:30px;background-color:gray;transition:all .2s ease}.js-toggle-track-check{position:absolute;width:17px;height:17px;left:5px;top:0;bottom:0;margin-top:auto;margin-bottom:auto;line-height:0;opacity:0;transition:opacity .25s ease}.js-toggle--checked .js-toggle-track-check{opacity:1;transition:opacity .25s ease}.js-toggle-track-x{position:absolute;width:17px;height:17px;right:5px;top:0;bottom:0;margin-top:auto;margin-bottom:auto;line-height:0;opacity:1;transition:opacity .25s ease}.js-toggle--checked .js-toggle-track-x{opacity:0}.js-toggle-thumb{position:absolute;top:1px;left:1px;width:22px;height:22px;border-radius:50%;background-color:#fafafa;box-sizing:border-box;transition:all .5s cubic-bezier(.23,1,.32,1)0ms;transform:translateX(0)}.js-toggle--checked .js-toggle-thumb{transform:translateX(26px);border-color:#19ab27}.js-toggle--focus{filter:drop-shadow(0 0 3px var(--primary-accent));outline:1px solid var(--ui-text);outline-offset:6px}.js-toggle:active .js-toggle-thumb{box-shadow:0 0 5px 5px var(--primary-accent)}</style><script>var body=document.body,input,switchers=document.getElementsByClassName("js-toggle");for(switcher of switchers)switcher.removeAttribute("style"),input=switcher.querySelector(".js-toggle-screenreader-only"),input.addEventListener("focus",e=>{switcher.classList.add("js-toggle--focus")}),input.addEventListener("focusout",e=>{switcher.classList.remove("js-toggle--focus")}),switcher.addEventListener("click",function(){for(switcher of switchers)this.classList.toggle("js-toggle--checked");this.classList.contains("js-toggle--checked")?(body.classList.remove("light-mode"),body.classList.add("dark-mode"),localStorage.setItem("colorMode","dark")):(body.classList.remove("dark-mode"),body.classList.add("light-mode"),setTimeout(function(){localStorage.setItem("colorMode","light")},100))});if(window.matchMedia&&window.matchMedia("(prefers-color-scheme: dark)").matches&&localStorage.setItem("colorMode","dark"),localStorage.getItem("colorMode")=="dark"){for(switcher of switchers)switcher.classList.add("js-toggle--checked");body.classList.add("dark-mode")}localStorage.getItem("colorMode")=="light"&&body.classList.add("light-mode")</script></div><nav class=header-nav><ul class=menu><li class=pixelfed><a href=https://pixelfed.org><img src="https://avatars0.githubusercontent.com/u/38410642?s=200&amp;v=4" height=24>
    2. 

  2. <span>pixelfed.org</span></a></li><li class=github><a href=https://github.com/pixelfed/docs><svg style="background:#fff;border:1px solid #fff;border-radius:100rem" height="1.5rem" viewBox="0 0 1024 1024" fill="none" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="M8 0C3.58.0.0 3.58.0 8c0 3.54 2.29 6.53 5.47 7.59C5.87 15.66 6.02 15.42 6.02 15.21 6.02 15.02 6.01 14.39 6.01 13.72 4 14.09 3.48 13.23 3.32 12.78 3.23 12.55 2.84 11.84 2.5 11.65 2.22 11.5 1.82 11.13 2.49 11.12 3.12 11.11 3.57 11.7 3.72 11.94 4.44 13.15 5.59 12.81 6.05 12.6 6.12 12.08 6.33 11.73 6.56 11.53 4.78 11.33 2.92 10.64 2.92 7.58c0-.87.31-1.59.82-2.15C3.66 5.23 3.38 4.41 3.82 3.31c0 0 .67-.21 2.2.82C6.66 3.95 7.34 3.86 8.02 3.86S9.38 3.95 10.02 4.13c1.53-1.04 2.2-.82 2.2-.82C12.66 4.41 12.38 5.23 12.3 5.43 12.81 5.99 13.12 6.7 13.12 7.58c0 3.07-1.87 3.75-3.65 3.95C9.76 11.78 10.01 12.26 10.01 13.01 10.01 14.08 10 14.94 10 15.21 10 15.42 10.15 15.67 10.55 15.59 13.71 14.53 16 11.53 16 8c0-4.42-3.58-8-8-8z" transform="scale(64)" fill="#1b1f23"/></svg><span>pixelfed/docs</span></a></li></ul></nav></div></header><div class=scroll-margin style=position:relative><div id=top style=scroll-margin-top:var(--header-height)></div></div><nav class=docs-nav><div class=container><input type=checkbox class=toggle-menu name=toggle id=toggle>
    3. 

  3. <label class=toggle-menu__label for=toggle><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" fill="none" viewBox="0 0 24 24" stroke="currentcolor" stroke-width="2"><path stroke-linecap="round" stroke-linejoin="round" d="M4 6h16M4 12h16M4 18h7"/></svg><span>Documentation Menu</span></label><ul class=menu data-depth=0><a id=menu href=#top>Skip menu</a>
    4. 

  4. <details data-depth=0><summary class=section-title><a data-depth=0><span>Run your own Pixelfed website</span></a></summary><ul class=sub-menu data-depth=1><li data-depth=1><a href=/running-pixelfed/prerequisites/ data-depth=1><span>Preparing your machine</span></a></li><li data-depth=1><a href=/running-pixelfed/installation/ data-depth=1><span>Generic installation guide</span></a></li><li data-depth=1><a href=/running-pixelfed/administration/ data-depth=1><span>Administering your website</span></a></li><li data-depth=1><a href=/running-pixelfed/optional-features/ data-depth=1><span>Optional features</span></a><ul class=sub-menu data-depth=2><li data-depth=2><a href=/running-pixelfed/optional-features/livestreaming/ data-depth=2><span>Livestreaming (Pixelfed Live)</span></a></li><li data-depth=2><a href=/running-pixelfed/optional-features/websockets/ data-depth=2><span>Websockets</span></a></li><li data-depth=2><a href=/running-pixelfed/optional-features/ldap-authentication/ data-depth=2><span>LDAP Authentication</span></a></li></ul></li><li data-depth=1><a href=/running-pixelfed/troubleshooting/ data-depth=1><span>Troubleshooting</span></a></li></ul></details><details data-depth=0><summary class=section-title><a data-depth=0><span>Developing for Pixelfed</span></a></summary><ul class=sub-menu data-depth=1><li data-depth=1><a href=/developing-pixelfed/intro/ data-depth=1><span>Setting up your environment</span></a></li><li data-depth=1><a href=/developing-pixelfed/testing/ data-depth=1><span>Running tests locally</span></a></li></ul></details><details open data-depth=0><summary class='section-title active'><a data-depth=0><span>Technical documentation</span></a></summary><ul class=sub-menu data-depth=1><li data-depth=1><a href=/technical-documentation/activitypub/ data-depth=1><span>ActivityPub</span></a></li><li data-depth=1><a href=/technical-documentation/api/ data-depth=1><span>API</span></a></li><li data-depth=1><a href=/technical-documentation/artisan/ data-depth=1><span>CLI</span></a></li><li class=active data-depth=1><a href=/technical-documentation/config/ data-depth=1><span>Configuration</span></a></li></ul></details><details data-depth=0><summary class=section-title><a data-depth=0><span>Distro-specific install guides</span></a></summary><ul class=sub-menu data-depth=1><li data-depth=1><a href=/install-guides/arch/ data-depth=1><span>Arch Linux</span></a></li></ul></details></ul></div></nav><main><article class=page autonumbering><header class="section page-header"><div class=container><h1 class=page-title>Configuration</h1><p class=page-summary>A list of environment variables</p><p class=lastmod>Last modified <datetime class=date>Mon Oct 23, 2023</datetime></p></div></header><aside class="toc section"><div class=container><ul class=breadcrumbs><li><a href=/technical-documentation/>Technical documentation</a></li><li class=active><a href=/technical-documentation/config/>Configuration</a></li></ul><details open><summary class=toc-title>Page outline</summary><nav id=TableOfContents><ol><li><a href=#app>APP</a><ol><li><a href=#app_name><code>APP_NAME</code></a></li><li><a href=#app_env><code>APP_ENV</code></a></li><li><a href=#app_debug><code>APP_DEBUG</code></a></li><li><a href=#app_url><code>APP_URL</code></a></li><li><a href=#app_timezone><code>APP_TIMEZONE</code></a></li><li><a href=#app_locale><code>APP_LOCALE</code></a></li><li><a href=#app_fallback_locale><code>APP_FALLBACK_LOCALE</code></a></li><li><a href=#app_key><code>APP_KEY</code></a></li></ol></li><li><a href=#backup>BACKUP</a><ol><li><a href=#backup_archive_password><code>BACKUP_ARCHIVE_PASSWORD</code></a></li><li><a href=#backup_email_address><code>BACKUP_EMAIL_ADDRESS</code></a></li></ol></li><li><a href=#broadcasting>BROADCASTING</a><ol><li><a href=#broadcast_driver><code>BROADCAST_DRIVER</code></a></li><li><a href=#pusher>PUSHER</a></li></ol></li><li><a href=#cache>CACHE</a><ol><li><a href=#cache_driver><code>CACHE_DRIVER</code></a></li><li><a href=#cache_prefix><code>CACHE_PREFIX</code></a></li><li><a href=#memcached>MEMCACHED</a></li><li><a href=#redis>REDIS</a></li></ol></li><li><a href=#captcha>CAPTCHA</a><ol><li><a href=#captcha_enabled><code>CAPTCHA_ENABLED</code></a></li><li><a href=#captcha_secret><code>CAPTCHA_SECRET</code></a></li><li><a href=#captcha_sitekey><code>CAPTCHA_SITEKEY</code></a></li></ol></li><li><a href=#costar>COSTAR</a><ol><li><a href=#cs_blocked_domains><code>CS_BLOCKED_DOMAINS</code></a></li><li><a href=#cs_cw_domains><code>CS_CW_DOMAINS</code></a></li><li><a href=#cs_unlisted_domains><code>CS_UNLISTED_DOMAINS</code></a></li><li><a href=#cs_blocked_keywords><code>CS_BLOCKED_KEYWORDS</code></a></li><li><a href=#cs_cw_keywords><code>CS_CW_KEYWORDS</code></a></li><li><a href=#cs_unlisted_keywords><code>CS_UNLISTED_KEYWORDS</code></a></li><li><a href=#cs_blocked_actor><code>CS_BLOCKED_ACTOR</code></a></li><li><a href=#cs_cw_actor><code>CS_CW_ACTOR</code></a></li><li><a href=#cs_unlisted_actor><code>CS_UNLISTED_ACTOR</code></a></li></ol></li><li><a href=#database>DATABASE</a><ol><li><a href=#db_connection><code>DB_CONNECTION</code></a></li><li><a href=#sqlite>SQLITE</a></li><li><a href=#mysql>MYSQL</a></li><li><a href=#pgsql>PGSQL</a></li><li><a href=#sqlsrv>SQLSRV</a></li><li><a href=#redis_client-1><code>REDIS_CLIENT</code></a></li></ol></li><li><a href=#exp>EXP</a><ol><li><a href=#exp_lc><code>EXP_LC</code></a></li><li><a href=#exp_rec><code>EXP_REC</code></a></li><li><a href=#exp_loops><code>EXP_LOOPS</code></a></li><li><a href=#exp_top><code>EXP_TOP</code></a></li><li><a href=#exp_polls><code>EXP_POLLS</code></a></li><li><a href=#exp_cpt><code>EXP_CPT</code></a></li><li><a href=#exp_gps><code>EXP_GPS</code></a></li><li><a href=#spa><code>spa</code></a></li><li><a href=#exp_emc><code>EXP_EMC</code></a></li></ol></li><li><a href=#federation>FEDERATION</a><ol><li><a href=#activitypub>ACTIVITYPUB</a></li><li><a href=#atom_feeds><code>ATOM_FEEDS</code></a></li><li><a href=#remote_avatars><code>REMOTE_AVATARS</code></a></li><li><a href=#nodeinfo><code>NODEINFO</code></a></li><li><a href=#webfinger><code>WEBFINGER</code></a></li><li><a href=#pf_network_timeline><code>PF_NETWORK_TIMELINE</code></a></li><li><a href=#pf_network_timeline_days_falloff><code>PF_NETWORK_TIMELINE_DAYS_FALLOFF</code></a></li><li><a href=#custom_emoji><code>CUSTOM_EMOJI</code></a></li><li><a href=#custom_emoji_max_size><code>CUSTOM_EMOJI_MAX_SIZE</code></a></li></ol></li><li><a href=#filesystems>FILESYSTEMS</a><ol><li><a href=#filesystem_driver><code>FILESYSTEM_DRIVER</code></a></li><li><a href=#filesystem_cloud><code>FILESYSTEM_CLOUD</code></a></li><li><a href=#s3>S3</a></li><li><a href=#spaces>SPACES</a></li><li><a href=#backup-1>BACKUP</a></li></ol></li><li><a href=#hashids>HASHIDS</a><ol><li><a href=#app_hashid_salt><code>APP_HASHID_SALT</code></a></li></ol></li><li><a href=#hashing>HASHING</a><ol><li><a href=#bcrypt>BCRYPT</a></li><li><a href=#argon>ARGON</a></li></ol></li><li><a href=#horizon>HORIZON</a><ol><li><a href=#horizon_prefix><code>HORIZON_PREFIX</code></a></li><li><a href=#horizon_memory_limit-mb><code>HORIZON_MEMORY_LIMIT</code> (MB)</a></li><li><a href=#horizon_balance_strategy><code>HORIZON_BALANCE_STRATEGY</code></a></li><li><a href=#horizon_min_processes><code>HORIZON_MIN_PROCESSES</code></a></li><li><a href=#horizon_max_processes><code>HORIZON_MAX_PROCESSES</code></a></li><li><a href=#horizon_supervisor_memory><code>HORIZON_SUPERVISOR_MEMORY</code></a></li><li><a href=#horizon_supervisor_tries><code>HORIZON_SUPERVISOR_TRIES</code></a></li><li><a href=#horizon_supervisor_nice><code>HORIZON_SUPERVISOR_NICE</code></a></li><li><a href=#horizon_supervisor_timeout><code>HORIZON_SUPERVISOR_TIMEOUT</code></a></li><li><a href=#horizon_darkmode><code>HORIZON_DARKMODE</code></a></li></ol></li><li><a href=#image>IMAGE</a><ol><li><a href=#image_driver><code>IMAGE_DRIVER</code></a></li></ol></li><li><a href=#instance>INSTANCE</a><ol><li><a href=#force_https_urls><code>FORCE_HTTPS_URLS</code></a></li><li><a href=#instance_description><code>INSTANCE_DESCRIPTION</code></a></li><li><a href=#instance_contact_form><code>INSTANCE_CONTACT_FORM</code></a></li><li><a href=#instance_contact_max_per_day><code>INSTANCE_CONTACT_MAX_PER_DAY</code></a></li><li><a href=#instance_discover_public><code>INSTANCE_DISCOVER_PUBLIC</code></a></li><li><a href=#exp_loops-1><code>EXP_LOOPS</code></a></li><li><a href=#instance_public_hashtags><code>INSTANCE_PUBLIC_HASHTAGS</code></a></li><li><a href=#instance_contact_email><code>INSTANCE_CONTACT_EMAIL</code></a></li><li><a href=#pf_home_timeline_cache><code>PF_HOME_TIMELINE_CACHE</code></a></li><li><a href=#pf_home_timeline_cache_ttl><code>PF_HOME_TIMELINE_CACHE_TTL</code></a></li><li><a href=#instance_public_local_timeline><code>INSTANCE_PUBLIC_LOCAL_TIMELINE</code></a></li><li><a href=#instance_network_timeline_cached><code>INSTANCE_NETWORK_TIMELINE_CACHED</code></a></li><li><a href=#instance_network_timeline_cache_dropoff><code>INSTANCE_NETWORK_TIMELINE_CACHE_DROPOFF</code></a></li><li><a href=#instance_network_timeline_cache_max_hour_ingest><code>INSTANCE_NETWORK_TIMELINE_CACHE_MAX_HOUR_INGEST</code></a></li><li><a href=#page_404_header><code>PAGE_404_HEADER</code></a></li><li><a href=#page_404_body><code>PAGE_404_BODY</code></a></li><li><a href=#page_503_header><code>PAGE_503_HEADER</code></a></li><li><a href=#page_503_body><code>PAGE_503_BODY</code></a></li><li><a href=#banned_usernames><code>BANNED_USERNAMES</code></a></li><li><a href=#username_remote_format><code>USERNAME_REMOTE_FORMAT</code></a></li><li><a href=#username_remote_custom_text><code>USERNAME_REMOTE_CUSTOM_TEXT</code></a></li><li><a href=#stories_enabled><code>STORIES_ENABLED</code></a></li><li><a href=#restricted_instance><code>RESTRICTED_INSTANCE</code></a></li><li><a href=#oauth_token_days><code>OAUTH_TOKEN_DAYS</code></a></li><li><a href=#oauth_refresh_days><code>OAUTH_REFRESH_DAYS</code></a></li><li><a href=#oauth_pat_enabled><code>OAUTH_PAT_ENABLED</code></a></li><li><a href=#oauth_pat_id><code>OAUTH_PAT_ID</code></a></li><li><a href=#enable_covid_label><code>ENABLE_COVID_LABEL</code></a></li><li><a href=#covid_label_url><code>COVID_LABEL_URL</code></a></li><li><a href=#covid_label_org><code>COVID_LABEL_ORG</code></a></li><li><a href=#enable_config_cache><code>ENABLE_CONFIG_CACHE</code></a></li><li><a href=#instance_legal_notice><code>INSTANCE_LEGAL_NOTICE</code></a></li><li><a href=#instance_profile_embeds><code>INSTANCE_PROFILE_EMBEDS</code></a></li><li><a href=#instance_post_embeds><code>INSTANCE_POST_EMBEDS</code></a></li><li><a href=#pf_hide_nsfw_on_public_feeds><code>PF_HIDE_NSFW_ON_PUBLIC_FEEDS</code></a></li><li><a href=#pf_local_avatar_to_cloud><code>PF_LOCAL_AVATAR_TO_CLOUD</code></a></li><li><a href=#pf_admin_invites_enabled><code>PF_ADMIN_INVITES_ENABLED</code></a></li></ol></li><li><a href=#ldap>LDAP</a><ol><li><a href=#ldap_connection><code>LDAP_CONNECTION</code></a></li><li><a href=#default>DEFAULT</a></li><li><a href=#ldap_logging><code>LDAP_LOGGING</code></a></li><li><a href=#cache-1>CACHE</a></li></ol></li><li><a href=#livestreaming>LIVESTREAMING</a><ol><li><a href=#hls_live><code>HLS_LIVE</code></a></li><li><a href=#hls_live_host><code>HLS_LIVE_HOST</code></a></li><li><a href=#hls_live_port><code>HLS_LIVE_PORT</code></a></li><li><a href=#hls_live_path><code>HLS_LIVE_PATH</code></a></li><li><a href=#hls_live_broadcast_delete_token_after><code>HLS_LIVE_BROADCAST_DELETE_TOKEN_AFTER</code></a></li><li><a href=#hls_live_broadcast_max_duration><code>HLS_LIVE_BROADCAST_MAX_DURATION</code></a></li><li><a href=#hls_live_broadcast_max_active><code>HLS_LIVE_BROADCAST_MAX_ACTIVE</code></a></li><li><a href=#hls_live_broadcast_limits><code>HLS_LIVE_BROADCAST_LIMITS</code></a></li><li><a href=#hls_live_broadcast_limits_min_followers><code>HLS_LIVE_BROADCAST_LIMITS_MIN_FOLLOWERS</code></a></li><li><a href=#hls_live_broadcast_limits_min_account_age><code>HLS_LIVE_BROADCAST_LIMITS_MIN_ACCOUNT_AGE</code></a></li><li><a href=#hls_live_broadcast_limits_admins_only><code>HLS_LIVE_BROADCAST_LIMITS_ADMINS_ONLY</code></a></li><li><a href=#hls_live_broadcast_source_app><code>HLS_LIVE_BROADCAST_SOURCE_APP</code></a></li><li><a href=#hls_live_broadcast_source_web><code>HLS_LIVE_BROADCAST_SOURCE_WEB</code></a></li><li><a href=#hls_live_comments_max_falloff><code>HLS_LIVE_COMMENTS_MAX_FALLOFF</code></a></li></ol></li><li><a href=#logging>LOGGING</a><ol><li><a href=#log_channel><code>LOG_CHANNEL</code></a></li><li><a href=#log_level><code>LOG_LEVEL</code></a></li><li><a href=#log_slack_webhook_url><code>LOG_SLACK_WEBHOOK_URL</code></a></li><li><a href=#log_stderr_formatter><code>LOG_STDERR_FORMATTER</code></a></li></ol></li><li><a href=#mail>MAIL</a><ol><li><a href=#mail_driver><code>MAIL_DRIVER</code></a></li><li><a href=#mail_host><code>MAIL_HOST</code></a></li><li><a href=#mail_port><code>MAIL_PORT</code></a></li><li><a href=#mail_from_address><code>MAIL_FROM_ADDRESS</code></a></li><li><a href=#mail_from_name><code>MAIL_FROM_NAME</code></a></li><li><a href=#mail_encryption><code>MAIL_ENCRYPTION</code></a></li><li><a href=#mail_username><code>MAIL_USERNAME</code></a></li><li><a href=#mail_password><code>MAIL_PASSWORD</code></a></li></ol></li><li><a href=#media>MEDIA</a><ol><li><a href=#media_delete_local_after_cloud><code>MEDIA_DELETE_LOCAL_AFTER_CLOUD</code></a></li><li><a href=#media_exif_database><code>MEDIA_EXIF_DATABASE</code></a></li></ol></li><li><a href=#passport>PASSPORT</a><ol><li><a href=#passport_private_key><code>PASSPORT_PRIVATE_KEY</code></a></li><li><a href=#passport_public_key><code>PASSPORT_PUBLIC_KEY</code></a></li></ol></li><li><a href=#pixelfed>PIXELFED</a><ol><li><a href=#admin_domain><code>ADMIN_DOMAIN</code></a></li><li><a href=#app_domain><code>APP_DOMAIN</code></a></li><li><a href=#memory_limit><code>MEMORY_LIMIT</code></a></li><li><a href=#open_registration><code>OPEN_REGISTRATION</code></a></li><li><a href=#max_account_size-kb><code>MAX_ACCOUNT_SIZE</code> (kB)</a></li><li><a href=#max_photo_size-kb><code>MAX_PHOTO_SIZE</code> (kB)</a></li><li><a href=#max_avatar_size-kb><code>MAX_AVATAR_SIZE</code> (kB)</a></li><li><a href=#max_caption_length><code>MAX_CAPTION_LENGTH</code></a></li><li><a href=#max_bio_length><code>MAX_BIO_LENGTH</code></a></li><li><a href=#max_name_length><code>MAX_NAME_LENGTH</code></a></li><li><a href=#min_password_length><code>MIN_PASSWORD_LENGTH</code></a></li><li><a href=#max_album_length><code>MAX_ALBUM_LENGTH</code></a></li><li><a href=#enforce_email_verification><code>ENFORCE_EMAIL_VERIFICATION</code></a></li><li><a href=#image_quality><code>IMAGE_QUALITY</code></a></li><li><a href=#account_deletion><code>ACCOUNT_DELETION</code></a></li><li><a href=#account_delete_after><code>ACCOUNT_DELETE_AFTER</code></a></li><li><a href=#pf_enable_cloud><code>PF_ENABLE_CLOUD</code></a></li><li><a href=#pf_max_users><code>PF_MAX_USERS</code></a></li><li><a href=#pf_optimize_images><code>PF_OPTIMIZE_IMAGES</code></a></li><li><a href=#pf_optimize_videos><code>PF_OPTIMIZE_VIDEOS</code></a></li><li><a href=#pf_user_invites><code>PF_USER_INVITES</code></a></li><li><a href=#pf_user_invites_total_limit><code>PF_USER_INVITES_TOTAL_LIMIT</code></a></li><li><a href=#pf_user_invites_daily_limit><code>PF_USER_INVITES_DAILY_LIMIT</code></a></li><li><a href=#pf_user_invites_monthly_limit><code>PF_USER_INVITES_MONTHLY_LIMIT</code></a></li><li><a href=#pf_max_collection_length><code>PF_MAX_COLLECTION_LENGTH</code></a></li><li><a href=#media_types><code>MEDIA_TYPES</code></a></li><li><a href=#limit_account_size><code>LIMIT_ACCOUNT_SIZE</code></a></li><li><a href=#import_instagram><code>IMPORT_INSTAGRAM</code></a></li><li><a href=#import_instagram_post_limit><code>IMPORT_INSTAGRAM_POST_LIMIT</code></a></li><li><a href=#import_instagram_size_limit><code>IMPORT_INSTAGRAM_SIZE_LIMIT</code></a></li><li><a href=#oauth_enabled><code>OAUTH_ENABLED</code></a></li><li><a href=#pf_bouncer_enabled><code>PF_BOUNCER_ENABLED</code></a></li><li><a href=#pf_media_fast_process><code>PF_MEDIA_FAST_PROCESS</code></a></li><li><a href=#pf_media_max_alttext_length><code>PF_MEDIA_MAX_ALTTEXT_LENGTH</code></a></li><li><a href=#pf_allow_app_registration><code>PF_ALLOW_APP_REGISTRATION</code></a></li></ol></li><li><a href=#portfolio>PORTFOLIO</a><ol><li><a href=#portfolio_domain><code>PORTFOLIO_DOMAIN</code></a></li><li><a href=#portfolio_path><code>PORTFOLIO_PATH</code></a></li></ol></li><li><a href=#purify>PURIFY</a><ol><li><a href=#restrict_html_types><code>RESTRICT_HTML_TYPES</code></a></li></ol></li><li><a href=#resilient_mode><code>RESILIENT_MODE</code></a></li><li><a href=#queue>QUEUE</a><ol><li><a href=#queue_driver><code>QUEUE_DRIVER</code></a></li><li><a href=#sqs>SQS</a></li><li><a href=#db_connection-1>DB_CONNECTION</a></li></ol></li><li><a href=#services>SERVICES</a><ol><li><a href=#mailgun>MAILGUN</a></li><li><a href=#ses>SES</a></li><li><a href=#sparkpost>SPARKPOST</a></li><li><a href=#stripe>STRIPE</a></li></ol></li><li><a href=#session>SESSION</a><ol><li><a href=#session_driver><code>SESSION_DRIVER</code></a></li><li><a href=#session_lifetime><code>SESSION_LIFETIME</code></a></li><li><a href=#session_domain><code>SESSION_DOMAIN</code></a></li></ol></li><li><a href=#video-webp2p>VIDEO WEBP2P</a><ol><li><a href=#media_hls_enabled><code>MEDIA_HLS_ENABLED</code></a></li><li><a href=#media_hls_p2p><code>MEDIA_HLS_P2P</code></a></li><li><a href=#media_hls_bitrate><code>MEDIA_HLS_BITRATE</code></a></li><li><a href=#media_hls_p2p_tracker><code>MEDIA_HLS_P2P_TRACKER</code></a></li><li><a href=#media_hls_p2p_ice_server><code>MEDIA_HLS_P2P_ICE_SERVER</code></a></li><li><a href=#media_hls_debug><code>MEDIA_HLS_DEBUG</code></a></li><li><a href=#media_hls_p2p_debug><code>MEDIA_HLS_P2P_DEBUG</code></a></li></ol></li><li><a href=#telescope>TELESCOPE</a><ol><li><a href=#telescope_driver><code>TELESCOPE_DRIVER</code></a></li><li><a href=#telescope_enabled><code>TELESCOPE_ENABLED</code></a></li><li><a href=#telescope_cache_watcher><code>TELESCOPE_CACHE_WATCHER</code></a></li><li><a href=#telescope_command_watcher><code>TELESCOPE_COMMAND_WATCHER</code></a></li><li><a href=#telescope_dump_watcher><code>TELESCOPE_DUMP_WATCHER</code></a></li><li><a href=#telescope_event_watcher><code>TELESCOPE_EVENT_WATCHER</code></a></li><li><a href=#telescope_exception_watcher><code>TELESCOPE_EXCEPTION_WATCHER</code></a></li><li><a href=#telescope_job_watcher><code>TELESCOPE_JOB_WATCHER</code></a></li><li><a href=#telescope_log_watcher><code>TELESCOPE_LOG_WATCHER</code></a></li><li><a href=#telescope_mail_watcher><code>TELESCOPE_MAIL_WATCHER</code></a></li><li><a href=#telescope_model_watcher><code>TELESCOPE_MODEL_WATCHER</code></a></li><li><a href=#telescope_notification_watcher><code>TELESCOPE_NOTIFICATION_WATCHER</code></a></li><li><a href=#telescope_query_watcher><code>TELESCOPE_QUERY_WATCHER</code></a></li><li><a href=#telescope_redis_watcher><code>TELESCOPE_REDIS_WATCHER</code></a></li><li><a href=#telescope_request_watcher><code>TELESCOPE_REQUEST_WATCHER</code></a></li><li><a href=#telescope_response_size_limit><code>TELESCOPE_RESPONSE_SIZE_LIMIT</code></a></li><li><a href=#telescope_gate_watcher><code>TELESCOPE_GATE_WATCHER</code></a></li><li><a href=#telescope_schedule_watcher><code>TELESCOPE_SCHEDULE_WATCHER</code></a></li></ol></li><li><a href=#trustedproxy>TRUSTEDPROXY</a><ol><li><a href=#trust_proxies><code>TRUST_PROXIES</code></a></li></ol></li><li><a href=#websockets>WEBSOCKETS</a><ol><li><a href=#dashboard-settings>DASHBOARD SETTINGS</a></li><li><a href=#applications-repository>APPLICATIONS REPOSITORY</a></li><li><a href=#broadcasting-replication-pubsub>BROADCASTING REPLICATION PUBSUB</a></li><li><a href=#ssl-configuration>SSL CONFIGURATION</a></li></ol></li></ol></nav></details></div></aside><section class="content section"><div class=container><p>All configuration files are located in the <code>config/</code> folder of your Pixelfed installation. These are the environment variables you can set in your <code>.env</code> file; note that some variables are currently unused and do nothing.</p><div class='tip hint'><p><strong>Summary of important variables</strong></p><p>For a user-facing guide to which environment variables you might want to set, check out the
    5. 

  5. <a href=/running-pixelfed/installation/#configure-environment-variables>installation guide</a> instead.</p></div><h2 class=heading id=app><span class=heading__text>APP</span>
    6. 

  6. <a class=heading__anchor-link href=#app>[link]</a></h2><h3 class=heading id=app_name><span class=heading__text><code>APP_NAME</code></span>
    7. 

  7. <a class=heading__anchor-link href=#app_name>[link]</a></h3><p>This value is the name of your application. This value is used when the framework needs to place the application&rsquo;s name in a notification or any other location as required by the application or its packages. Defaults to <code>"Pixelfed"</code>.</p><h3 class=heading id=app_env><span class=heading__text><code>APP_ENV</code></span>
    8. 

  8. <a class=heading__anchor-link href=#app_env>[link]</a></h3><p>This value determines the &ldquo;environment&rdquo; your application is currently running in. This may determine how you prefer to configure various services your application utilizes. Set this in your &ldquo;.env&rdquo; file. Defaults to <code>"production"</code>.</p><h3 class=heading id=app_debug><span class=heading__text><code>APP_DEBUG</code></span>
    9. 

  9. <a class=heading__anchor-link href=#app_debug>[link]</a></h3><p>When your application is in debug mode, detailed error messages with stack traces will be shown on every error that occurs within your application. If disabled, a simple generic error page is shown. Defaults to <code>false</code>.</p><h3 class=heading id=app_url><span class=heading__text><code>APP_URL</code></span>
    10. 

  10. <a class=heading__anchor-link href=#app_url>[link]</a></h3><p>This URL is used by the console to properly generate URLs when using the Artisan command line tool. You should set this to the root of your application so that it is used when running Artisan tasks. Defaults to <code>"https://localhost"</code>.</p><h3 class=heading id=app_timezone><span class=heading__text><code>APP_TIMEZONE</code></span>
    11. 

  11. <a class=heading__anchor-link href=#app_timezone>[link]</a></h3><p>(Not listed on Admin > Diagnostics.) Defaults to <code>"UTC"</code>. Do not edit your timezone or things will break!</p><h3 class=heading id=app_locale><span class=heading__text><code>APP_LOCALE</code></span>
    12. 

  12. <a class=heading__anchor-link href=#app_locale>[link]</a></h3><p>The application locale determines the default locale that will be used by the translation service provider. You are free to set this value to any of the locales which will be supported by the application. Defaults to <code>"en"</code>.</p><h3 class=heading id=app_fallback_locale><span class=heading__text><code>APP_FALLBACK_LOCALE</code></span>
    13. 

  13. <a class=heading__anchor-link href=#app_fallback_locale>[link]</a></h3><p>The fallback locale determines the locale to use when the current one is not available. You may change the value to correspond to any of the language folders that are provided through your application. Defaults to <code>"en"</code>.</p><h3 class=heading id=app_key><span class=heading__text><code>APP_KEY</code></span>
    14. 

  14. <a class=heading__anchor-link href=#app_key>[link]</a></h3><p>(Not listed on Admin > Diagnostics.) A random 32-character string to be used as an encryption key. No default value; use <code>php artisan key:generate</code> to generate. This key is used by the Illuminate encrypter service and should be set to a random, 32 character string, otherwise these encrypted strings will not be safe. Please do this before deploying an application!</p><h2 class=heading id=backup><span class=heading__text>BACKUP</span>
    15. 

  15. <a class=heading__anchor-link href=#backup>[link]</a></h2><p>(Not listed on Admin > Diagnostics.)</p><h3 class=heading id=backup_archive_password><span class=heading__text><code>BACKUP_ARCHIVE_PASSWORD</code></span>
    16. 

  16. <a class=heading__anchor-link href=#backup_archive_password>[link]</a></h3><p>(Not listed on Admin > Diagnostics.) The password to be used for archive encryption. Set to <code>null</code> to disable encryption.</p><h3 class=heading id=backup_email_address><span class=heading__text><code>BACKUP_EMAIL_ADDRESS</code></span>
    17. 

  17. <a class=heading__anchor-link href=#backup_email_address>[link]</a></h3><p>(Not listed on Admin > Diagnostics.) Defaults to <code>""</code>.</p><h2 class=heading id=broadcasting><span class=heading__text>BROADCASTING</span>
    18. 

  18. <a class=heading__anchor-link href=#broadcasting>[link]</a></h2><h3 class=heading id=broadcast_driver><span class=heading__text><code>BROADCAST_DRIVER</code></span>
    19. 

  19. <a class=heading__anchor-link href=#broadcast_driver>[link]</a></h3><p>This option controls the default broadcaster that will be used by the framework when an event needs to be broadcast. Possible values:</p><ul><li><code>"pusher"</code></li><li><code>"redis"</code></li><li><code>"log"</code></li><li><code>"null"</code> (default)</li></ul><h3 class=heading id=pusher><span class=heading__text>PUSHER</span>
    20. 

  20. <a class=heading__anchor-link href=#pusher>[link]</a></h3><h4 class=heading id=pusher_app_key><span class=heading__text><code>PUSHER_APP_KEY</code></span>
    21. 

  21. <a class=heading__anchor-link href=#pusher_app_key>[link]</a></h4><p>(Not listed on Admin > Diagnostics.)</p><h4 class=heading id=pusher_app_secret><span class=heading__text><code>PUSHER_APP_SECRET</code></span>
    22. 

  22. <a class=heading__anchor-link href=#pusher_app_secret>[link]</a></h4><p>(Not listed on Admin > Diagnostics.)</p><h4 class=heading id=pusher_app_id><span class=heading__text><code>PUSHER_APP_ID</code></span>
    23. 

  23. <a class=heading__anchor-link href=#pusher_app_id>[link]</a></h4><p>(Not listed on Admin > Diagnostics.)</p><h4 class=heading id=pusher_app_cluster><span class=heading__text><code>PUSHER_APP_CLUSTER</code></span>
    24. 

  24. <a class=heading__anchor-link href=#pusher_app_cluster>[link]</a></h4><p>(Not listed on Admin > Diagnostics.)</p><h4 class=heading id=pusher_app_encrypted><span class=heading__text><code>PUSHER_APP_ENCRYPTED</code></span>
    25. 

  25. <a class=heading__anchor-link href=#pusher_app_encrypted>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) Defaults to <code>false</code>.</p><h4 class=heading id=pusher_host><span class=heading__text><code>PUSHER_HOST</code></span>
    26. 

  26. <a class=heading__anchor-link href=#pusher_host>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) Defaults to <code>APP_DOMAIN</code>.</p><h4 class=heading id=pusher_port><span class=heading__text><code>PUSHER_PORT</code></span>
    27. 

  27. <a class=heading__anchor-link href=#pusher_port>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) Defaults to <code>443</code>.</p><h4 class=heading id=pusher_scheme><span class=heading__text><code>PUSHER_SCHEME</code></span>
    28. 

  28. <a class=heading__anchor-link href=#pusher_scheme>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) Defaults to <code>"https"</code>.</p><h2 class=heading id=cache><span class=heading__text>CACHE</span>
    29. 

  29. <a class=heading__anchor-link href=#cache>[link]</a></h2><h3 class=heading id=cache_driver><span class=heading__text><code>CACHE_DRIVER</code></span>
    30. 

  30. <a class=heading__anchor-link href=#cache_driver>[link]</a></h3><p>This option controls the default cache connection that gets used while using this caching library. This connection is used when another is not explicitly specified when executing a given caching function. Possible values:</p><ul><li><code>"apc"</code></li><li><code>"array"</code></li><li><code>"database"</code></li><li><code>"file"</code> (default)</li><li><code>"memcached"</code></li><li><code>"redis"</code></li></ul><h3 class=heading id=cache_prefix><span class=heading__text><code>CACHE_PREFIX</code></span>
    31. 

  31. <a class=heading__anchor-link href=#cache_prefix>[link]</a></h3><p>(Not listed on Admin > Diagnostics.) Defaults to <code>${APP_NAME}_cache</code>, or <code>laravel_cache</code> if no <code>APP_NAME</code> is set.</p><h3 class=heading id=memcached><span class=heading__text>MEMCACHED</span>
    32. 

  32. <a class=heading__anchor-link href=#memcached>[link]</a></h3><p>(Not listed on Admin > Diagnostics.)</p><h4 class=heading id=memcached_persistent_id><span class=heading__text><code>MEMCACHED_PERSISTENT_ID</code></span>
    33. 

  33. <a class=heading__anchor-link href=#memcached_persistent_id>[link]</a></h4><p>(Not listed on Admin > Diagnostics.)</p><h4 class=heading id=memcached_username><span class=heading__text><code>MEMCACHED_USERNAME</code></span>
    34. 

  34. <a class=heading__anchor-link href=#memcached_username>[link]</a></h4><p>(Not listed on Admin > Diagnostics.)</p><h4 class=heading id=memcached_password><span class=heading__text><code>MEMCACHED_PASSWORD</code></span>
    35. 

  35. <a class=heading__anchor-link href=#memcached_password>[link]</a></h4><p>(Not listed on Admin > Diagnostics.)</p><h4 class=heading id=memcached_host><span class=heading__text><code>MEMCACHED_HOST</code></span>
    36. 

  36. <a class=heading__anchor-link href=#memcached_host>[link]</a></h4><p>Defaults to <code>"127.0.0.1"</code>.</p><h4 class=heading id=memcached_port><span class=heading__text><code>MEMCACHED_PORT</code></span>
    37. 

  37. <a class=heading__anchor-link href=#memcached_port>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) Defaults to <code>11211</code>.</p><h3 class=heading id=redis><span class=heading__text>REDIS</span>
    38. 

  38. <a class=heading__anchor-link href=#redis>[link]</a></h3><h4 class=heading id=redis_client><span class=heading__text><code>REDIS_CLIENT</code></span>
    39. 

  39. <a class=heading__anchor-link href=#redis_client>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) Defaults to <code>"phpredis"</code>.</p><h4 class=heading id=redis_scheme><span class=heading__text><code>REDIS_SCHEME</code></span>
    40. 

  40. <a class=heading__anchor-link href=#redis_scheme>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) Defaults to <code>"tcp"</code>.</p><h4 class=heading id=redis_path><span class=heading__text><code>REDIS_PATH</code></span>
    41. 

  41. <a class=heading__anchor-link href=#redis_path>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) No default value.</p><h4 class=heading id=redis_host><span class=heading__text><code>REDIS_HOST</code></span>
    42. 

  42. <a class=heading__anchor-link href=#redis_host>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) Defaults to <code>"localhost"</code>.</p><h4 class=heading id=redis_password><span class=heading__text><code>REDIS_PASSWORD</code></span>
    43. 

  43. <a class=heading__anchor-link href=#redis_password>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) Defaults to <code>null</code>.</p><h4 class=heading id=redis_port><span class=heading__text><code>REDIS_PORT</code></span>
    44. 

  44. <a class=heading__anchor-link href=#redis_port>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) Defaults to <code>6379</code>.</p><h4 class=heading id=redis_database><span class=heading__text><code>REDIS_DATABASE</code></span>
    45. 

  45. <a class=heading__anchor-link href=#redis_database>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) Defaults to <code>0</code>.</p><h2 class=heading id=captcha><span class=heading__text>CAPTCHA</span>
    46. 

  46. <a class=heading__anchor-link href=#captcha>[link]</a></h2><p>(Not listed on Admin > Diagnostics.) Use
    47. 

  47. <a href=https://www.hcaptcha.com/ target=_blank>hCaptcha<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 1e3 1e3" width="1em"><path fill="currentcolor" d="M609.34 13.31c-23.11 8.5-28.16 20.46-28.42 65.35.0 29.49.8 34.8 6.11 45.16 10.89 21.52 13.81 22.31 96.96 23.91l72.25 1.33L568.7 336.32C465.63 439.39 379.57 526.79 377.44 530.77c-4.78 9.3-4.78 24.17.0 33.47 2.13 3.98 15.67 18.86 30.28 33.47 24.17 23.91 27.36 26.3 38.52 27.36 6.64.8 15.41.53 19.66-.26 5.05-1.33 65.88-60.3 196.04-190.46C765.8 330.74 851.6 246.01 852.66 246.01s1.86 32.67 1.86 72.78c0 70.93.26 72.78 6.11 81.29 11.16 16.47 19.39 18.86 63.49 18.06 42.5-.8 46.49-2.12 58.97-19.13 5.58-7.17 5.58-10.36 6.37-180.37l.53-173.2-5.84-11.95c-3.72-6.91-9.83-14.08-15.41-17.27-9.03-5.05-14.08-5.31-179.31-5.84-137.59-.53-171.85.01-180.09 2.93z"/><path fill="currentcolor" d="M100.12 121.42c-29.75 5.05-57.91 24.44-73.58 50.47-17.8 29.49-17 10.63-16.2 390.49l.8 343.73 8.5 17.8c9.56 20.19 27.89 41.44 44.36 51 26.83 15.67 8.5 14.87 381.46 14.87 306.28.0 343.2-.53 356.22-4.25 38.25-11.42 68.01-43.57 76.51-82.88 2.13-9.83 2.92-81.82 2.92-235.62v-221.8H745.63v409.08H145.27V256.63h409.08V118.5l-219.68.27c-121.13.26-226.59 1.32-234.55 2.65z"/></svg></a> to protect your login from bots.</p><h3 class=heading id=captcha_enabled><span class=heading__text><code>CAPTCHA_ENABLED</code></span>
    48. 

  48. <a class=heading__anchor-link href=#captcha_enabled>[link]</a></h3><p>(Not listed on Admin > Diagnostics.) Defaults to <code>false</code>.</p><h3 class=heading id=captcha_secret><span class=heading__text><code>CAPTCHA_SECRET</code></span>
    49. 

  49. <a class=heading__anchor-link href=#captcha_secret>[link]</a></h3><p>(Not listed on Admin > Diagnostics.)</p><h3 class=heading id=captcha_sitekey><span class=heading__text><code>CAPTCHA_SITEKEY</code></span>
    50. 

  50. <a class=heading__anchor-link href=#captcha_sitekey>[link]</a></h3><p>(Not listed on Admin > Diagnostics.)</p><h2 class=heading id=costar><span class=heading__text>COSTAR</span>
    51. 

  51. <a class=heading__anchor-link href=#costar>[link]</a></h2><p>(Not listed on Admin > Diagnostics.) COSTAR - Confirm Object Sentiment Transform and Reduce</p><h3 class=heading id=cs_blocked_domains><span class=heading__text><code>CS_BLOCKED_DOMAINS</code></span>
    52. 

  52. <a class=heading__anchor-link href=#cs_blocked_domains>[link]</a></h3><p>(Not listed on Admin > Diagnostics.) Comma-separated list of domains to block. Defaults to <code>null</code>.</p><h3 class=heading id=cs_cw_domains><span class=heading__text><code>CS_CW_DOMAINS</code></span>
    53. 

  53. <a class=heading__anchor-link href=#cs_cw_domains>[link]</a></h3><p>(Not listed on Admin > Diagnostics.) Comma-separated list of domains to add warnings. Defaults to <code>null</code>.</p><h3 class=heading id=cs_unlisted_domains><span class=heading__text><code>CS_UNLISTED_DOMAINS</code></span>
    54. 

  54. <a class=heading__anchor-link href=#cs_unlisted_domains>[link]</a></h3><p>(Not listed on Admin > Diagnostics.) Comma-separated list of domains to remove from public timelines. Defaults to <code>null</code>.</p><h3 class=heading id=cs_blocked_keywords><span class=heading__text><code>CS_BLOCKED_KEYWORDS</code></span>
    55. 

  55. <a class=heading__anchor-link href=#cs_blocked_keywords>[link]</a></h3><p>(Not listed on Admin > Diagnostics.) Comma-separated list of keywords to block. Defaults to <code>null</code>.</p><h3 class=heading id=cs_cw_keywords><span class=heading__text><code>CS_CW_KEYWORDS</code></span>
    56. 

  56. <a class=heading__anchor-link href=#cs_cw_keywords>[link]</a></h3><p>(Not listed on Admin > Diagnostics.) Comma-separated list of keywords to add warnings. Defaults to <code>null</code>.</p><h3 class=heading id=cs_unlisted_keywords><span class=heading__text><code>CS_UNLISTED_KEYWORDS</code></span>
    57. 

  57. <a class=heading__anchor-link href=#cs_unlisted_keywords>[link]</a></h3><p>(Not listed on Admin > Diagnostics.) Comma-separated list of keywords to remove from public timelines. Defaults to <code>null</code>.</p><h3 class=heading id=cs_blocked_actor><span class=heading__text><code>CS_BLOCKED_ACTOR</code></span>
    58. 

  58. <a class=heading__anchor-link href=#cs_blocked_actor>[link]</a></h3><p>(Not listed on Admin > Diagnostics.) Defaults to <code>null</code>.</p><h3 class=heading id=cs_cw_actor><span class=heading__text><code>CS_CW_ACTOR</code></span>
    59. 

  59. <a class=heading__anchor-link href=#cs_cw_actor>[link]</a></h3><p>(Not listed on Admin > Diagnostics.) Defaults to <code>null</code>.</p><h3 class=heading id=cs_unlisted_actor><span class=heading__text><code>CS_UNLISTED_ACTOR</code></span>
    60. 

  60. <a class=heading__anchor-link href=#cs_unlisted_actor>[link]</a></h3><p>(Not listed on Admin > Diagnostics.) Defaults to <code>null</code>.</p><h2 class=heading id=database><span class=heading__text>DATABASE</span>
    61. 

  61. <a class=heading__anchor-link href=#database>[link]</a></h2><h3 class=heading id=db_connection><span class=heading__text><code>DB_CONNECTION</code></span>
    62. 

  62. <a class=heading__anchor-link href=#db_connection>[link]</a></h3><p>Here you may specify which of the database connections below you wish to use as your default connection for all database work. Of course you may use many connections at once using the Database library. Possible values:</p><ul><li><code>"sqlite"</code></li><li><code>"mysql"</code> (default)</li><li><code>"pgsql"</code></li><li><code>"sqlsrv"</code></li></ul><h3 class=heading id=sqlite><span class=heading__text>SQLITE</span>
    63. 

  63. <a class=heading__anchor-link href=#sqlite>[link]</a></h3><p>(Not listed on Admin > Diagnostics.) When using <code>sqlite</code> for <code>DB_CONNECTION</code>.</p><h4 class=heading id=db_database><span class=heading__text><code>DB_DATABASE</code></span>
    64. 

  64. <a class=heading__anchor-link href=#db_database>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) Defaults to <code>"database.sqlite"</code>.</p><h3 class=heading id=mysql><span class=heading__text>MYSQL</span>
    65. 

  65. <a class=heading__anchor-link href=#mysql>[link]</a></h3><p>(Not listed on Admin > Diagnostics.) When using <code>"mysql"</code> for <code>DB_CONNECTION</code>.</p><h4 class=heading id=db_host><span class=heading__text><code>DB_HOST</code></span>
    66. 

  66. <a class=heading__anchor-link href=#db_host>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) Defaults to <code>"127.0.0.1"</code>.</p><h4 class=heading id=db_port><span class=heading__text><code>DB_PORT</code></span>
    67. 

  67. <a class=heading__anchor-link href=#db_port>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) Defaults to <code>"3306"</code>.</p><h4 class=heading id=db_database-1><span class=heading__text><code>DB_DATABASE</code></span>
    68. 

  68. <a class=heading__anchor-link href=#db_database-1>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) Defaults to <code>"forge"</code></p><h4 class=heading id=db_username><span class=heading__text><code>DB_USERNAME</code></span>
    69. 

  69. <a class=heading__anchor-link href=#db_username>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) Defaults to <code>"forge"</code></p><h4 class=heading id=db_password><span class=heading__text><code>DB_PASSWORD</code></span>
    70. 

  70. <a class=heading__anchor-link href=#db_password>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) Defaults to <code>""</code>.</p><h4 class=heading id=db_socket><span class=heading__text><code>DB_SOCKET</code></span>
    71. 

  71. <a class=heading__anchor-link href=#db_socket>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) Defaults to <code>""</code>.</p><h3 class=heading id=pgsql><span class=heading__text>PGSQL</span>
    72. 

  72. <a class=heading__anchor-link href=#pgsql>[link]</a></h3><p>(Not listed on Admin > Diagnostics.) When using <code>"pgsql"</code> for <code>DB_CONNECTION</code>.</p><h4 class=heading id=db_host-1><span class=heading__text><code>DB_HOST</code></span>
    73. 

  73. <a class=heading__anchor-link href=#db_host-1>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) Defaults to <code>"127.0.0.1"</code>.</p><h4 class=heading id=db_port-1><span class=heading__text><code>DB_PORT</code></span>
    74. 

  74. <a class=heading__anchor-link href=#db_port-1>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) Defaults to <code>"5432"</code>.</p><h4 class=heading id=db_database-2><span class=heading__text><code>DB_DATABASE</code></span>
    75. 

  75. <a class=heading__anchor-link href=#db_database-2>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) Defaults to <code>forge</code>.</p><h4 class=heading id=db_username-1><span class=heading__text><code>DB_USERNAME</code></span>
    76. 

  76. <a class=heading__anchor-link href=#db_username-1>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) Defaults to <code>forge</code>.</p><h4 class=heading id=db_password-1><span class=heading__text><code>DB_PASSWORD</code></span>
    77. 

  77. <a class=heading__anchor-link href=#db_password-1>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) Defaults to <code>""</code>.</p><h3 class=heading id=sqlsrv><span class=heading__text>SQLSRV</span>
    78. 

  78. <a class=heading__anchor-link href=#sqlsrv>[link]</a></h3><p>When using <code>"sqlsrv"</code> for <code>DB_CONNECTION</code>.</p><h4 class=heading id=db_host-2><span class=heading__text><code>DB_HOST</code></span>
    79. 

  79. <a class=heading__anchor-link href=#db_host-2>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) Defaults to <code>"localhost"</code>.</p><h4 class=heading id=db_port-2><span class=heading__text><code>DB_PORT</code></span>
    80. 

  80. <a class=heading__anchor-link href=#db_port-2>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) Defaults to <code>"1433"</code>.</p><h4 class=heading id=db_database-3><span class=heading__text><code>DB_DATABASE</code></span>
    81. 

  81. <a class=heading__anchor-link href=#db_database-3>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) Defaults to <code>forge</code>.</p><h4 class=heading id=db_username-2><span class=heading__text><code>DB_USERNAME</code></span>
    82. 

  82. <a class=heading__anchor-link href=#db_username-2>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) Defaults to <code>forge</code>.</p><h4 class=heading id=db_password-2><span class=heading__text><code>DB_PASSWORD</code></span>
    83. 

  83. <a class=heading__anchor-link href=#db_password-2>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) Defaults to <code>""</code>.</p><h3 class=heading id=redis_client-1><span class=heading__text><code>REDIS_CLIENT</code></span>
    84. 

  84. <a class=heading__anchor-link href=#redis_client-1>[link]</a></h3><ul><li><code>"predis"</code> (default)</li><li><code>"phpredis"</code></li></ul><h4 class=heading id=redis_scheme-1><span class=heading__text><code>REDIS_SCHEME</code></span>
    85. 

  85. <a class=heading__anchor-link href=#redis_scheme-1>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) Defaults to <code>"tcp"</code>.</p><h4 class=heading id=redis_path-1><span class=heading__text><code>REDIS_PATH</code></span>
    86. 

  86. <a class=heading__anchor-link href=#redis_path-1>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) No default value.</p><h4 class=heading id=redis_host-1><span class=heading__text><code>REDIS_HOST</code></span>
    87. 

  87. <a class=heading__anchor-link href=#redis_host-1>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) Defaults to <code>"127.0.0.1"</code>.</p><h4 class=heading id=redis_password-1><span class=heading__text><code>REDIS_PASSWORD</code></span>
    88. 

  88. <a class=heading__anchor-link href=#redis_password-1>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) Defaults to <code>null</code>.</p><h4 class=heading id=redis_port-1><span class=heading__text><code>REDIS_PORT</code></span>
    89. 

  89. <a class=heading__anchor-link href=#redis_port-1>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) Defaults to <code>6379</code>.</p><h4 class=heading id=redis_database-1><span class=heading__text><code>REDIS_DATABASE</code></span>
    90. 

  90. <a class=heading__anchor-link href=#redis_database-1>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) Defaults to <code>0</code>.</p><h2 class=heading id=exp><span class=heading__text>EXP</span>
    91. 

  91. <a class=heading__anchor-link href=#exp>[link]</a></h2><p>Experimental configuration options. (Use at your own risk.)</p><h3 class=heading id=exp_lc><span class=heading__text><code>EXP_LC</code></span>
    92. 

  92. <a class=heading__anchor-link href=#exp_lc>[link]</a></h3><p>Hidden like counts (deprecated). Defaults to <code>false</code>.</p><h3 class=heading id=exp_rec><span class=heading__text><code>EXP_REC</code></span>
    93. 

  93. <a class=heading__anchor-link href=#exp_rec>[link]</a></h3><p>(Variable is ignored.) Recommendations (deprecated). Defaults to <code>false</code>.</p><h3 class=heading id=exp_loops><span class=heading__text><code>EXP_LOOPS</code></span>
    94. 

  94. <a class=heading__anchor-link href=#exp_loops>[link]</a></h3><p>(Variable is ignored.) Loops feature (deprecated). Defaults to <code>false</code>.</p><h3 class=heading id=exp_top><span class=heading__text><code>EXP_TOP</code></span>
    95. 

  95. <a class=heading__anchor-link href=#exp_top>[link]</a></h3><p>Text only posts (alpha). Defaults to <code>false</code>.</p><h3 class=heading id=exp_polls><span class=heading__text><code>EXP_POLLS</code></span>
    96. 

  96. <a class=heading__anchor-link href=#exp_polls>[link]</a></h3><p>Poll statuses (alpha). Defaults to <code>false</code>.</p><h3 class=heading id=exp_cpt><span class=heading__text><code>EXP_CPT</code></span>
    97. 

  97. <a class=heading__anchor-link href=#exp_cpt>[link]</a></h3><p>Cached public timeline for larger instances (beta). Defaults to <code>false</code>.</p><h3 class=heading id=exp_gps><span class=heading__text><code>EXP_GPS</code></span>
    98. 

  98. <a class=heading__anchor-link href=#exp_gps>[link]</a></h3><p>Groups (unreleased). Defaults to <code>false</code>.</p><h3 class=heading id=spa><span class=heading__text><code>spa</code></span>
    99. 

  99. <a class=heading__anchor-link href=#spa>[link]</a></h3><p>(Variable is ignored.) Single page application (beta). Defaults to <code>true</code>.</p><h3 class=heading id=exp_emc><span class=heading__text><code>EXP_EMC</code></span>
    100. 

  100. <a class=heading__anchor-link href=#exp_emc>[link]</a></h3><p>Enforce Mastoapi Compatibility (alpha). Defaults to <code>true</code>.</p><h2 class=heading id=federation><span class=heading__text>FEDERATION</span>
    101. 

  101. <a class=heading__anchor-link href=#federation>[link]</a></h2><h3 class=heading id=activitypub><span class=heading__text>ACTIVITYPUB</span>
    102. 

  102. <a class=heading__anchor-link href=#activitypub>[link]</a></h3><p>ActivityPub configuration.</p><h4 class=heading id=activity_pub><span class=heading__text><code>ACTIVITY_PUB</code></span>
    103. 

  103. <a class=heading__anchor-link href=#activity_pub>[link]</a></h4><p>Defaults to <code>false</code>.</p><h4 class=heading id=ap_outbox><span class=heading__text><code>AP_OUTBOX</code></span>
    104. 

  104. <a class=heading__anchor-link href=#ap_outbox>[link]</a></h4><p>Defaults to <code>true</code>.</p><h4 class=heading id=ap_inbox><span class=heading__text><code>AP_INBOX</code></span>
    105. 

  105. <a class=heading__anchor-link href=#ap_inbox>[link]</a></h4><p>Defaults to <code>true</code>.</p><h4 class=heading id=ap_sharedinbox><span class=heading__text><code>AP_SHAREDINBOX</code></span>
    106. 

  106. <a class=heading__anchor-link href=#ap_sharedinbox>[link]</a></h4><p>Defaults to <code>true</code>.</p><h4 class=heading id=ap_remote_follow><span class=heading__text><code>AP_REMOTE_FOLLOW</code></span>
    107. 

  107. <a class=heading__anchor-link href=#ap_remote_follow>[link]</a></h4><p>Defaults to <code>true</code>.</p><h4 class=heading id=activitypub_delivery_timeout><span class=heading__text><code>ACTIVITYPUB_DELIVERY_TIMEOUT</code></span>
    108. 

  108. <a class=heading__anchor-link href=#activitypub_delivery_timeout>[link]</a></h4><p>Defaults to <code>30.0</code>.</p><h4 class=heading id=activitypub_delivery_concurrency><span class=heading__text><code>ACTIVITYPUB_DELIVERY_CONCURRENCY</code></span>
    109. 

  109. <a class=heading__anchor-link href=#activitypub_delivery_concurrency>[link]</a></h4><p>Defaults to <code>10</code>.</p><h4 class=heading id=ap_logger_enabled><span class=heading__text><code>AP_LOGGER_ENABLED</code></span>
    110. 

  110. <a class=heading__anchor-link href=#ap_logger_enabled>[link]</a></h4><p>Defaults to <code>false</code>.</p><h3 class=heading id=atom_feeds><span class=heading__text><code>ATOM_FEEDS</code></span>
    111. 

  111. <a class=heading__anchor-link href=#atom_feeds>[link]</a></h3><p>Defaults to <code>true</code>.</p><h3 class=heading id=remote_avatars><span class=heading__text><code>REMOTE_AVATARS</code></span>
    112. 

  112. <a class=heading__anchor-link href=#remote_avatars>[link]</a></h3><p>Defaults to <code>true</code>.</p><h3 class=heading id=nodeinfo><span class=heading__text><code>NODEINFO</code></span>
    113. 

  113. <a class=heading__anchor-link href=#nodeinfo>[link]</a></h3><p>Defaults to <code>true</code>.</p><h3 class=heading id=webfinger><span class=heading__text><code>WEBFINGER</code></span>
    114. 

  114. <a class=heading__anchor-link href=#webfinger>[link]</a></h3><p>Defaults to <code>true</code>.</p><h3 class=heading id=pf_network_timeline><span class=heading__text><code>PF_NETWORK_TIMELINE</code></span>
    115. 

  115. <a class=heading__anchor-link href=#pf_network_timeline>[link]</a></h3><p>Defaults to <code>true</code>.</p><h3 class=heading id=pf_network_timeline_days_falloff><span class=heading__text><code>PF_NETWORK_TIMELINE_DAYS_FALLOFF</code></span>
    116. 

  116. <a class=heading__anchor-link href=#pf_network_timeline_days_falloff>[link]</a></h3><p>Defaults to <code>2</code>.</p><h3 class=heading id=custom_emoji><span class=heading__text><code>CUSTOM_EMOJI</code></span>
    117. 

  117. <a class=heading__anchor-link href=#custom_emoji>[link]</a></h3><p>Defaults to <code>false</code>.</p><h3 class=heading id=custom_emoji_max_size><span class=heading__text><code>CUSTOM_EMOJI_MAX_SIZE</code></span>
    118. 

  118. <a class=heading__anchor-link href=#custom_emoji_max_size>[link]</a></h3><p>Defaults to <code>2000000</code> (2MB).</p><h2 class=heading id=filesystems><span class=heading__text>FILESYSTEMS</span>
    119. 

  119. <a class=heading__anchor-link href=#filesystems>[link]</a></h2><h3 class=heading id=filesystem_driver><span class=heading__text><code>FILESYSTEM_DRIVER</code></span>
    120. 

  120. <a class=heading__anchor-link href=#filesystem_driver>[link]</a></h3><p>Here you may specify the default filesystem disk that should be used by the framework. The &ldquo;local&rdquo; disk, as well as a variety of cloud based disks are available to your application. Just store away! Possible options:</p><ul><li><code>"local"</code> (default)</li><li><code>"public"</code></li><li><code>"s3"</code></li><li><code>"spaces"</code></li><li><code>"backup"</code></li></ul><h3 class=heading id=filesystem_cloud><span class=heading__text><code>FILESYSTEM_CLOUD</code></span>
    121. 

  121. <a class=heading__anchor-link href=#filesystem_cloud>[link]</a></h3><p>Many applications store files both locally and in the cloud. For this reason, you may specify a default &ldquo;cloud&rdquo; driver here. This driver will be bound as the Cloud disk implementation in the container. Defaults to <code>"s3"</code>.</p><h3 class=heading id=s3><span class=heading__text>S3</span>
    122. 

  122. <a class=heading__anchor-link href=#s3>[link]</a></h3><p>(Not listed on Admin > Diagnostics.)</p><h4 class=heading id=aws_access_key_id><span class=heading__text><code>AWS_ACCESS_KEY_ID</code></span>
    123. 

  123. <a class=heading__anchor-link href=#aws_access_key_id>[link]</a></h4><p>(Not listed on Admin > Diagnostics.)</p><h4 class=heading id=aws_secret_access_key><span class=heading__text><code>AWS_SECRET_ACCESS_KEY</code></span>
    124. 

  124. <a class=heading__anchor-link href=#aws_secret_access_key>[link]</a></h4><p>(Not listed on Admin > Diagnostics.)</p><h4 class=heading id=aws_default_region><span class=heading__text><code>AWS_DEFAULT_REGION</code></span>
    125. 

  125. <a class=heading__anchor-link href=#aws_default_region>[link]</a></h4><p>(Not listed on Admin > Diagnostics.)</p><h4 class=heading id=aws_bucket><span class=heading__text><code>AWS_BUCKET</code></span>
    126. 

  126. <a class=heading__anchor-link href=#aws_bucket>[link]</a></h4><p>(Not listed on Admin > Diagnostics.)</p><h4 class=heading id=aws_url><span class=heading__text><code>AWS_URL</code></span>
    127. 

  127. <a class=heading__anchor-link href=#aws_url>[link]</a></h4><p>(Not listed on Admin > Diagnostics.)</p><h4 class=heading id=aws_endpoint><span class=heading__text><code>AWS_ENDPOINT</code></span>
    128. 

  128. <a class=heading__anchor-link href=#aws_endpoint>[link]</a></h4><p>(Not listed on Admin > Diagnostics.)</p><h4 class=heading id=aws_use_path_style_endpoint><span class=heading__text><code>AWS_USE_PATH_STYLE_ENDPOINT</code></span>
    129. 

  129. <a class=heading__anchor-link href=#aws_use_path_style_endpoint>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) Defaults to <code>false</code>.</p><h3 class=heading id=spaces><span class=heading__text>SPACES</span>
    130. 

  130. <a class=heading__anchor-link href=#spaces>[link]</a></h3><p>(Not listed on Admin > Diagnostics.)</p><h4 class=heading id=do_spaces_key><span class=heading__text><code>DO_SPACES_KEY</code></span>
    131. 

  131. <a class=heading__anchor-link href=#do_spaces_key>[link]</a></h4><p>(Not listed on Admin > Diagnostics.)</p><h4 class=heading id=do_spaces_secret><span class=heading__text><code>DO_SPACES_SECRET</code></span>
    132. 

  132. <a class=heading__anchor-link href=#do_spaces_secret>[link]</a></h4><p>(Not listed on Admin > Diagnostics.)</p><h4 class=heading id=do_spaces_endpoint><span class=heading__text><code>DO_SPACES_ENDPOINT</code></span>
    133. 

  133. <a class=heading__anchor-link href=#do_spaces_endpoint>[link]</a></h4><p>(Not listed on Admin > Diagnostics.)</p><h4 class=heading id=do_spaces_region><span class=heading__text><code>DO_SPACES_REGION</code></span>
    134. 

  134. <a class=heading__anchor-link href=#do_spaces_region>[link]</a></h4><p>(Not listed on Admin > Diagnostics.)</p><h4 class=heading id=do_spaces_bucket><span class=heading__text><code>DO_SPACES_BUCKET</code></span>
    135. 

  135. <a class=heading__anchor-link href=#do_spaces_bucket>[link]</a></h4><p>(Not listed on Admin > Diagnostics.)</p><h4 class=heading id=do_spaces_root><span class=heading__text><code>DO_SPACES_ROOT</code></span>
    136. 

  136. <a class=heading__anchor-link href=#do_spaces_root>[link]</a></h4><p>(Not listed on Admin > Diagnostics.)</p><h3 class=heading id=backup-1><span class=heading__text>BACKUP</span>
    137. 

  137. <a class=heading__anchor-link href=#backup-1>[link]</a></h3><p>(Not listed on Admin > Diagnostics.)</p><h4 class=heading id=pf_backup_driver><span class=heading__text><code>PF_BACKUP_DRIVER</code></span>
    138. 

  138. <a class=heading__anchor-link href=#pf_backup_driver>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) Defaults to <code>"s3"</code>.</p><h4 class=heading id=pf_backup_root><span class=heading__text><code>PF_BACKUP_ROOT</code></span>
    139. 

  139. <a class=heading__anchor-link href=#pf_backup_root>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) Defaults to <code>"/"</code>.</p><h4 class=heading id=pf_backup_key><span class=heading__text><code>PF_BACKUP_KEY</code></span>
    140. 

  140. <a class=heading__anchor-link href=#pf_backup_key>[link]</a></h4><p>(Not listed on Admin > Diagnostics.)</p><h4 class=heading id=pf_backup_secret><span class=heading__text><code>PF_BACKUP_SECRET</code></span>
    141. 

  141. <a class=heading__anchor-link href=#pf_backup_secret>[link]</a></h4><p>(Not listed on Admin > Diagnostics.)</p><h4 class=heading id=pf_backup_endpoint><span class=heading__text><code>PF_BACKUP_ENDPOINT</code></span>
    142. 

  142. <a class=heading__anchor-link href=#pf_backup_endpoint>[link]</a></h4><p>(Not listed on Admin > Diagnostics.)</p><h4 class=heading id=pf_backup_region><span class=heading__text><code>PF_BACKUP_REGION</code></span>
    143. 

  143. <a class=heading__anchor-link href=#pf_backup_region>[link]</a></h4><p>(Not listed on Admin > Diagnostics.)</p><h4 class=heading id=pf_backup_bucket><span class=heading__text><code>PF_BACKUP_BUCKET</code></span>
    144. 

  144. <a class=heading__anchor-link href=#pf_backup_bucket>[link]</a></h4><p>(Not listed on Admin > Diagnostics.)</p><h2 class=heading id=hashids><span class=heading__text>HASHIDS</span>
    145. 

  145. <a class=heading__anchor-link href=#hashids>[link]</a></h2><p>(Not listed on Admin > Diagnostics.)</p><h3 class=heading id=app_hashid_salt><span class=heading__text><code>APP_HASHID_SALT</code></span>
    146. 

  146. <a class=heading__anchor-link href=#app_hashid_salt>[link]</a></h3><p>(Not listed on Admin > Diagnostics.) Defaults to <code>"v3MsJ1Hgnlma8YPrD3f4sW6vAn6zLnkuh6vOpKnR5IKkLqDGIk7TCADS2igpEN4ADrtXkkzV2E8HBfzpz7BreDzQqVOYDMeb4cJ1xhDhDwDeicZVUPyrxihHDaMWpTsP"</code>.</p><h2 class=heading id=hashing><span class=heading__text>HASHING</span>
    147. 

  147. <a class=heading__anchor-link href=#hashing>[link]</a></h2><p>This option controls the default hash driver that will be used to hash passwords for your application. By default, the bcrypt algorithm is used; however, you remain free to modify this option if you wish. Possible drivers are <code>bcrypt</code> and <code>argon</code>, but this requires manual editing of <code>driver</code> (which is hardcoded as <code>bcrypt</code>).</p><h3 class=heading id=bcrypt><span class=heading__text>BCRYPT</span>
    148. 

  148. <a class=heading__anchor-link href=#bcrypt>[link]</a></h3><h4 class=heading id=bcrypt_cost><span class=heading__text><code>BCRYPT_COST</code></span>
    149. 

  149. <a class=heading__anchor-link href=#bcrypt_cost>[link]</a></h4><p>How many rounds of hashing to use. Defaults to <code>10</code>.</p><h3 class=heading id=argon><span class=heading__text>ARGON</span>
    150. 

  150. <a class=heading__anchor-link href=#argon>[link]</a></h3><p>(Not listed on Admin > Diagnostics.)</p><h4 class=heading id=argon_mem><span class=heading__text><code>ARGON_MEM</code></span>
    151. 

  151. <a class=heading__anchor-link href=#argon_mem>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) Defaults to <code>1024</code>.</p><h4 class=heading id=argon_threads><span class=heading__text><code>ARGON_THREADS</code></span>
    152. 

  152. <a class=heading__anchor-link href=#argon_threads>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) Defaults to <code>2</code>.</p><h4 class=heading id=argon_time><span class=heading__text><code>ARGON_TIME</code></span>
    153. 

  153. <a class=heading__anchor-link href=#argon_time>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) Defaults to <code>2</code>.</p><h2 class=heading id=horizon><span class=heading__text>HORIZON</span>
    154. 

  154. <a class=heading__anchor-link href=#horizon>[link]</a></h2><h3 class=heading id=horizon_prefix><span class=heading__text><code>HORIZON_PREFIX</code></span>
    155. 

  155. <a class=heading__anchor-link href=#horizon_prefix>[link]</a></h3><p>This prefix will be used when storing all Horizon data in Redis. You may modify the prefix when you are running multiple installations of Horizon on the same server so that they don&rsquo;t have problems. Defaults to <code>"horizon-"</code>.</p><h3 class=heading id=horizon_memory_limit-mb><span class=heading__text><code>HORIZON_MEMORY_LIMIT</code> (MB)</span>
    156. 

  156. <a class=heading__anchor-link href=#horizon_memory_limit-mb>[link]</a></h3><p>This value describes the maximum amount of memory (in MB) the Horizon worker may consume before it is terminated and restarted. You should set this value according to the resources available to your server. Defaults to <code>64</code>.</p><h3 class=heading id=horizon_balance_strategy><span class=heading__text><code>HORIZON_BALANCE_STRATEGY</code></span>
    157. 

  157. <a class=heading__anchor-link href=#horizon_balance_strategy>[link]</a></h3><p>Defaults to <code>"auto"</code>.</p><h3 class=heading id=horizon_min_processes><span class=heading__text><code>HORIZON_MIN_PROCESSES</code></span>
    158. 

  158. <a class=heading__anchor-link href=#horizon_min_processes>[link]</a></h3><p>Defaults to <code>1</code>.</p><h3 class=heading id=horizon_max_processes><span class=heading__text><code>HORIZON_MAX_PROCESSES</code></span>
    159. 

  159. <a class=heading__anchor-link href=#horizon_max_processes>[link]</a></h3><p>Defaults to <code>20</code>.</p><h3 class=heading id=horizon_supervisor_memory><span class=heading__text><code>HORIZON_SUPERVISOR_MEMORY</code></span>
    160. 

  160. <a class=heading__anchor-link href=#horizon_supervisor_memory>[link]</a></h3><p>Defaults to <code>64</code>.</p><h3 class=heading id=horizon_supervisor_tries><span class=heading__text><code>HORIZON_SUPERVISOR_TRIES</code></span>
    161. 

  161. <a class=heading__anchor-link href=#horizon_supervisor_tries>[link]</a></h3><p>Defaults to <code>3</code>.</p><h3 class=heading id=horizon_supervisor_nice><span class=heading__text><code>HORIZON_SUPERVISOR_NICE</code></span>
    162. 

  162. <a class=heading__anchor-link href=#horizon_supervisor_nice>[link]</a></h3><p>Defaults to <code>0</code>.</p><h3 class=heading id=horizon_supervisor_timeout><span class=heading__text><code>HORIZON_SUPERVISOR_TIMEOUT</code></span>
    163. 

  163. <a class=heading__anchor-link href=#horizon_supervisor_timeout>[link]</a></h3><p>Defaults to <code>300</code>.</p><h3 class=heading id=horizon_darkmode><span class=heading__text><code>HORIZON_DARKMODE</code></span>
    164. 

  164. <a class=heading__anchor-link href=#horizon_darkmode>[link]</a></h3><p>Defaults to <code>false</code>.</p><h2 class=heading id=image><span class=heading__text>IMAGE</span>
    165. 

  165. <a class=heading__anchor-link href=#image>[link]</a></h2><h3 class=heading id=image_driver><span class=heading__text><code>IMAGE_DRIVER</code></span>
    166. 

  166. <a class=heading__anchor-link href=#image_driver>[link]</a></h3><p>Pixelfed supports
    167. 

  167. <a href=https://libgd.github.io/ target=_blank>GD<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 1e3 1e3" width="1em"><path fill="currentcolor" d="M609.34 13.31c-23.11 8.5-28.16 20.46-28.42 65.35.0 29.49.8 34.8 6.11 45.16 10.89 21.52 13.81 22.31 96.96 23.91l72.25 1.33L568.7 336.32C465.63 439.39 379.57 526.79 377.44 530.77c-4.78 9.3-4.78 24.17.0 33.47 2.13 3.98 15.67 18.86 30.28 33.47 24.17 23.91 27.36 26.3 38.52 27.36 6.64.8 15.41.53 19.66-.26 5.05-1.33 65.88-60.3 196.04-190.46C765.8 330.74 851.6 246.01 852.66 246.01s1.86 32.67 1.86 72.78c0 70.93.26 72.78 6.11 81.29 11.16 16.47 19.39 18.86 63.49 18.06 42.5-.8 46.49-2.12 58.97-19.13 5.58-7.17 5.58-10.36 6.37-180.37l.53-173.2-5.84-11.95c-3.72-6.91-9.83-14.08-15.41-17.27-9.03-5.05-14.08-5.31-179.31-5.84-137.59-.53-171.85.01-180.09 2.93z"/><path fill="currentcolor" d="M100.12 121.42c-29.75 5.05-57.91 24.44-73.58 50.47-17.8 29.49-17 10.63-16.2 390.49l.8 343.73 8.5 17.8c9.56 20.19 27.89 41.44 44.36 51 26.83 15.67 8.5 14.87 381.46 14.87 306.28.0 343.2-.53 356.22-4.25 38.25-11.42 68.01-43.57 76.51-82.88 2.13-9.83 2.92-81.82 2.92-235.62v-221.8H745.63v409.08H145.27V256.63h409.08V118.5l-219.68.27c-121.13.26-226.59 1.32-234.55 2.65z"/></svg></a> or
    168. 

  168. <a href=https://imagemagick.org/ target=_blank>ImageMagick<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 1e3 1e3" width="1em"><path fill="currentcolor" d="M609.34 13.31c-23.11 8.5-28.16 20.46-28.42 65.35.0 29.49.8 34.8 6.11 45.16 10.89 21.52 13.81 22.31 96.96 23.91l72.25 1.33L568.7 336.32C465.63 439.39 379.57 526.79 377.44 530.77c-4.78 9.3-4.78 24.17.0 33.47 2.13 3.98 15.67 18.86 30.28 33.47 24.17 23.91 27.36 26.3 38.52 27.36 6.64.8 15.41.53 19.66-.26 5.05-1.33 65.88-60.3 196.04-190.46C765.8 330.74 851.6 246.01 852.66 246.01s1.86 32.67 1.86 72.78c0 70.93.26 72.78 6.11 81.29 11.16 16.47 19.39 18.86 63.49 18.06 42.5-.8 46.49-2.12 58.97-19.13 5.58-7.17 5.58-10.36 6.37-180.37l.53-173.2-5.84-11.95c-3.72-6.91-9.83-14.08-15.41-17.27-9.03-5.05-14.08-5.31-179.31-5.84-137.59-.53-171.85.01-180.09 2.93z"/><path fill="currentcolor" d="M100.12 121.42c-29.75 5.05-57.91 24.44-73.58 50.47-17.8 29.49-17 10.63-16.2 390.49l.8 343.73 8.5 17.8c9.56 20.19 27.89 41.44 44.36 51 26.83 15.67 8.5 14.87 381.46 14.87 306.28.0 343.2-.53 356.22-4.25 38.25-11.42 68.01-43.57 76.51-82.88 2.13-9.83 2.92-81.82 2.92-235.62v-221.8H745.63v409.08H145.27V256.63h409.08V118.5l-219.68.27c-121.13.26-226.59 1.32-234.55 2.65z"/></svg></a> to process images. Defaults to <code>gd</code>. Set <code>IMAGE_DRIVER=imagick</code> to use ImageMagick instead.</p><h2 class=heading id=instance><span class=heading__text>INSTANCE</span>
    169. 

  169. <a class=heading__anchor-link href=#instance>[link]</a></h2><h3 class=heading id=force_https_urls><span class=heading__text><code>FORCE_HTTPS_URLS</code></span>
    170. 

  170. <a class=heading__anchor-link href=#force_https_urls>[link]</a></h3><p>(Not listed on Admin > Diagnostics.) Defaults to <code>true</code>.</p><h3 class=heading id=instance_description><span class=heading__text><code>INSTANCE_DESCRIPTION</code></span>
    171. 

  171. <a class=heading__anchor-link href=#instance_description>[link]</a></h3><p>Defaults to <code>"Pixelfed - Photo sharing for everyone"</code>.</p><h3 class=heading id=instance_contact_form><span class=heading__text><code>INSTANCE_CONTACT_FORM</code></span>
    172. 

  172. <a class=heading__anchor-link href=#instance_contact_form>[link]</a></h3><p>Defaults to <code>false</code>.</p><h3 class=heading id=instance_contact_max_per_day><span class=heading__text><code>INSTANCE_CONTACT_MAX_PER_DAY</code></span>
    173. 

  173. <a class=heading__anchor-link href=#instance_contact_max_per_day>[link]</a></h3><p>Defaults to <code>1</code>.</p><h3 class=heading id=instance_discover_public><span class=heading__text><code>INSTANCE_DISCOVER_PUBLIC</code></span>
    174. 

  174. <a class=heading__anchor-link href=#instance_discover_public>[link]</a></h3><p>Defaults to <code>false</code>.</p><h3 class=heading id=exp_loops-1><span class=heading__text><code>EXP_LOOPS</code></span>
    175. 

  175. <a class=heading__anchor-link href=#exp_loops-1>[link]</a></h3><p>See
    176. 

  176. <a href=#exp><code>EXP</code></a>, although here it actually is used. Defaults to <code>false</code>.</p><h3 class=heading id=instance_public_hashtags><span class=heading__text><code>INSTANCE_PUBLIC_HASHTAGS</code></span>
    177. 

  177. <a class=heading__anchor-link href=#instance_public_hashtags>[link]</a></h3><p>Defaults to <code>false</code>.</p><h3 class=heading id=instance_contact_email><span class=heading__text><code>INSTANCE_CONTACT_EMAIL</code></span>
    178. 

  178. <a class=heading__anchor-link href=#instance_contact_email>[link]</a></h3><p>Defaults to <code>""</code>.</p><h3 class=heading id=pf_home_timeline_cache><span class=heading__text><code>PF_HOME_TIMELINE_CACHE</code></span>
    179. 

  179. <a class=heading__anchor-link href=#pf_home_timeline_cache>[link]</a></h3><p>Defaults to <code>false</code>.</p><h3 class=heading id=pf_home_timeline_cache_ttl><span class=heading__text><code>PF_HOME_TIMELINE_CACHE_TTL</code></span>
    180. 

  180. <a class=heading__anchor-link href=#pf_home_timeline_cache_ttl>[link]</a></h3><p>Defaults to <code>900</code>.</p><h3 class=heading id=instance_public_local_timeline><span class=heading__text><code>INSTANCE_PUBLIC_LOCAL_TIMELINE</code></span>
    181. 

  181. <a class=heading__anchor-link href=#instance_public_local_timeline>[link]</a></h3><p>Defaults to <code>false</code>.</p><h3 class=heading id=instance_network_timeline_cached><span class=heading__text><code>INSTANCE_NETWORK_TIMELINE_CACHED</code></span>
    182. 

  182. <a class=heading__anchor-link href=#instance_network_timeline_cached>[link]</a></h3><p>Defaults to <code>true</code>. Only used when
    183. 

  183. <a href=#pf_network_timeline><code>PF_NETWORK_TIMELINE</code></a> is <code>true</code>.</p><h3 class=heading id=instance_network_timeline_cache_dropoff><span class=heading__text><code>INSTANCE_NETWORK_TIMELINE_CACHE_DROPOFF</code></span>
    184. 

  184. <a class=heading__anchor-link href=#instance_network_timeline_cache_dropoff>[link]</a></h3><p>Defaults to <code>100</code>.</p><h3 class=heading id=instance_network_timeline_cache_max_hour_ingest><span class=heading__text><code>INSTANCE_NETWORK_TIMELINE_CACHE_MAX_HOUR_INGEST</code></span>
    185. 

  185. <a class=heading__anchor-link href=#instance_network_timeline_cache_max_hour_ingest>[link]</a></h3><p>Defaults to <code>6</code>.</p><h3 class=heading id=page_404_header><span class=heading__text><code>PAGE_404_HEADER</code></span>
    186. 

  186. <a class=heading__anchor-link href=#page_404_header>[link]</a></h3><p>Defaults to <code>"Sorry, this page isn't available."</code>.</p><h3 class=heading id=page_404_body><span class=heading__text><code>PAGE_404_BODY</code></span>
    187. 

  187. <a class=heading__anchor-link href=#page_404_body>[link]</a></h3><p>Defaults to <code>""The link you followed may be broken, or the page may have been removed. &lt;a href="/">Go back to Pixelfed.&lt;/a>""</code>.</p><h3 class=heading id=page_503_header><span class=heading__text><code>PAGE_503_HEADER</code></span>
    188. 

  188. <a class=heading__anchor-link href=#page_503_header>[link]</a></h3><p>Defaults to <code>"Service Unavailable"</code>.</p><h3 class=heading id=page_503_body><span class=heading__text><code>PAGE_503_BODY</code></span>
    189. 

  189. <a class=heading__anchor-link href=#page_503_body>[link]</a></h3><p>Defaults to <code>"Our service is in maintenance mode, please try again later."</code>.</p><h3 class=heading id=banned_usernames><span class=heading__text><code>BANNED_USERNAMES</code></span>
    190. 

  190. <a class=heading__anchor-link href=#banned_usernames>[link]</a></h3><p>Defaults to <code>""</code>.</p><h3 class=heading id=username_remote_format><span class=heading__text><code>USERNAME_REMOTE_FORMAT</code></span>
    191. 

  191. <a class=heading__anchor-link href=#username_remote_format>[link]</a></h3><p>Possible values:</p><ul><li><code>"@"</code> (default)</li><li><code>"from"</code></li><li><code>"custom"</code></li></ul><h3 class=heading id=username_remote_custom_text><span class=heading__text><code>USERNAME_REMOTE_CUSTOM_TEXT</code></span>
    192. 

  192. <a class=heading__anchor-link href=#username_remote_custom_text>[link]</a></h3><p>Used when <code>USERNAME_REMOTE_FORMAT="custom"</code>. Defaults to <code>null</code>.</p><h3 class=heading id=stories_enabled><span class=heading__text><code>STORIES_ENABLED</code></span>
    193. 

  193. <a class=heading__anchor-link href=#stories_enabled>[link]</a></h3><p>Defaults to <code>false</code>.</p><h3 class=heading id=restricted_instance><span class=heading__text><code>RESTRICTED_INSTANCE</code></span>
    194. 

  194. <a class=heading__anchor-link href=#restricted_instance>[link]</a></h3><p>Defaults to <code>false</code>. Level is hardcoded to <code>1</code>.</p><h3 class=heading id=oauth_token_days><span class=heading__text><code>OAUTH_TOKEN_DAYS</code></span>
    195. 

  195. <a class=heading__anchor-link href=#oauth_token_days>[link]</a></h3><p>Defaults to <code>365</code>.</p><h3 class=heading id=oauth_refresh_days><span class=heading__text><code>OAUTH_REFRESH_DAYS</code></span>
    196. 

  196. <a class=heading__anchor-link href=#oauth_refresh_days>[link]</a></h3><p>Defaults to <code>400</code>.</p><h3 class=heading id=oauth_pat_enabled><span class=heading__text><code>OAUTH_PAT_ENABLED</code></span>
    197. 

  197. <a class=heading__anchor-link href=#oauth_pat_enabled>[link]</a></h3><p>Defaults to <code>false</code>.</p><h3 class=heading id=oauth_pat_id><span class=heading__text><code>OAUTH_PAT_ID</code></span>
    198. 

  198. <a class=heading__anchor-link href=#oauth_pat_id>[link]</a></h3><p>Defaults to <code>""</code>.</p><h3 class=heading id=enable_covid_label><span class=heading__text><code>ENABLE_COVID_LABEL</code></span>
    199. 

  199. <a class=heading__anchor-link href=#enable_covid_label>[link]</a></h3><p>Defaults to <code>true</code>.</p><h3 class=heading id=covid_label_url><span class=heading__text><code>COVID_LABEL_URL</code></span>
    200. 

  200. <a class=heading__anchor-link href=#covid_label_url>[link]</a></h3><p>Defaults to <code>"https://www.who.int/emergencies/diseases/novel-coronavirus-2019/advice-for-public"</code>.</p><h3 class=heading id=covid_label_org><span class=heading__text><code>COVID_LABEL_ORG</code></span>
    201. 

  201. <a class=heading__anchor-link href=#covid_label_org>[link]</a></h3><p>Defaults to <code>"visit the WHO website"</code>.</p><h3 class=heading id=enable_config_cache><span class=heading__text><code>ENABLE_CONFIG_CACHE</code></span>
    202. 

  202. <a class=heading__anchor-link href=#enable_config_cache>[link]</a></h3><p>Whether Admin > Settings can be used to override your <code>.env</code>. Defaults to <code>false</code>.</p><h3 class=heading id=instance_legal_notice><span class=heading__text><code>INSTANCE_LEGAL_NOTICE</code></span>
    203. 

  203. <a class=heading__anchor-link href=#instance_legal_notice>[link]</a></h3><p>Defaults to <code>false</code>.</p><h3 class=heading id=instance_profile_embeds><span class=heading__text><code>INSTANCE_PROFILE_EMBEDS</code></span>
    204. 

  204. <a class=heading__anchor-link href=#instance_profile_embeds>[link]</a></h3><p>Defaults to <code>true</code>.</p><h3 class=heading id=instance_post_embeds><span class=heading__text><code>INSTANCE_POST_EMBEDS</code></span>
    205. 

  205. <a class=heading__anchor-link href=#instance_post_embeds>[link]</a></h3><p>Defaults to <code>true</code>.</p><h3 class=heading id=pf_hide_nsfw_on_public_feeds><span class=heading__text><code>PF_HIDE_NSFW_ON_PUBLIC_FEEDS</code></span>
    206. 

  206. <a class=heading__anchor-link href=#pf_hide_nsfw_on_public_feeds>[link]</a></h3><p>Defaults to <code>false</code>.</p><h3 class=heading id=pf_local_avatar_to_cloud><span class=heading__text><code>PF_LOCAL_AVATAR_TO_CLOUD</code></span>
    207. 

  207. <a class=heading__anchor-link href=#pf_local_avatar_to_cloud>[link]</a></h3><p>Defaults to <code>false</code>.</p><h3 class=heading id=pf_admin_invites_enabled><span class=heading__text><code>PF_ADMIN_INVITES_ENABLED</code></span>
    208. 

  208. <a class=heading__anchor-link href=#pf_admin_invites_enabled>[link]</a></h3><p>Defaults to <code>true</code>.</p><h2 class=heading id=ldap><span class=heading__text>LDAP</span>
    209. 

  209. <a class=heading__anchor-link href=#ldap>[link]</a></h2><p>Here you may specify which of the LDAP connections below you wish to use as your default connection for all LDAP operations. Of course you may add as many connections you&rsquo;d like below.</p><h3 class=heading id=ldap_connection><span class=heading__text><code>LDAP_CONNECTION</code></span>
    210. 

  210. <a class=heading__anchor-link href=#ldap_connection>[link]</a></h3><p>Defaults to <code>"default"</code>.</p><h3 class=heading id=default><span class=heading__text>DEFAULT</span>
    211. 

  211. <a class=heading__anchor-link href=#default>[link]</a></h3><p>(Not listed on Admin > Diagnostics.)</p><h4 class=heading id=ldap_host><span class=heading__text><code>LDAP_HOST</code></span>
    212. 

  212. <a class=heading__anchor-link href=#ldap_host>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) Defaults to <code>"127.0.0.1"</code>.</p><h4 class=heading id=ldap_username><span class=heading__text><code>LDAP_USERNAME</code></span>
    213. 

  213. <a class=heading__anchor-link href=#ldap_username>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) Defaults <code>"cn=user,dc=local,dc=com"</code>.</p><h4 class=heading id=ldap_password><span class=heading__text><code>LDAP_PASSWORD</code></span>
    214. 

  214. <a class=heading__anchor-link href=#ldap_password>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) Defaults to <code>"secret"</code>.</p><h4 class=heading id=ldap_port><span class=heading__text><code>LDAP_PORT</code></span>
    215. 

  215. <a class=heading__anchor-link href=#ldap_port>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) Defaults to <code>389</code>.</p><h4 class=heading id=ldap_base_dn><span class=heading__text><code>LDAP_BASE_DN</code></span>
    216. 

  216. <a class=heading__anchor-link href=#ldap_base_dn>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) Defaults to <code>"dc=local,dc=com"</code>.</p><h4 class=heading id=ldap_timeout><span class=heading__text><code>LDAP_TIMEOUT</code></span>
    217. 

  217. <a class=heading__anchor-link href=#ldap_timeout>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) Defaults to <code>5</code>.</p><h4 class=heading id=ldap_ssl><span class=heading__text><code>LDAP_SSL</code></span>
    218. 

  218. <a class=heading__anchor-link href=#ldap_ssl>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) Defaults to <code>false</code>.</p><h4 class=heading id=ldap_tls><span class=heading__text><code>LDAP_TLS</code></span>
    219. 

  219. <a class=heading__anchor-link href=#ldap_tls>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) Defaults to <code>false</code>.</p><h3 class=heading id=ldap_logging><span class=heading__text><code>LDAP_LOGGING</code></span>
    220. 

  220. <a class=heading__anchor-link href=#ldap_logging>[link]</a></h3><p>When LDAP logging is enabled, all LDAP search and authentication operations are logged using the default application logging driver. This can assist in debugging issues and more. Defaults to <code>true</code>.</p><h3 class=heading id=cache-1><span class=heading__text>CACHE</span>
    221. 

  221. <a class=heading__anchor-link href=#cache-1>[link]</a></h3><p>LDAP caching enables the ability of caching search results using the
    222. 

  222. query builder. This is great for running expensive operations that
    223. 

  223. may take many seconds to complete, such as a pagination request.</p><h4 class=heading id=ldap_cache><span class=heading__text><code>LDAP_CACHE</code></span>
    224. 

  224. <a class=heading__anchor-link href=#ldap_cache>[link]</a></h4><p>Defaults to <code>false</code>.</p><h4 class=heading id=cache_driver-1><span class=heading__text><code>CACHE_DRIVER</code></span>
    225. 

  225. <a class=heading__anchor-link href=#cache_driver-1>[link]</a></h4><p>See
    226. 

  226. <a href=#cache><code>CACHE</code></a>. Defaults to <code>"file"</code>.</p><h2 class=heading id=livestreaming><span class=heading__text>LIVESTREAMING</span>
    227. 

  227. <a class=heading__anchor-link href=#livestreaming>[link]</a></h2><p>(Not listed on Admin > Diagnostics.)</p><h3 class=heading id=hls_live><span class=heading__text><code>HLS_LIVE</code></span>
    228. 

  228. <a class=heading__anchor-link href=#hls_live>[link]</a></h3><p>(Not listed on Admin > Diagnostics.) Defaults to <code>false</code>.</p><h3 class=heading id=hls_live_host><span class=heading__text><code>HLS_LIVE_HOST</code></span>
    229. 

  229. <a class=heading__anchor-link href=#hls_live_host>[link]</a></h3><p>(Not listed on Admin > Diagnostics.) Defaults to <code>APP_DOMAIN</code> or <code>"localhost"</code>.</p><h3 class=heading id=hls_live_port><span class=heading__text><code>HLS_LIVE_PORT</code></span>
    230. 

  230. <a class=heading__anchor-link href=#hls_live_port>[link]</a></h3><p>(Not listed on Admin > Diagnostics.) Defaults to <code>1935</code>.</p><h3 class=heading id=hls_live_path><span class=heading__text><code>HLS_LIVE_PATH</code></span>
    231. 

  231. <a class=heading__anchor-link href=#hls_live_path>[link]</a></h3><p>(Not listed on Admin > Diagnostics.) Defaults to <code>"live"</code>.</p><h3 class=heading id=hls_live_broadcast_delete_token_after><span class=heading__text><code>HLS_LIVE_BROADCAST_DELETE_TOKEN_AFTER</code></span>
    232. 

  232. <a class=heading__anchor-link href=#hls_live_broadcast_delete_token_after>[link]</a></h3><p>(Not listed on Admin > Diagnostics.) Defaults to <code>true</code>.</p><h3 class=heading id=hls_live_broadcast_max_duration><span class=heading__text><code>HLS_LIVE_BROADCAST_MAX_DURATION</code></span>
    233. 

  233. <a class=heading__anchor-link href=#hls_live_broadcast_max_duration>[link]</a></h3><p>(Not listed on Admin > Diagnostics.) Defaults to <code>60</code>.</p><h3 class=heading id=hls_live_broadcast_max_active><span class=heading__text><code>HLS_LIVE_BROADCAST_MAX_ACTIVE</code></span>
    234. 

  234. <a class=heading__anchor-link href=#hls_live_broadcast_max_active>[link]</a></h3><p>(Not listed on Admin > Diagnostics.) Defaults to <code>10</code>.</p><h3 class=heading id=hls_live_broadcast_limits><span class=heading__text><code>HLS_LIVE_BROADCAST_LIMITS</code></span>
    235. 

  235. <a class=heading__anchor-link href=#hls_live_broadcast_limits>[link]</a></h3><p>(Not listed on Admin > Diagnostics.) Defaults to <code>true</code>.</p><h3 class=heading id=hls_live_broadcast_limits_min_followers><span class=heading__text><code>HLS_LIVE_BROADCAST_LIMITS_MIN_FOLLOWERS</code></span>
    236. 

  236. <a class=heading__anchor-link href=#hls_live_broadcast_limits_min_followers>[link]</a></h3><p>(Not listed on Admin > Diagnostics.) Defaults to <code>100</code>.</p><h3 class=heading id=hls_live_broadcast_limits_min_account_age><span class=heading__text><code>HLS_LIVE_BROADCAST_LIMITS_MIN_ACCOUNT_AGE</code></span>
    237. 

  237. <a class=heading__anchor-link href=#hls_live_broadcast_limits_min_account_age>[link]</a></h3><p>(Not listed on Admin > Diagnostics.) Defaults to <code>14</code>.</p><h3 class=heading id=hls_live_broadcast_limits_admins_only><span class=heading__text><code>HLS_LIVE_BROADCAST_LIMITS_ADMINS_ONLY</code></span>
    238. 

  238. <a class=heading__anchor-link href=#hls_live_broadcast_limits_admins_only>[link]</a></h3><p>(Not listed on Admin > Diagnostics.) Defaults to <code>true</code>.</p><h3 class=heading id=hls_live_broadcast_source_app><span class=heading__text><code>HLS_LIVE_BROADCAST_SOURCE_APP</code></span>
    239. 

  239. <a class=heading__anchor-link href=#hls_live_broadcast_source_app>[link]</a></h3><p>(Not listed on Admin > Diagnostics.) Defaults to <code>false</code>.</p><h3 class=heading id=hls_live_broadcast_source_web><span class=heading__text><code>HLS_LIVE_BROADCAST_SOURCE_WEB</code></span>
    240. 

  240. <a class=heading__anchor-link href=#hls_live_broadcast_source_web>[link]</a></h3><p>(Not listed on Admin > Diagnostics.) Defaults to <code>false</code>.</p><h3 class=heading id=hls_live_comments_max_falloff><span class=heading__text><code>HLS_LIVE_COMMENTS_MAX_FALLOFF</code></span>
    241. 

  241. <a class=heading__anchor-link href=#hls_live_comments_max_falloff>[link]</a></h3><p>(Not listed on Admin > Diagnostics.) Defaults to <code>50</code>.</p><h2 class=heading id=logging><span class=heading__text>LOGGING</span>
    242. 

  242. <a class=heading__anchor-link href=#logging>[link]</a></h2><h3 class=heading id=log_channel><span class=heading__text><code>LOG_CHANNEL</code></span>
    243. 

  243. <a class=heading__anchor-link href=#log_channel>[link]</a></h3><p>Possible values:</p><ul><li><code>"stack"</code> (default)</li><li><code>"single"</code></li><li><code>"daily"</code></li><li><code>"slack"</code></li><li><code>"stderr"</code></li><li><code>"syslog"</code></li><li><code>"errorlog"</code></li><li><code>"null"</code></li><li><code>"emergency"</code></li><li><code>"media"</code></li></ul><h3 class=heading id=log_level><span class=heading__text><code>LOG_LEVEL</code></span>
    244. 

  244. <a class=heading__anchor-link href=#log_level>[link]</a></h3><p>Used by <code>single</code>, <code>stderr</code> and <code>syslog</code>. Defaults to <code>"debug"</code> for all of those.</p><h3 class=heading id=log_slack_webhook_url><span class=heading__text><code>LOG_SLACK_WEBHOOK_URL</code></span>
    245. 

  245. <a class=heading__anchor-link href=#log_slack_webhook_url>[link]</a></h3><p>(Not listed on Admin > Diagnostics.) Used by <code>slack</code>. Defaults to <code>""</code>.</p><h3 class=heading id=log_stderr_formatter><span class=heading__text><code>LOG_STDERR_FORMATTER</code></span>
    246. 

  246. <a class=heading__anchor-link href=#log_stderr_formatter>[link]</a></h3><p>(Not listed on Admin > Diagnostics.) Used by <code>stderr</code>. Defaults to <code>""</code>.</p><h2 class=heading id=mail><span class=heading__text>MAIL</span>
    247. 

  247. <a class=heading__anchor-link href=#mail>[link]</a></h2><h3 class=heading id=mail_driver><span class=heading__text><code>MAIL_DRIVER</code></span>
    248. 

  248. <a class=heading__anchor-link href=#mail_driver>[link]</a></h3><p>Laravel supports both SMTP and PHP&rsquo;s &ldquo;mail&rdquo; function as drivers for the sending of e-mail. You may specify which one you&rsquo;re using throughout your application here. Possible values:</p><ul><li><code>"smtp"</code> (default)</li><li><code>"sendmail"</code></li><li><code>"mailgun"</code></li><li><code>"mandrill"</code></li><li><code>"ses"</code></li><li><code>"sparkpost"</code></li><li><code>"log"</code></li><li><code>"array"</code></li></ul><h3 class=heading id=mail_host><span class=heading__text><code>MAIL_HOST</code></span>
    249. 

  249. <a class=heading__anchor-link href=#mail_host>[link]</a></h3><p>Here you may provide the host address of the SMTP server used by your applications. A default option is provided that is compatible with the Mailgun mail service which will provide reliable deliveries. Defaults to <code>"smtp.mailgun.org"</code>.</p><h3 class=heading id=mail_port><span class=heading__text><code>MAIL_PORT</code></span>
    250. 

  250. <a class=heading__anchor-link href=#mail_port>[link]</a></h3><p>This is the SMTP port used by your application to deliver e-mails to users of the application. Like the host we have set this value to stay compatible with the Mailgun e-mail application by default. Defaults to <code>587</code>.</p><h3 class=heading id=mail_from_address><span class=heading__text><code>MAIL_FROM_ADDRESS</code></span>
    251. 

  251. <a class=heading__anchor-link href=#mail_from_address>[link]</a></h3><p>You may wish for all e-mails sent by your application to be sent from the same address. Here, you may specify a name and address that is used globally for all e-mails that are sent by your application. Defaults to <code>"hello@example.com"</code>.</p><h3 class=heading id=mail_from_name><span class=heading__text><code>MAIL_FROM_NAME</code></span>
    252. 

  252. <a class=heading__anchor-link href=#mail_from_name>[link]</a></h3><p>Defaults to <code>"Example"</code>.</p><h3 class=heading id=mail_encryption><span class=heading__text><code>MAIL_ENCRYPTION</code></span>
    253. 

  253. <a class=heading__anchor-link href=#mail_encryption>[link]</a></h3><p>Here you may specify the encryption protocol that should be used when the application send e-mail messages. A sensible default using the transport layer security protocol should provide great security. Defaults to <code>"tls"</code>.</p><h3 class=heading id=mail_username><span class=heading__text><code>MAIL_USERNAME</code></span>
    254. 

  254. <a class=heading__anchor-link href=#mail_username>[link]</a></h3><p>(Not listed on Admin > Diagnostics.) If your SMTP server requires a username for authentication, you should set it here. This will get used to authenticate with your server on connection. You may also set the &ldquo;password&rdquo; value below this one. Defaults to <code>""</code>.</p><h3 class=heading id=mail_password><span class=heading__text><code>MAIL_PASSWORD</code></span>
    255. 

  255. <a class=heading__anchor-link href=#mail_password>[link]</a></h3><p>(Not listed on Admin > Diagnostics.) Defaults to <code>""</code>.</p><h2 class=heading id=media><span class=heading__text>MEDIA</span>
    256. 

  256. <a class=heading__anchor-link href=#media>[link]</a></h2><h3 class=heading id=media_delete_local_after_cloud><span class=heading__text><code>MEDIA_DELETE_LOCAL_AFTER_CLOUD</code></span>
    257. 

  257. <a class=heading__anchor-link href=#media_delete_local_after_cloud>[link]</a></h3><p>(Not listed on Admin > Diagnostics.) Defaults to <code>true</code>.</p><h3 class=heading id=media_exif_database><span class=heading__text><code>MEDIA_EXIF_DATABASE</code></span>
    258. 

  258. <a class=heading__anchor-link href=#media_exif_database>[link]</a></h3><p>Defaults to <code>false</code>.</p><h2 class=heading id=passport><span class=heading__text>PASSPORT</span>
    259. 

  259. <a class=heading__anchor-link href=#passport>[link]</a></h2><p>(Not listed on Admin > Diagnostics.) Passport uses encryption keys while generating secure access tokens for your application. By default, the keys are stored as local files but can be set via environment variables when that is more convenient.</p><h3 class=heading id=passport_private_key><span class=heading__text><code>PASSPORT_PRIVATE_KEY</code></span>
    260. 

  260. <a class=heading__anchor-link href=#passport_private_key>[link]</a></h3><p>(Not listed on Admin > Diagnostics.)</p><h3 class=heading id=passport_public_key><span class=heading__text><code>PASSPORT_PUBLIC_KEY</code></span>
    261. 

  261. <a class=heading__anchor-link href=#passport_public_key>[link]</a></h3><p>(Not listed on Admin > Diagnostics.)</p><h2 class=heading id=pixelfed><span class=heading__text>PIXELFED</span>
    262. 

  262. <a class=heading__anchor-link href=#pixelfed>[link]</a></h2><h3 class=heading id=admin_domain><span class=heading__text><code>ADMIN_DOMAIN</code></span>
    263. 

  263. <a class=heading__anchor-link href=#admin_domain>[link]</a></h3><p>Application domains used for routing.</p><h3 class=heading id=app_domain><span class=heading__text><code>APP_DOMAIN</code></span>
    264. 

  264. <a class=heading__anchor-link href=#app_domain>[link]</a></h3><p>Application domains used for routing.</p><h3 class=heading id=memory_limit><span class=heading__text><code>MEMORY_LIMIT</code></span>
    265. 

  265. <a class=heading__anchor-link href=#memory_limit>[link]</a></h3><p>This <code>memory_limit</code> value is only used for image processing. The default <code>memory_limit</code> in <code>php.ini</code> is used for the rest of the app. Defaults to <code>"1024M"</code>.</p><h3 class=heading id=open_registration><span class=heading__text><code>OPEN_REGISTRATION</code></span>
    266. 

  266. <a class=heading__anchor-link href=#open_registration>[link]</a></h3><p>Enable/disable new local account registrations. Defaults to <code>true</code>.</p><h3 class=heading id=max_account_size-kb><span class=heading__text><code>MAX_ACCOUNT_SIZE</code> (kB)</span>
    267. 

  267. <a class=heading__anchor-link href=#max_account_size-kb>[link]</a></h3><p>Update the max account size, the per user limit of files in kB. Defaults to <code>1000000</code> (1GB).</p><h3 class=heading id=max_photo_size-kb><span class=heading__text><code>MAX_PHOTO_SIZE</code> (kB)</span>
    268. 

  268. <a class=heading__anchor-link href=#max_photo_size-kb>[link]</a></h3><p>Update the max photo size, in kB. Defaults to <code>15000</code> (15MB).</p><h3 class=heading id=max_avatar_size-kb><span class=heading__text><code>MAX_AVATAR_SIZE</code> (kB)</span>
    269. 

  269. <a class=heading__anchor-link href=#max_avatar_size-kb>[link]</a></h3><p>Update the max avatar size, in kB. Defaults to <code>2000</code> (2MB).</p><h3 class=heading id=max_caption_length><span class=heading__text><code>MAX_CAPTION_LENGTH</code></span>
    270. 

  270. <a class=heading__anchor-link href=#max_caption_length>[link]</a></h3><p>Change the caption length limit for new local posts. Defaults to <code>500</code>.</p><h3 class=heading id=max_bio_length><span class=heading__text><code>MAX_BIO_LENGTH</code></span>
    271. 

  271. <a class=heading__anchor-link href=#max_bio_length>[link]</a></h3><p>Change the bio length limit for user profiles. Defaults to <code>125</code>.</p><h3 class=heading id=max_name_length><span class=heading__text><code>MAX_NAME_LENGTH</code></span>
    272. 

  272. <a class=heading__anchor-link href=#max_name_length>[link]</a></h3><p>Change the length limit for user names. Defaults to <code>30</code>.</p><h3 class=heading id=min_password_length><span class=heading__text><code>MIN_PASSWORD_LENGTH</code></span>
    273. 

  273. <a class=heading__anchor-link href=#min_password_length>[link]</a></h3><p>Change the minimum length limit for user passwords. Defaults to <code>8</code>.</p><h3 class=heading id=max_album_length><span class=heading__text><code>MAX_ALBUM_LENGTH</code></span>
    274. 

  274. <a class=heading__anchor-link href=#max_album_length>[link]</a></h3><p>The max number of photos allowed per post. Defaults to <code>4</code>.</p><h3 class=heading id=enforce_email_verification><span class=heading__text><code>ENFORCE_EMAIL_VERIFICATION</code></span>
    275. 

  275. <a class=heading__anchor-link href=#enforce_email_verification>[link]</a></h3><p>Require email verification before a new user can do anything. Defaults to <code>true</code>.</p><h3 class=heading id=image_quality><span class=heading__text><code>IMAGE_QUALITY</code></span>
    276. 

  276. <a class=heading__anchor-link href=#image_quality>[link]</a></h3><p>Set the image optimization quality, must be a value between 1-100. Defaults to <code>80</code>.</p><h3 class=heading id=account_deletion><span class=heading__text><code>ACCOUNT_DELETION</code></span>
    277. 

  277. <a class=heading__anchor-link href=#account_deletion>[link]</a></h3><p>Enable account deletion. Defaults to <code>true</code>.</p><h3 class=heading id=account_delete_after><span class=heading__text><code>ACCOUNT_DELETE_AFTER</code></span>
    278. 

  278. <a class=heading__anchor-link href=#account_delete_after>[link]</a></h3><p>Set account deletion queue after X days, set to false to delete accounts immediately. Defaults to <code>false</code>.</p><h3 class=heading id=pf_enable_cloud><span class=heading__text><code>PF_ENABLE_CLOUD</code></span>
    279. 

  279. <a class=heading__anchor-link href=#pf_enable_cloud>[link]</a></h3><p>Store media on object storage like S3, Digital Ocean Spaces, Rackspace Defaults to <code>false</code>.</p><h3 class=heading id=pf_max_users><span class=heading__text><code>PF_MAX_USERS</code></span>
    280. 

  280. <a class=heading__anchor-link href=#pf_max_users>[link]</a></h3><p>Allow a maximum number of user accounts. Defaults to <code>false</code>.</p><h3 class=heading id=pf_optimize_images><span class=heading__text><code>PF_OPTIMIZE_IMAGES</code></span>
    281. 

  281. <a class=heading__anchor-link href=#pf_optimize_images>[link]</a></h3><p>Resize and optimize image uploads. Defaults to <code>true</code>.</p><h3 class=heading id=pf_optimize_videos><span class=heading__text><code>PF_OPTIMIZE_VIDEOS</code></span>
    282. 

  282. <a class=heading__anchor-link href=#pf_optimize_videos>[link]</a></h3><p>Resize and optimize video uploads. Defaults to <code>true</code>.</p><h3 class=heading id=pf_user_invites><span class=heading__text><code>PF_USER_INVITES</code></span>
    283. 

  283. <a class=heading__anchor-link href=#pf_user_invites>[link]</a></h3><p>Allow users to invite others via email. Will respect max user limit and prevent invites after the limit is reached. Defaults to <code>false</code>.</p><h3 class=heading id=pf_user_invites_total_limit><span class=heading__text><code>PF_USER_INVITES_TOTAL_LIMIT</code></span>
    284. 

  284. <a class=heading__anchor-link href=#pf_user_invites_total_limit>[link]</a></h3><p>Defaults to <code>0</code>.</p><h3 class=heading id=pf_user_invites_daily_limit><span class=heading__text><code>PF_USER_INVITES_DAILY_LIMIT</code></span>
    285. 

  285. <a class=heading__anchor-link href=#pf_user_invites_daily_limit>[link]</a></h3><p>Defaults to <code>0</code>.</p><h3 class=heading id=pf_user_invites_monthly_limit><span class=heading__text><code>PF_USER_INVITES_MONTHLY_LIMIT</code></span>
    286. 

  286. <a class=heading__anchor-link href=#pf_user_invites_monthly_limit>[link]</a></h3><p>Defaults to <code>0</code>.</p><h3 class=heading id=pf_max_collection_length><span class=heading__text><code>PF_MAX_COLLECTION_LENGTH</code></span>
    287. 

  287. <a class=heading__anchor-link href=#pf_max_collection_length>[link]</a></h3><p>Defaults to <code>100</code>.</p><h3 class=heading id=media_types><span class=heading__text><code>MEDIA_TYPES</code></span>
    288. 

  288. <a class=heading__anchor-link href=#media_types>[link]</a></h3><p>Defaults to <code>"image/jpeg,image/png,image/gif"</code>.</p><h3 class=heading id=limit_account_size><span class=heading__text><code>LIMIT_ACCOUNT_SIZE</code></span>
    289. 

  289. <a class=heading__anchor-link href=#limit_account_size>[link]</a></h3><p>Defaults to <code>true</code>.</p><h3 class=heading id=import_instagram><span class=heading__text><code>IMPORT_INSTAGRAM</code></span>
    290. 

  290. <a class=heading__anchor-link href=#import_instagram>[link]</a></h3><p>Defaults to <code>false</code>.</p><h3 class=heading id=import_instagram_post_limit><span class=heading__text><code>IMPORT_INSTAGRAM_POST_LIMIT</code></span>
    291. 

  291. <a class=heading__anchor-link href=#import_instagram_post_limit>[link]</a></h3><p>Defaults to <code>100</code>.</p><h3 class=heading id=import_instagram_size_limit><span class=heading__text><code>IMPORT_INSTAGRAM_SIZE_LIMIT</code></span>
    292. 

  292. <a class=heading__anchor-link href=#import_instagram_size_limit>[link]</a></h3><p>Defaults to <code>5000</code>.</p><h3 class=heading id=oauth_enabled><span class=heading__text><code>OAUTH_ENABLED</code></span>
    293. 

  293. <a class=heading__anchor-link href=#oauth_enabled>[link]</a></h3><p>Defaults to <code>false</code>.</p><h3 class=heading id=pf_bouncer_enabled><span class=heading__text><code>PF_BOUNCER_ENABLED</code></span>
    294. 

  294. <a class=heading__anchor-link href=#pf_bouncer_enabled>[link]</a></h3><p>Defaults to <code>false</code>.</p><h3 class=heading id=pf_media_fast_process><span class=heading__text><code>PF_MEDIA_FAST_PROCESS</code></span>
    295. 

  295. <a class=heading__anchor-link href=#pf_media_fast_process>[link]</a></h3><p>Don&rsquo;t require photos & video to finish optimization & upload to S3 if enabled before posting. If disabled users will have to wait until processed before posting, sacrificing the user experience to ensure media is federated using S3 urls (if enabled). Defaults to <code>true</code>.</p><h3 class=heading id=pf_media_max_alttext_length><span class=heading__text><code>PF_MEDIA_MAX_ALTTEXT_LENGTH</code></span>
    296. 

  296. <a class=heading__anchor-link href=#pf_media_max_alttext_length>[link]</a></h3><p>Defaults to <code>1000</code>.</p><h3 class=heading id=pf_allow_app_registration><span class=heading__text><code>PF_ALLOW_APP_REGISTRATION</code></span>
    297. 

  297. <a class=heading__anchor-link href=#pf_allow_app_registration>[link]</a></h3><p>Defaults to <code>true</code>.</p><h2 class=heading id=portfolio><span class=heading__text>PORTFOLIO</span>
    298. 

  298. <a class=heading__anchor-link href=#portfolio>[link]</a></h2><p>(Not listed on Admin > Diagnostics.)</p><h3 class=heading id=portfolio_domain><span class=heading__text><code>PORTFOLIO_DOMAIN</code></span>
    299. 

  299. <a class=heading__anchor-link href=#portfolio_domain>[link]</a></h3><p>(Not listed on Admin > Diagnostics.) This value is the domain used for the portfolio feature. Only change the default value if you have a subdomain configured. You must use a subdomain on the same app domain. Defaults to <code>APP_DOMAIN</code>.</p><h3 class=heading id=portfolio_path><span class=heading__text><code>PORTFOLIO_PATH</code></span>
    300. 

  300. <a class=heading__anchor-link href=#portfolio_path>[link]</a></h3><p>(Not listed on Admin > Diagnostics.) This value is the path used for the portfolio feature. Only change the default value if you have a subdomain configured. If you want to use the root path of the subdomain, leave this value empty.</p><p>WARNING: SETTING THIS VALUE WITHOUT A SUBDOMAIN COULD BREAK YOUR INSTANCE, SO ONLY CHANGE THIS IF YOU KNOW WHAT YOU&rsquo;RE DOING.</p><p>Defaults to <code>"/i/portfolio"</code>.</p><h2 class=heading id=purify><span class=heading__text>PURIFY</span>
    301. 

  301. <a class=heading__anchor-link href=#purify>[link]</a></h2><h3 class=heading id=restrict_html_types><span class=heading__text><code>RESTRICT_HTML_TYPES</code></span>
    302. 

  302. <a class=heading__anchor-link href=#restrict_html_types>[link]</a></h3><p>Defaults to <code>true</code>.</p><h2 class=heading id=resilient_mode><span class=heading__text><code>RESILIENT_MODE</code></span>
    303. 

  303. <a class=heading__anchor-link href=#resilient_mode>[link]</a></h2><p>(Not listed on Admin > Diagnostics.) This mode allows you to define up to 2 alternate S3 cloud providers for a total of 3 S3 providers for redundancy.</p><p>To enable the primary alternate S3 driver, ensure you set the following .env variables:</p><ul><li><code>ALT_PRI_ENABLED=true</code></li><li><code>ALT_PRI_AWS_ACCESS_KEY_ID=KEYID</code></li><li><code>ALT_PRI_AWS_SECRET_ACCESS_KEY=SECRET</code></li><li><code>ALT_PRI_AWS_DEFAULT_REGION=REGION</code></li><li><code>ALT_PRI_AWS_URL=URL</code></li><li><code>ALT_PRI_AWS_ENDPOINT=ENDPOINT</code></li></ul><p>To enable the secondary alternate S3 driver, ensure you set the following .env variables:</p><ul><li><code>ALT_SEC_ENABLED=true</code></li><li><code>ALT_SEC_AWS_ACCESS_KEY_ID=KEYID</code></li><li><code>ALT_SEC_AWS_SECRET_ACCESS_KEY=SECRET</code></li><li><code>ALT_SEC_AWS_DEFAULT_REGION=REGION</code></li><li><code>ALT_SEC_AWS_URL=URL</code></li><li><code>ALT_SEC_AWS_ENDPOINT=ENDPOINT</code></li></ul><h2 class=heading id=queue><span class=heading__text>QUEUE</span>
    304. 

  304. <a class=heading__anchor-link href=#queue>[link]</a></h2><h3 class=heading id=queue_driver><span class=heading__text><code>QUEUE_DRIVER</code></span>
    305. 

  305. <a class=heading__anchor-link href=#queue_driver>[link]</a></h3><ul><li><code>"sync"</code> (default)</li><li><code>"database"</code></li><li><code>"beanstalkd"</code></li><li><code>"sqs"</code></li><li><code>"redis"</code></li><li><code>"null"</code></li></ul><h3 class=heading id=sqs><span class=heading__text>SQS</span>
    306. 

  306. <a class=heading__anchor-link href=#sqs>[link]</a></h3><p>(Not listed on Admin > Diagnostics.)</p><h4 class=heading id=sqs_key><span class=heading__text><code>SQS_KEY</code></span>
    307. 

  307. <a class=heading__anchor-link href=#sqs_key>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) Defaults to <code>"your-public-key"</code>.</p><h4 class=heading id=sqs_secret><span class=heading__text><code>SQS_SECRET</code></span>
    308. 

  308. <a class=heading__anchor-link href=#sqs_secret>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) Defaults to <code>"your-secret-key"</code>.</p><h4 class=heading id=sqs_prefix><span class=heading__text><code>SQS_PREFIX</code></span>
    309. 

  309. <a class=heading__anchor-link href=#sqs_prefix>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) Defaults to <code>"https://sqs.us-east-1.amazonaws.com/your-account-id"</code>.</p><h4 class=heading id=sqs_queue><span class=heading__text><code>SQS_QUEUE</code></span>
    310. 

  310. <a class=heading__anchor-link href=#sqs_queue>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) Defaults to <code>"your-queue-name"</code>.</p><h4 class=heading id=sqs_region><span class=heading__text><code>SQS_REGION</code></span>
    311. 

  311. <a class=heading__anchor-link href=#sqs_region>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) Defaults to <code>"us-east-1"</code>.</p><h3 class=heading id=db_connection-1><span class=heading__text>DB_CONNECTION</span>
    312. 

  312. <a class=heading__anchor-link href=#db_connection-1>[link]</a></h3><p>(Not listed on Admin > Diagnostics.) See
    313. 

  313. <a href=#db_connection><code>DB_CONNECTION</code></a>. These options configure the behavior of failed queue job logging so you can control which database and table are used to store the jobs that have failed. You may change them to any database / table you wish. Defaults to <code>"mysql"</code>.</p><h2 class=heading id=services><span class=heading__text>SERVICES</span>
    314. 

  314. <a class=heading__anchor-link href=#services>[link]</a></h2><p>(Not listed on Admin > Diagnostics.)</p><h3 class=heading id=mailgun><span class=heading__text>MAILGUN</span>
    315. 

  315. <a class=heading__anchor-link href=#mailgun>[link]</a></h3><p>(Not listed on Admin > Diagnostics.)</p><h4 class=heading id=mailgun_domain><span class=heading__text><code>MAILGUN_DOMAIN</code></span>
    316. 

  316. <a class=heading__anchor-link href=#mailgun_domain>[link]</a></h4><p>(Not listed on Admin > Diagnostics.)</p><h4 class=heading id=mailgun_secret><span class=heading__text><code>MAILGUN_SECRET</code></span>
    317. 

  317. <a class=heading__anchor-link href=#mailgun_secret>[link]</a></h4><p>(Not listed on Admin > Diagnostics.)</p><h3 class=heading id=ses><span class=heading__text>SES</span>
    318. 

  318. <a class=heading__anchor-link href=#ses>[link]</a></h3><p>(Not listed on Admin > Diagnostics.)</p><h4 class=heading id=ses_key><span class=heading__text><code>SES_KEY</code></span>
    319. 

  319. <a class=heading__anchor-link href=#ses_key>[link]</a></h4><p>(Not listed on Admin > Diagnostics.)</p><h4 class=heading id=ses_secret><span class=heading__text><code>SES_SECRET</code></span>
    320. 

  320. <a class=heading__anchor-link href=#ses_secret>[link]</a></h4><p>(Not listed on Admin > Diagnostics.)</p><h4 class=heading id=ses_region><span class=heading__text><code>SES_REGION</code></span>
    321. 

  321. <a class=heading__anchor-link href=#ses_region>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) Defaults to <code>"us-east-1"</code>.</p><h3 class=heading id=sparkpost><span class=heading__text>SPARKPOST</span>
    322. 

  322. <a class=heading__anchor-link href=#sparkpost>[link]</a></h3><p>(Not listed on Admin > Diagnostics.)</p><h4 class=heading id=sparkpost_secret><span class=heading__text><code>SPARKPOST_SECRET</code></span>
    323. 

  323. <a class=heading__anchor-link href=#sparkpost_secret>[link]</a></h4><p>(Not listed on Admin > Diagnostics.)</p><h3 class=heading id=stripe><span class=heading__text>STRIPE</span>
    324. 

  324. <a class=heading__anchor-link href=#stripe>[link]</a></h3><p>(Not listed on Admin > Diagnostics.)</p><h4 class=heading id=stripe_key><span class=heading__text><code>STRIPE_KEY</code></span>
    325. 

  325. <a class=heading__anchor-link href=#stripe_key>[link]</a></h4><p>(Not listed on Admin > Diagnostics.)</p><h4 class=heading id=stripe_secret><span class=heading__text><code>STRIPE_SECRET</code></span>
    326. 

  326. <a class=heading__anchor-link href=#stripe_secret>[link]</a></h4><p>(Not listed on Admin > Diagnostics.)</p><h2 class=heading id=session><span class=heading__text>SESSION</span>
    327. 

  327. <a class=heading__anchor-link href=#session>[link]</a></h2><h3 class=heading id=session_driver><span class=heading__text><code>SESSION_DRIVER</code></span>
    328. 

  328. <a class=heading__anchor-link href=#session_driver>[link]</a></h3><p>This option controls the default session &ldquo;driver&rdquo; that will be used on requests. By default, we will use the lightweight native driver but you may specify any of the other wonderful drivers provided here.</p><ul><li><code>"file"</code></li><li><code>"cookie"</code></li><li><code>"database"</code> (default)</li><li><code>"apc"</code></li><li><code>"memcached"</code></li><li><code>"redis"</code></li><li><code>"array"</code></li></ul><h3 class=heading id=session_lifetime><span class=heading__text><code>SESSION_LIFETIME</code></span>
    329. 

  329. <a class=heading__anchor-link href=#session_lifetime>[link]</a></h3><p>Here you may specify the number of minutes that you wish the session to be allowed to remain idle before it expires. If you want them to immediately expire on the browser closing, set that option. Defaults to <code>86400</code>.</p><h3 class=heading id=session_domain><span class=heading__text><code>SESSION_DOMAIN</code></span>
    330. 

  330. <a class=heading__anchor-link href=#session_domain>[link]</a></h3><p>Here you may change the domain of the cookie used to identify a session in your application. This will determine which domains the cookie is available to in your application. A sensible default has been set. Defaults to the value of <code>APP_DOMAIN</code>, or <code>null</code>.</p><h2 class=heading id=video-webp2p><span class=heading__text>VIDEO WEBP2P</span>
    331. 

  331. <a class=heading__anchor-link href=#video-webp2p>[link]</a></h2><p>(Not listed on Admin > Diagnostics.) WebP2P support for local video that uses peer-to-peer technology to reduce load on individual servers when viewing video.</p><h3 class=heading id=media_hls_enabled><span class=heading__text><code>MEDIA_HLS_ENABLED</code></span>
    332. 

  332. <a class=heading__anchor-link href=#media_hls_enabled>[link]</a></h3><p>Set to <code>true</code> to enable HLS generation, required for WebP2P support and alone allows for better viewing experiences. <strong>Disabled by default.</strong></p><h3 class=heading id=media_hls_p2p><span class=heading__text><code>MEDIA_HLS_P2P</code></span>
    333. 

  333. <a class=heading__anchor-link href=#media_hls_p2p>[link]</a></h3><p>Set to <code>true</code> to enable WebP2P support. Requires <code>MEDIA_HLS_ENABLED=true</code>. <strong>Disabled by default.</strong></p><h3 class=heading id=media_hls_bitrate><span class=heading__text><code>MEDIA_HLS_BITRATE</code></span>
    334. 

  334. <a class=heading__anchor-link href=#media_hls_bitrate>[link]</a></h3><p>Set the default HLS bitrate. We recommend using the default value of <code>1000</code> unless you know what you are doing.</p><h3 class=heading id=media_hls_p2p_tracker><span class=heading__text><code>MEDIA_HLS_P2P_TRACKER</code></span>
    335. 

  335. <a class=heading__anchor-link href=#media_hls_p2p_tracker>[link]</a></h3><p>Set the WebP2P torrent tracker. The default tracker is <code>wss://tracker.webtorrent.dev</code></p><h3 class=heading id=media_hls_p2p_ice_server><span class=heading__text><code>MEDIA_HLS_P2P_ICE_SERVER</code></span>
    336. 

  336. <a class=heading__anchor-link href=#media_hls_p2p_ice_server>[link]</a></h3><p>Set the WebP2P signaling server. The default server is <code>stun:stun.l.google.com:19302</code></p><h3 class=heading id=media_hls_debug><span class=heading__text><code>MEDIA_HLS_DEBUG</code></span>
    337. 

  337. <a class=heading__anchor-link href=#media_hls_debug>[link]</a></h3><p>Set to <code>true</code> to enable debug mode that logs to browser console log. <strong>Disabled by default.</strong></p><h3 class=heading id=media_hls_p2p_debug><span class=heading__text><code>MEDIA_HLS_P2P_DEBUG</code></span>
    338. 

  338. <a class=heading__anchor-link href=#media_hls_p2p_debug>[link]</a></h3><p>Set to <code>true</code> to enable debug mode that logs WebP2P events to browser console log. <strong>Disabled by default.</strong></p><h2 class=heading id=telescope><span class=heading__text>TELESCOPE</span>
    339. 

  339. <a class=heading__anchor-link href=#telescope>[link]</a></h2><p>(Not listed on Admin > Diagnostics.)</p><h3 class=heading id=telescope_driver><span class=heading__text><code>TELESCOPE_DRIVER</code></span>
    340. 

  340. <a class=heading__anchor-link href=#telescope_driver>[link]</a></h3><p>(Not listed on Admin > Diagnostics.) This configuration options determines the storage driver that will be used to store Telescope&rsquo;s data. In addition, you may set any custom options as needed by the particular driver you choose. Defaults to <code>"database"</code>.</p><h3 class=heading id=telescope_enabled><span class=heading__text><code>TELESCOPE_ENABLED</code></span>
    341. 

  341. <a class=heading__anchor-link href=#telescope_enabled>[link]</a></h3><p>(Not listed on Admin > Diagnostics.) This option may be used to disable all Telescope watchers regardless of their individual configuration, which simply provides a single and convenient way to enable or disable Telescope data storage. Defaults to <code>false</code>.</p><h3 class=heading id=telescope_cache_watcher><span class=heading__text><code>TELESCOPE_CACHE_WATCHER</code></span>
    342. 

  342. <a class=heading__anchor-link href=#telescope_cache_watcher>[link]</a></h3><p>(Not listed on Admin > Diagnostics.) Defaults to <code>true</code>.</p><h3 class=heading id=telescope_command_watcher><span class=heading__text><code>TELESCOPE_COMMAND_WATCHER</code></span>
    343. 

  343. <a class=heading__anchor-link href=#telescope_command_watcher>[link]</a></h3><p>(Not listed on Admin > Diagnostics.) Defaults to <code>true</code>.</p><h3 class=heading id=telescope_dump_watcher><span class=heading__text><code>TELESCOPE_DUMP_WATCHER</code></span>
    344. 

  344. <a class=heading__anchor-link href=#telescope_dump_watcher>[link]</a></h3><p>(Not listed on Admin > Diagnostics.) Defaults to <code>true</code>.</p><h3 class=heading id=telescope_event_watcher><span class=heading__text><code>TELESCOPE_EVENT_WATCHER</code></span>
    345. 

  345. <a class=heading__anchor-link href=#telescope_event_watcher>[link]</a></h3><p>(Not listed on Admin > Diagnostics.) Defaults to <code>true</code>.</p><h3 class=heading id=telescope_exception_watcher><span class=heading__text><code>TELESCOPE_EXCEPTION_WATCHER</code></span>
    346. 

  346. <a class=heading__anchor-link href=#telescope_exception_watcher>[link]</a></h3><p>(Not listed on Admin > Diagnostics.) Defaults to <code>true</code>.</p><h3 class=heading id=telescope_job_watcher><span class=heading__text><code>TELESCOPE_JOB_WATCHER</code></span>
    347. 

  347. <a class=heading__anchor-link href=#telescope_job_watcher>[link]</a></h3><p>(Not listed on Admin > Diagnostics.) Defaults to <code>true</code>.</p><h3 class=heading id=telescope_log_watcher><span class=heading__text><code>TELESCOPE_LOG_WATCHER</code></span>
    348. 

  348. <a class=heading__anchor-link href=#telescope_log_watcher>[link]</a></h3><p>(Not listed on Admin > Diagnostics.) Defaults to <code>true</code>.</p><h3 class=heading id=telescope_mail_watcher><span class=heading__text><code>TELESCOPE_MAIL_WATCHER</code></span>
    349. 

  349. <a class=heading__anchor-link href=#telescope_mail_watcher>[link]</a></h3><p>(Not listed on Admin > Diagnostics.) Defaults to <code>true</code>.</p><h3 class=heading id=telescope_model_watcher><span class=heading__text><code>TELESCOPE_MODEL_WATCHER</code></span>
    350. 

  350. <a class=heading__anchor-link href=#telescope_model_watcher>[link]</a></h3><p>(Not listed on Admin > Diagnostics.) Defaults to <code>true</code>.</p><h3 class=heading id=telescope_notification_watcher><span class=heading__text><code>TELESCOPE_NOTIFICATION_WATCHER</code></span>
    351. 

  351. <a class=heading__anchor-link href=#telescope_notification_watcher>[link]</a></h3><p>(Not listed on Admin > Diagnostics.) Defaults to <code>true</code>.</p><h3 class=heading id=telescope_query_watcher><span class=heading__text><code>TELESCOPE_QUERY_WATCHER</code></span>
    352. 

  352. <a class=heading__anchor-link href=#telescope_query_watcher>[link]</a></h3><p>(Not listed on Admin > Diagnostics.) Defaults to <code>true</code>.</p><h3 class=heading id=telescope_redis_watcher><span class=heading__text><code>TELESCOPE_REDIS_WATCHER</code></span>
    353. 

  353. <a class=heading__anchor-link href=#telescope_redis_watcher>[link]</a></h3><p>(Not listed on Admin > Diagnostics.) Defaults to <code>true</code>.</p><h3 class=heading id=telescope_request_watcher><span class=heading__text><code>TELESCOPE_REQUEST_WATCHER</code></span>
    354. 

  354. <a class=heading__anchor-link href=#telescope_request_watcher>[link]</a></h3><p>(Not listed on Admin > Diagnostics.) Defaults to <code>true</code>.</p><h3 class=heading id=telescope_response_size_limit><span class=heading__text><code>TELESCOPE_RESPONSE_SIZE_LIMIT</code></span>
    355. 

  355. <a class=heading__anchor-link href=#telescope_response_size_limit>[link]</a></h3><p>(Not listed on Admin > Diagnostics.) Defaults to <code>64</code>.</p><h3 class=heading id=telescope_gate_watcher><span class=heading__text><code>TELESCOPE_GATE_WATCHER</code></span>
    356. 

  356. <a class=heading__anchor-link href=#telescope_gate_watcher>[link]</a></h3><p>(Not listed on Admin > Diagnostics.) Defaults to <code>true</code>.</p><h3 class=heading id=telescope_schedule_watcher><span class=heading__text><code>TELESCOPE_SCHEDULE_WATCHER</code></span>
    357. 

  357. <a class=heading__anchor-link href=#telescope_schedule_watcher>[link]</a></h3><p>(Not listed on Admin > Diagnostics.) Defaults to <code>true</code>.</p><h2 class=heading id=trustedproxy><span class=heading__text>TRUSTEDPROXY</span>
    358. 

  358. <a class=heading__anchor-link href=#trustedproxy>[link]</a></h2><h3 class=heading id=trust_proxies><span class=heading__text><code>TRUST_PROXIES</code></span>
    359. 

  359. <a class=heading__anchor-link href=#trust_proxies>[link]</a></h3><p>Set trusted proxy IP addresses.</p><p>Both IPv4 and IPv6 addresses are supported, along with CIDR notation.</p><p>The &ldquo;*&rdquo; character is syntactic sugar within TrustedProxy to trust any proxy that connects directly to your server, a requirement when you cannot know the address of your proxy (e.g. if using Rackspace balancers).</p><p>The &ldquo;**&rdquo; character is syntactic sugar within TrustedProxy to trust not just any proxy that connects directly to your server, but also proxies that connect to those proxies, and all the way back until you reach the original source IP. It will mean that $request->getClientIp() always gets the originating client IP, no matter how many proxies that client&rsquo;s request has subsequently passed through.</p><p>Defaults to <code>"*"</code>.</p><h2 class=heading id=websockets><span class=heading__text>WEBSOCKETS</span>
    360. 

  360. <a class=heading__anchor-link href=#websockets>[link]</a></h2><p>(Not listed on Admin > Diagnostics.)</p><h3 class=heading id=dashboard-settings><span class=heading__text>DASHBOARD SETTINGS</span>
    361. 

  361. <a class=heading__anchor-link href=#dashboard-settings>[link]</a></h3><p>(Not listed on Admin > Diagnostics.) You can configure the dashboard settings from here.</p><h4 class=heading id=laravel_websockets_port><span class=heading__text><code>LARAVEL_WEBSOCKETS_PORT</code></span>
    362. 

  362. <a class=heading__anchor-link href=#laravel_websockets_port>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) Defaults to <code>6001</code>.</p><h4 class=heading id=laravel_websockets_domain><span class=heading__text><code>LARAVEL_WEBSOCKETS_DOMAIN</code></span>
    363. 

  363. <a class=heading__anchor-link href=#laravel_websockets_domain>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) Defaults to <code>""</code>.</p><h4 class=heading id=laravel_websockets_path><span class=heading__text><code>LARAVEL_WEBSOCKETS_PATH</code></span>
    364. 

  364. <a class=heading__anchor-link href=#laravel_websockets_path>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) Defaults to <code>"laravel-websockets"</code>.</p><h3 class=heading id=applications-repository><span class=heading__text>APPLICATIONS REPOSITORY</span>
    365. 

  365. <a class=heading__anchor-link href=#applications-repository>[link]</a></h3><p>(Not listed on Admin > Diagnostics.)</p><h4 class=heading id=pusher_app_id-1><span class=heading__text><code>PUSHER_APP_ID</code></span>
    366. 

  366. <a class=heading__anchor-link href=#pusher_app_id-1>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) See
    367. 

  367. <a href=#pusher>PUSHER</a>.</p><h4 class=heading id=app_name-1><span class=heading__text><code>APP_NAME</code></span>
    368. 

  368. <a class=heading__anchor-link href=#app_name-1>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) See
    369. 

  369. <a href=#app>APP</a>.</p><h4 class=heading id=pusher_app_host><span class=heading__text><code>PUSHER_APP_HOST</code></span>
    370. 

  370. <a class=heading__anchor-link href=#pusher_app_host>[link]</a></h4><p>(Not listed on Admin > Diagnostics.)</p><h4 class=heading id=pusher_app_key-1><span class=heading__text><code>PUSHER_APP_KEY</code></span>
    371. 

  371. <a class=heading__anchor-link href=#pusher_app_key-1>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) See
    372. 

  372. <a href=#pusher>PUSHER</a>.</p><h4 class=heading id=pusher_app_secret-1><span class=heading__text><code>PUSHER_APP_SECRET</code></span>
    373. 

  373. <a class=heading__anchor-link href=#pusher_app_secret-1>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) See
    374. 

  374. <a href=#pusher>PUSHER</a>.</p><h4 class=heading id=pusher_app_path><span class=heading__text><code>PUSHER_APP_PATH</code></span>
    375. 

  375. <a class=heading__anchor-link href=#pusher_app_path>[link]</a></h4><p>(Not listed on Admin > Diagnostics.)</p><h3 class=heading id=broadcasting-replication-pubsub><span class=heading__text>BROADCASTING REPLICATION PUBSUB</span>
    376. 

  376. <a class=heading__anchor-link href=#broadcasting-replication-pubsub>[link]</a></h3><p>(Not listed on Admin > Diagnostics.) You can enable replication to publish and subscribe to messages across the driver.</p><p>By default, it is set to <code>"local"</code>, but you can configure it to use drivers like Redis to ensure connection between multiple instances of WebSocket servers. Just set the driver to <code>"redis"</code> to enable the PubSub using Redis.</p><h4 class=heading id=websockets_replication_mode><span class=heading__text><code>WEBSOCKETS_REPLICATION_MODE</code></span>
    377. 

  377. <a class=heading__anchor-link href=#websockets_replication_mode>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) Defaults to <code>"local"</code>.</p><h4 class=heading id=websockets_redis_replication_connection><span class=heading__text><code>WEBSOCKETS_REDIS_REPLICATION_CONNECTION</code></span>
    378. 

  378. <a class=heading__anchor-link href=#websockets_redis_replication_connection>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) See
    379. 

  379. <a href=#redis>REDIS</a>. Defaults to <code>"default"</code>.</p><h3 class=heading id=ssl-configuration><span class=heading__text>SSL CONFIGURATION</span>
    380. 

  380. <a class=heading__anchor-link href=#ssl-configuration>[link]</a></h3><p>(Not listed on Admin > Diagnostics.) By default, the configuration allows only on HTTP. For SSL, you need to set up the the certificate, the key, and optionally, the passphrase for the private key. You will need to restart the server for the settings to take place.</p><h4 class=heading id=laravel_websockets_ssl_local_cert><span class=heading__text><code>LARAVEL_WEBSOCKETS_SSL_LOCAL_CERT</code></span>
    381. 

  381. <a class=heading__anchor-link href=#laravel_websockets_ssl_local_cert>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) Defaults to <code>null</code>.</p><h4 class=heading id=laravel_websockets_ssl_ca><span class=heading__text><code>LARAVEL_WEBSOCKETS_SSL_CA</code></span>
    382. 

  382. <a class=heading__anchor-link href=#laravel_websockets_ssl_ca>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) Defaults to <code>null</code>.</p><h4 class=heading id=laravel_websockets_ssl_local_pk><span class=heading__text><code>LARAVEL_WEBSOCKETS_SSL_LOCAL_PK</code></span>
    383. 

  383. <a class=heading__anchor-link href=#laravel_websockets_ssl_local_pk>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) Defaults to <code>null</code>.</p><h4 class=heading id=laravel_websockets_ssl_passphrase><span class=heading__text><code>LARAVEL_WEBSOCKETS_SSL_PASSPHRASE</code></span>
    384. 

  384. <a class=heading__anchor-link href=#laravel_websockets_ssl_passphrase>[link]</a></h4><p>(Not listed on Admin > Diagnostics.) Defaults to <code>null</code>.</p></div></section><nav class=section-nav><div class=container><div class=buttons><a class=previous href=https://docs.pixelfed.org/technical-documentation/artisan/><span class=arrow>←</span><span class=text>Previous page:<br>CLI</span></a></div></div></nav><footer class="section page-footer"><div class=container></div></footer></article></main><footer class=site-footer><hr><div class=container><nav class=footer-nav><ul class=menu><li class=copyright><a href=https://creativecommons.org/licenses/by-sa/4.0/><span style=color:var(--ui-text-bold)><i class="fa fa-cc-cc"></i><i class="fa fa-cc-by"></i><i class="fa fa-cc-sa"></i></span>
    385. 

  385. <span>CC BY-SA 4.0</span></a></li></ul></nav><nav class=social-nav><ul class=menu><li class=mastodon><a href=https://mastodon.social/@pixelfed><svg height="1em" viewbox="0 0 75 79" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M73.84 17.49C72.696 9.002 65.3 2.312 56.53 1.016 55.05.797 49.444.0 36.458.0h-.097c-12.99.0-15.776.797-17.256 1.016-8.525 1.26-16.311 7.271-18.2 15.86-.909 4.23-1.006 8.919-.837 13.22.24 6.17.288 12.327.848 18.47a86.879 86.879.0 002.022 12.115c1.795 7.361 9.064 13.487 16.185 15.986a43.41 43.41.0 0023.68 1.25 34.565 34.565.0 002.562-.701c1.91-.607 4.147-1.285 5.792-2.477a.187.187.0 00.076-.144v-5.953a.175.175.0 00-.216-.17A65.637 65.637.0 0135.65 70.268c-8.906.0-11.301-4.226-11.987-5.985a18.554 18.554.0 01-1.042-4.718.171.171.0 01.136-.178.173.173.0 01.08.002 64.383 64.383.0 0015.115 1.795c1.225.0 2.446.0 3.67-.032 5.121-.144 10.52-.406 15.558-1.39.125-.025.251-.047.359-.079 7.947-1.526 15.51-6.316 16.279-18.445.029-.477.1-5.002.1-5.497.004-1.684.543-11.946-.079-18.251z" fill="url(#a)"/><path d="M61.248 27.026v21.088h-8.356V27.648c0-4.31-1.796-6.507-5.448-6.507-4.015.0-6.026 2.6-6.026 7.735v11.202H33.11V28.875c0-5.134-2.014-7.734-6.03-7.734-3.63.0-5.444 2.198-5.444 6.507v20.466h-8.353V27.026c0-4.308 1.1-7.731 3.3-10.269 2.27-2.531 5.247-3.831 8.942-3.831 4.278.0 7.51 1.644 9.665 4.93l2.079 3.49 2.083-3.49c2.154-3.286 5.386-4.93 9.657-4.93 3.691.0 6.668 1.3 8.945 3.831 2.198 2.535 3.296 5.958 3.293 10.27z" fill="#fff"/><defs><linearGradient id="a" x1="37.069" y1="0" x2="37.069" y2="79" gradientUnits="userSpaceOnUse"><stop stop-color="#6364ff"/><stop offset="1" stop-color="#563acc"/></linearGradient></defs></svg></a></li><li class=pixelfed><a href=https://pixelfed.social/pixelfed><img src="https://avatars0.githubusercontent.com/u/38410642?s=200&amp;v=4" height=16></a></li><li class=twitter><a href=https://twitter.com/pixelfed><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 248 204" height="1em"><path fill="#1d9bf0" d="M221.95 51.29c.15 2.17.15 4.34.15 6.53.0 66.73-50.8 143.69-143.69 143.69v-.04c-27.44.04-54.31-7.82-77.41-22.64 3.99.48 8 .72 12.02.73 22.74.02 44.83-7.61 62.72-21.66-21.61-.41-40.56-14.5-47.18-35.07a50.338 50.338.0 0022.8-.87C27.8 117.2 10.85 96.5 10.85 72.46v-.64a50.18 50.18.0 0022.92 6.32C11.58 63.31 4.74 33.79 18.14 10.71a143.333 143.333.0 00104.08 52.76 50.532 50.532.0 0114.61-48.25c20.34-19.12 52.33-18.14 71.45 2.19 11.31-2.23 22.15-6.38 32.07-12.26a50.69 50.69.0 01-22.2 27.93c10.01-1.18 19.79-3.86 29-7.95a102.594 102.594.0 01-25.2 26.16z"/></svg></a></li><li class=github><a href=https://github.com/pixelfed/pixelfed><svg style="background:#fff;border:1px solid #fff;border-radius:100rem" height="1em" viewBox="0 0 1024 1024" fill="none" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="M8 0C3.58.0.0 3.58.0 8c0 3.54 2.29 6.53 5.47 7.59C5.87 15.66 6.02 15.42 6.02 15.21 6.02 15.02 6.01 14.39 6.01 13.72 4 14.09 3.48 13.23 3.32 12.78 3.23 12.55 2.84 11.84 2.5 11.65 2.22 11.5 1.82 11.13 2.49 11.12 3.12 11.11 3.57 11.7 3.72 11.94 4.44 13.15 5.59 12.81 6.05 12.6 6.12 12.08 6.33 11.73 6.56 11.53 4.78 11.33 2.92 10.64 2.92 7.58c0-.87.31-1.59.82-2.15C3.66 5.23 3.38 4.41 3.82 3.31c0 0 .67-.21 2.2.82C6.66 3.95 7.34 3.86 8.02 3.86S9.38 3.95 10.02 4.13c1.53-1.04 2.2-.82 2.2-.82C12.66 4.41 12.38 5.23 12.3 5.43 12.81 5.99 13.12 6.7 13.12 7.58c0 3.07-1.87 3.75-3.65 3.95C9.76 11.78 10.01 12.26 10.01 13.01 10.01 14.08 10 14.94 10 15.21 10 15.42 10.15 15.67 10.55 15.59 13.71 14.53 16 11.53 16 8c0-4.42-3.58-8-8-8z" transform="scale(64)" fill="#1b1f23"/></svg></a></li></ul></nav><a href=#top>back to top</a></div></footer></body></html>
    386.