Security - jzohrab/lute GitHub Wiki


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!


Lute doesn't have any security or user authentication, because during development I figured that users would be running it from a private folder on their personal machines. For some people, that might not be good enough, so you can make a small change to your config to add basic auth.

Add security

You can add HTTP Basic Authentication to your Lute installation as follows:

  1. Change "security: false" to "security: true" in config/packages/security.yaml

  2. Add keys to your .env file

# ---------------------
# Security

LOGIN_USERNAME=yourusername
LOGIN_PASSWORD=yourpassword

Use whatever username and password you want.

Notes

  • This is (obviously) quite simple security - if anyone can access the box with the installation, they'll see the information in plaintext. :-)
  • There is no log out button on the browser, so you might want to use incognito window every time you log in, so the creds aren't stored in the browser.
  • If you use docker, you'll need to docker compose stop; docker compose build; docker compose start after editing the security.yaml and your .env file.

Thanks to 99MengXin for the notes in GitHub issue 27.

⚠️ **GitHub.com Fallback** ⚠️