Lute configuration file

---

This documentation is deprecated/obsolete. Lute v2 has been replaced by Lute v3, a full Python rewrite. Please see the Lute v3 manual which includes notes on installation. If you have Lute v2, you can easily migrate to v3. Thank you!

---

Your environment is configured in the .env file in the project root directory, using your favorite text editor (Notepad for Windows, TextEdit for Mac, vim, emacs, etc).

NOTE: depending on your system, the ".env" files may be hidden, but they're there! You can show hidden files on your system in different ways: on a Mac, you can hit Command + Shift + ., on Windows play with Windows Explorer settings. Holy smokes computers are annoying sometimes.

You can change the .env file, provided you adhere to the config file format (see below for notes). Most settings in these templates should be fine as defaults. If the .env file says "Don't change this", then ... please don't. :-D

• For Docker users: The settings in the .env file are passed to the container when you do docker compose up. If you edit the .env file, you'll need to restart the container with docker composer stop; docker compose up.
• For non-Docker users: changes will be immediately present on any page refresh.

Config file format

Lines starting with # are ignored. Settings are set per line, as SETTING=value, and spaces are not allowed.

For example:

# This line is a comment, and is ignored.

# These have spaces, and so won't work
BADEXAMPLE = something
BADEXAMPLE2=spaces between words

# These are OK:
GOOD_EXAMPLE=something_good
GOOD_EX_2="this has quotes and so is ok"