Skip to content

Commit

Permalink
Add GitHub Action for Docker images
Browse files Browse the repository at this point in the history
Add a GitHub Action that builds a docker image on every push and tag,
and publishes it to GitHub container repository, and -- if a docker
username is defined in the repository secrets -- to the Docker Hub.
  • Loading branch information
oxc committed Jan 12, 2025
1 parent 8fced02 commit 608f18f
Show file tree
Hide file tree
Showing 3 changed files with 119 additions and 1 deletion.
101 changes: 101 additions & 0 deletions .github/workflows/docker.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
name: Build and publish Docker images

on:
push:
branches:
- master
pull_request:
branches:
- master
release:
types: [published]

jobs:
docker:
strategy:
fail-fast: false
matrix:
include:
- id: cu118
name: CUDA 11.8
pytorch_install_args: "--index-url https://download.pytorch.org/whl/cu118"
- id: cu121
name: CUDA 12.1
pytorch_install_args: "--index-url https://download.pytorch.org/whl/cu121"
- id: cu124
name: CUDA 12.4
pytorch_install_args: "--index-url https://download.pytorch.org/whl/cu124"
- id: rocm6.2
name: ROCm 6.2
pytorch_install_args: "--index-url https://download.pytorch.org/whl/rocm6.2"
- id: cpu
name: CPU only
pytorch_install_args: "--index-url https://download.pytorch.org/whl/cpu"
extra_args: --cpu


name: ${{ matrix.name }}
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Check which repositories to use
id: repositories
run: |
echo "GHCR_IMAGE_NAME=ghcr.io/${GITHUB_REPOSITORY_OWNER}/comfyui" >> "$GITHUB_ENV"
if [[ -n "${DOCKERHUB_USERNAME}" ]]; then
echo "DOCKERHUB_IMAGE_NAME=${DOCKERHUB_USERNAME}/comfyui" >> "$GITHUB_ENV"
else
echo "DOCKERHUB_IMAGE_NAME=" >> "$GITHUB_ENV"
echo "No Docker Hub username set, only deploying to GitHub Container Repository"
fi
env:
DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
GITHUB_REPOSITORY_OWNER: ${{ github.repository_owner }}
- name: Docker meta
id: meta
uses: docker/metadata-action@v5
with:
# list of Docker images to use as base name for tags
images: |
${{ env.DOCKERHUB_IMAGE_NAME }}
${{ env.GHCR_IMAGE_NAME }}
flavor: |
suffix=-${{ matrix.id }},onlatest=true
# generate Docker tags based on the following events/attributes
tags: |
type=ref,event=branch
type=ref,event=pr
type=semver,pattern={{version}}
type=semver,pattern={{major}}.{{minor}}
type=semver,pattern={{major}}
type=sha
# set latest tag for default branch
type=raw,value=latest,enable=${{ github.event_name == 'release' }}
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v3
- name: Login to Docker Hub
if: github.event_name != 'pull_request' && env.DOCKERHUB_IMAGE_NAME != ''
uses: docker/login-action@v3
with:
username: ${{ secrets.DOCKERHUB_USERNAME }}
password: ${{ secrets.DOCKERHUB_TOKEN }}
- name: Login to GHCR
if: github.event_name != 'pull_request'
uses: docker/login-action@v3
with:
registry: ghcr.io
username: ${{ github.repository_owner }}
password: ${{ secrets.GITHUB_TOKEN }}
- name: Build and push
uses: docker/build-push-action@v5
with:
context: .
push: ${{ github.event_name != 'pull_request' }}
tags: ${{ steps.meta.outputs.tags }}
labels: ${{ steps.meta.outputs.labels }}
build-args: |
PYTORCH_INSTALL_ARGS=${{ matrix.pytorch_install_args }}
EXTRA_ARGS=${{ matrix.extra_args }}
cache-from: type=gha,scope=${{ github.ref_name }}-${{ matrix.id }}
cache-to: type=gha,mode=max,scope=${{ github.ref_name }}-${{ matrix.id }}
3 changes: 2 additions & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -68,11 +68,12 @@ COPY --chown=nobody:${USER_GID} .git .git
# default environment variables
ENV COMFYUI_ADDRESS=0.0.0.0
ENV COMFYUI_PORT=8188
ENV COMFYUI_EXTRA_BUILD_ARGS="${EXTRA_ARGS}"
ENV COMFYUI_EXTRA_ARGS=""
# default start command
CMD \
if [ -d "${VIRTUAL_ENV_CUSTOM}" ]; then \
rsync -aP "${VIRTUAL_ENV}/" "${VIRTUAL_ENV_CUSTOM}/" ;\
sed -i "s!${VIRTUAL_ENV}!${VIRTUAL_ENV_CUSTOM}!g" "${VIRTUAL_ENV_CUSTOM}/pyvenv.cfg" ;\
fi ;\
python -u main.py --listen "${COMFYUI_ADDRESS}" --port "${COMFYUI_PORT}" ${EXTRA_ARGS} ${COMFYUI_EXTRA_ARGS}
python -u main.py --listen "${COMFYUI_ADDRESS}" --port "${COMFYUI_PORT}" ${COMFYUI_EXTRA_BUILD_ARGS} ${COMFYUI_EXTRA_ARGS}
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -210,6 +210,22 @@ After this you should have everything installed and can proceed to running Comfy

## Docker

There are prebuilt docker images for AMD and NVIDIA GPUs on [GitHub Packages](https://ghcr.io/comfyanonymous/comfyui).

You can pull them to your local docker registry with:

```shell
# For NVIDIA GPUs
docker pull ghcr.io/comfyanonymous/comfyui:latest-cu124
# For AMD GPUs
docker pull ghcr.io/comfyanonymous/comfyui:latest-rocm6.2

# For CPU only
docker pull ghcr.io/comfyanonymous/comfyui:latest-cpu
```

### Building images manually

You can build a docker image with the `Dockerfile` in this repo.
Specify, `PYTORCH_INSTALL_ARGS` build arg with one of the PyTorch commands above to build for AMD or NVIDIA GPUs.
```shell
Expand Down

0 comments on commit 608f18f

Please sign in to comment.