MediaLit is a Node.js based app to store, convert and optimise the media files on any AWS S3 compatible storage.

This app is based on Express which cannot work reliably when it is behind a proxy. For example, it cannot detect if it behind a proxy.

Hence, we need to enable it on our own. To do that, set the following environment variable.

ENABLE_TRUST_PROXY=true

In order to interact with the API, you need to have an API key. To create one, execute the following command.

docker exec <container_id> dist/scripts/create-local-user.js

After running the above command, you will get an API key which you can use to interact with the app.

You can only run this script once.

CAUTION: Keep the generated API key confidential as anyone could be able to store files on your instance.

We build on Linux based systems. Hence the instructions are for those system only. If you are on Windows, we recommend using WSL.

sudo apt install ffmpeg imagemagick webp

pnpm install

pnpm --filter=@medialit/images build
pnpm --filter=@medialit/thumbnail build

pnpm --filter=@medialit/api dev