diff --git a/.github/workflows/docker.yml b/.github/workflows/docker.yml new file mode 100644 index 0000000..c8527ff --- /dev/null +++ b/.github/workflows/docker.yml @@ -0,0 +1,102 @@ +name: Docker + +on: + push: + branches: [main] + pull_request: + branches: [main] + release: + types: [published] + +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true + +permissions: + packages: write + +jobs: + build_and_push: + name: Build and Push + runs-on: ubuntu-latest + strategy: + # Prevent a failure in one image from stopping the other builds + fail-fast: false + matrix: + include: + - context: "." + file: "Dockerfile" + image: "mini-qr" + # ARM not working. Needs further research. + platforms: "linux/arm64,linux/amd64" + + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Set up QEMU + uses: docker/setup-qemu-action@v3.0.0 + + - name: Set up Docker Buildx + uses: docker/setup-buildx-action@v3.0.0 + # Workaround to fix error: + # failed to push: failed to copy: io: read/write on closed pipe + # See https://github.com/docker/build-push-action/issues/761 + with: + driver-opts: | + image=moby/buildkit:v0.10.6 + + - name: Login to GitHub Container Registry + uses: docker/login-action@v3 + # Skip when PR from a fork + if: ${{ !github.event.pull_request.head.repo.fork }} + with: + registry: ghcr.io + username: ${{ github.repository_owner }} + password: ${{ secrets.GITHUB_TOKEN }} + + - name: Sanitize unfortunate names + id: sanitize_names + uses: ASzc/change-string-case-action@v5 + with: + string: ${{ github.repository_owner }} + + - name: Generate docker image tags + id: metadata + uses: docker/metadata-action@v5 + with: + flavor: | + latest=true + images: | + name=ghcr.io/${{ steps.sanitize_names.outputs.lowercase }}/${{matrix.image}} + tags: | + # Tag with branch name + type=ref,event=branch + # Tag with pr-number + type=ref,event=pr + # Tag with git tag on release + type=ref,event=tag + type=raw,value=release,enable=${{ github.event_name == 'release' }} + + - name: Determine build cache output + id: cache-target + run: | + if [[ "${{ github.event_name }}" == "pull_request" ]]; then + # Essentially just ignore the cache output (PR can't write to registry cache) + echo "cache-to=type=local,dest=/tmp/discard,ignore-error=true" >> $GITHUB_OUTPUT + else + echo "cache-to=type=registry,mode=max,ref=ghcr.io/${{ steps.sanitize_names.outputs.lowercase }}/mini-qr-build-cache:${{ matrix.image }}" >> $GITHUB_OUTPUT + fi + + - name: Build and push image + uses: docker/build-push-action@v5.1.0 + with: + context: ${{ matrix.context }} + file: ${{ matrix.file }} + platforms: ${{ matrix.platforms }} + # Skip pushing when PR from a fork + push: ${{ !github.event.pull_request.head.repo.fork }} + cache-from: type=registry,ref=ghcr.io/${{ steps.sanitize_names.outputs.lowercase }}/mini-qr-build-cache:${{matrix.image}} + cache-to: ${{ steps.cache-target.outputs.cache-to }} + tags: ${{ steps.metadata.outputs.tags }} + labels: ${{ steps.metadata.outputs.labels }} \ No newline at end of file diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..835b011 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,16 @@ +FROM node:lts-alpine + +RUN npm install -g http-server + +WORKDIR /src + +COPY package*.json ./ + +RUN npm install + +COPY . . + +RUN npm run build + +EXPOSE 8080 +CMD [ "http-server", "dist" ] \ No newline at end of file diff --git a/README.md b/README.md index 659aec9..2cd46db 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,16 @@ A customizable QR code generator to create beautiful and unique QR codes. https://github.com/lyqht/mini-qr/assets/35736525/991b2d7e-f168-4354-9091-1678d2c1bddb + +## Self-hosting with Docker 🐋 +Mini-QR can easily be self-hosted. We provide a [docker-compose.yml](docker-compose.yml) file as well as our own images. We are using GitHub's `ghrc.io` Container Registry. + +```bash +wget https://github.com/lyqht/mini-qr/raw/main/docker-compose.yml + +docker compose up -d +``` + ## Features - Generate QR codes with custom colors and styles diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 0000000..c671751 --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,9 @@ +--- +version: "3.8" +services: + mini-qr: + image: ghcr.io/lyqht/mini-qr:latest + container_name: mini-qr + ports: + - 8081:8080 + restart: unless-stopped