horneds/muffin-node repository overview

⁠Muffin-Docker

• Python(muffin, uvicorn, gunicorn): https://hub.docker.com/r/horneds/muffin⁠
• Same + NodeJS: https://hub.docker.com/r/horneds/muffin-node⁠

Docker⁠ image with Muffin⁠ managed by Gunicorn⁠

latest currently points to py314.

⁠Supported images

• muffin:py311⁠, muffin-node:py311⁠
• muffin:py312⁠, muffin-node:py312⁠
• muffin:py313⁠, muffin-node:py313⁠
• muffin:py314, muffin:latest⁠, muffin-node:py314, muffin-node:latest⁠

⁠How to use

⁠Quick start

Run the image directly (without building your own image first):

docker run -d --name muffin -p 80:80 horneds/muffin:latest

Then open: http://127.0.0.1/⁠

⁠Use as a base image

• You don't need to clone the GitHub repo. You can use this image as a base image for other images, using this in your Dockerfile:

FROM horneds/muffin:latest

COPY ./app /app

By default the startup script will auto-detect your app module in this order:

1. /app/app.py
2. /app/main.py
3. /app/app/app.py
4. /app/app/main.py

And will expect it to contain a variable app with your "ASGI" application.

Then you can build your image from the directory that has your Dockerfile, e.g:

docker build -t myimage ./

• Run a container based on your image:

docker run -d --name mycontainer -p 80:80 myimage

You should be able to check it in your Docker container's URL, for example: http://127.0.0.1/⁠ (or equivalent, using your Docker host).

⁠Dependencies and packages

You will probably also want to add dependencies for your app and pin them to specific versions.

muffin images already include Gunicorn and Uvicorn worker support. Add Uvicorn/Gunicorn only if you need to pin/override versions for your own image.

This way you can make sure your app always works as expected.

You could install packages with pip commands in your Dockerfile, using a requirements.txt, or even using Poetry⁠.

⁠Using PIP

Here's a small example of one of the ways you could install your dependencies making sure you have a pinned version for each package.

Let's say you have your dependencies in a file requirements.txt.

Then you could have a Dockerfile like:

FROM horneds/muffin:latest

# Copy and install dependencies
COPY ./requirements.txt /app/requirements.txt
RUN pip install -r /app/requirements.txt

COPY ./app /app

That will:

• Copy your application requirements.
• Install the dependencies.
• Then copy your app code.

⁠Advanced usage

⁠Environment variables

Use APP_MODULE for explicit control, or MODULE_NAME + VARIABLE_NAME for convenience.

• MODULE_NAME (app, main, app.app, app.main) -- python module that contains Muffin application

• VARIABLE_NAME (app) -- The variable inside of the Python module that contains the Muffin application

• APP_MODULE (<MODULE_NAME>:<VARIABLE_NAME>) -- full ASGI app import path. If set, this value is used directly.

• SETUP_SCRIPT -- Optional setup script to run before start gunicorn

• GWORKER_CLASS (uvicorn.workers.UvicornWorker) -- Gunicorn Worker Class

• GWORKERS (num of CPU) -- Number of gunicorn workers

• HOST (0.0.0.0) -- Host to bind the server

• PORT (80) -- Port to bind the server

• GBIND (0.0.0.0:80) -- Address (host:port) to bind the server inside the container. If the variable is set, the variables $HOST, $PORT will be ignored.

• GLOG_LEVEL (info) -- Gunicorn log level

• GUNICORN_CMD_ARGS -- Optional Gunicorn command arguments

⁠License

This project is licensed under the terms of the MIT license.