Skip to content

Installation

Docker is currently the only planned method way to use Luster.

Docker

  1. The image can be pulled using the following: 
    docker pull medicbehindyou/luster:tagname
  2. Your options for tags are latest, vX.X.X, or thicc.
    • latest is the most recent slim version of Luster. This image has been compressed and had all non essential libraries removed to increase performance.
    • vX.X.X are previous versions of Luster that correspond to the GitHub releases.
    • thiccc is an uncompressed version of latest. This is useful when you want to make changes within the container or want to troubleshoot an issue. Or just like having a useable bash shell available to you if needed.
  3. Once you've chosen your Tag, you can run it with the following command:
    docker run -it --rm --name="lusterTest" -e TZ=Your/Zone -v "/path/to/downloads/:/app/downloads:rw" -v "/path/to/config/:/config:rw" medicbehindyou/luster:tagname
  4. If this is the first time you are running Luster, it will automatically create the SQLite DB and perform any prompt for any migrations necessary for Luster to run.
  5. Luster is now fully ready for you to start using it!