-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add caddy-eventsexec custom build (closes #19)
- Loading branch information
Showing
5 changed files
with
157 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,105 @@ | ||
| # Workflow to build and push a Docker image to Docker Hub, GitHub and Quay Container Registries | ||
| name: Build caddy-eventsexec | ||
|
|
||
| # Controls when the action will run | ||
| on: | ||
| workflow_dispatch: # allows to run the workflow manually from the Actions tab | ||
| push: | ||
| branches: main | ||
| paths: | ||
| - caddy-eventsexec/Dockerfile | ||
|
|
||
| # Environment variables available to all jobs and steps in this workflow | ||
| env: | ||
| DOCKER_BUILDKIT: 1 | ||
| DOCKER_NAME: caddy-eventsexec | ||
| DOCKER_DESCRIPTION: "Caddy Docker custom build with Events Exec module" | ||
|
|
||
| # Jobs to run once the workflow is triggered | ||
| jobs: | ||
| # Job to get image and repository details | ||
| metadata: | ||
| name: Get image and repository details | ||
| runs-on: ubuntu-latest | ||
|
|
||
| outputs: | ||
| version: ${{ steps.version.outputs.version }} | ||
| labels: ${{ steps.metadata.outputs.labels }} | ||
| tags: ${{ steps.metadata.outputs.tags }} | ||
| platforms: linux/amd64,linux/arm64,linux/ppc64le,linux/s390x,linux/arm/v7,linux/arm/v6 | ||
|
|
||
| steps: | ||
| - name: Checkout repository | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| ref: main | ||
|
|
||
| - name: Parse Caddy version | ||
| id: version | ||
| run: echo "version=$(grep -Eo 'caddy:[0-9]+\.[0-9]+\.[0-9]+$' $DOCKER_NAME/Dockerfile | cut -d ':' -f2)" | tee -a $GITHUB_OUTPUT | ||
|
|
||
| - name: Generate image metadata with Caddy version | ||
| uses: docker/metadata-action@v5 | ||
| id: metadata | ||
| with: | ||
| images: | | ||
| docker.io/${{ github.actor }}/${{ env.DOCKER_NAME }} | ||
| ghcr.io/${{ github.actor }}/${{ env.DOCKER_NAME }} | ||
| quay.io/${{ github.actor }}/${{ env.DOCKER_NAME }} | ||
| tags: | | ||
| type=semver,pattern={{version}},value=v${{ steps.version.outputs.version }} | ||
| type=semver,pattern={{major}}.{{minor}},value=v${{ steps.version.outputs.version }} | ||
| type=semver,pattern={{major}},value=v${{ steps.version.outputs.version }} | ||
| labels: | | ||
| org.opencontainers.image.title=${{ env.DOCKER_NAME }} | ||
| org.opencontainers.image.description=${{ env.DOCKER_DESCRIPTION }} | ||
| # Job to build and publish Docker image | ||
| build: | ||
| name: Build and publish Docker image | ||
| runs-on: ubuntu-latest | ||
| needs: metadata | ||
|
|
||
| steps: | ||
| - name: Checkout repository | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| ref: main | ||
|
|
||
| - name: Set up QEMU | ||
| uses: docker/setup-qemu-action@v3 | ||
|
|
||
| - name: Set up Docker Buildx | ||
| uses: docker/setup-buildx-action@v3 | ||
|
|
||
| - name: Login to Docker Hub | ||
| uses: docker/login-action@v3 | ||
| with: | ||
| username: ${{ github.actor }} | ||
| password: ${{ secrets.DOCKERHUB_TOKEN }} | ||
|
|
||
| - name: Login to GitHub Container Repository | ||
| uses: docker/login-action@v3 | ||
| with: | ||
| registry: ghcr.io | ||
| username: ${{ github.actor }} | ||
| password: ${{ github.token }} | ||
|
|
||
| - name: Login to Quay Container Registry | ||
| uses: docker/login-action@v3 | ||
| with: | ||
| registry: quay.io | ||
| username: ${{ github.actor }} | ||
| password: ${{ secrets.QUAY_TOKEN }} | ||
|
|
||
| - name: Build and publish container image | ||
| uses: docker/build-push-action@v5 | ||
| id: build | ||
| with: | ||
| context: . | ||
| file: ./${{ env.DOCKER_NAME }}/Dockerfile | ||
| push: true | ||
| provenance: false | ||
| tags: ${{ needs.metadata.outputs.tags }} | ||
| labels: ${{ needs.metadata.outputs.labels }} | ||
| platforms: ${{ needs.metadata.outputs.platforms }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| # syntax=docker/dockerfile:1 | ||
| FROM caddy:2.7.6-builder AS builder | ||
|
|
||
| RUN xcaddy build \ | ||
| --with github.com/mholt/caddy-events-exec | ||
|
|
||
| FROM caddy:2.7.6 | ||
|
|
||
| COPY --from=builder /usr/bin/caddy /usr/bin/caddy |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| # Caddy Docker build with Events Exec module | ||
|
|
||
| [](https://hub.docker.com/r/serfriz/caddy-eventsexec) | ||
| [](https://ghcr.io/serfriz/caddy-eventsexec) | ||
| [](https://quay.io/serfriz/caddy-eventsexec) | ||
|
|
||
| [](https://github.com/serfriz/caddy-custom-builds/releases) | ||
| [](https://github.com/serfriz/caddy-custom-builds/actions/workflows/build.caddy-eventsexec.yml) | ||
|
|
||
| This image is updated automatically by GitHub Actions when a new version of [Caddy](https://github.com/caddyserver/caddy) is released using the official [Caddy Docker](https://hub.docker.com/_/caddy) image and the following module: | ||
| - [**Events Exec**](https://github.com/serfriz/caddy-custom-builds?tab=readme-ov-file#events-exec): implements an event handler that allows to execute commands on the system | [mholt/caddy-events-exec](https://github.com/mholt/caddy-events-exec) | ||
|
|
||
| ## Usage | ||
|
|
||
| Since this image built off the official Caddy Docker image, the same [volumes](https://docs.docker.com/storage/volumes/) and/or [bind mounts](https://docs.docker.com/storage/bind-mounts/), ports mapping, etc. can be used with this container. Additional [environment variables](https://caddyserver.com/docs/caddyfile/concepts#environment-variables) may be needed for the added modules. Please, refer to the repository's [README](https://github.com/serfriz/caddy-custom-builds?tab=readme-ov-file#container-creation) file for further usage instructions. | ||
|
|
||
| Docker builds for all Caddy supported platforms available at the following container registries: | ||
| - [**Docker Hub**](https://hub.docker.com/r/serfriz/caddy-eventsexec) `docker pull serfriz/caddy-eventsexec:latest` | ||
| - [**GitHub Packages**](https://ghcr.io/serfriz/caddy-eventsexec) `docker pull ghcr.io/serfriz/caddy-eventsexec:latest` | ||
| - [**Quay**](https://quay.io/serfriz/caddy-eventsexec) `docker pull quay.io/serfriz/caddy-eventsexec:latest` | ||
|
|
||
| ### Tags | ||
|
|
||
| The following tags are available for the `serfriz/caddy-eventsexec` image: | ||
|
|
||
| - `latest` | ||
| - `<version>` (eg: `2.7.4`, including: `2.7`, `2`, etc.) | ||
|
|
||
| ## Contributing | ||
|
|
||
| Feel free to contribute, request additional Caddy images with your preferred modules, and make things better by opening an [Issue](https://github.com/serfriz/caddy-custom-builds/issues) or [Pull Request](https://github.com/serfriz/caddy-custom-builds/pulls). | ||
|
|
||
| ## License | ||
|
|
||
| Software under [GPL-3.0](https://github.com/serfriz/caddy-custom-builds/blob/main/LICENSE) ensures users' freedom to use, modify, and distribute it while keeping the source code accessible. It promotes transparency, collaboration, and knowledge sharing. Users agree to comply with the GPL-3.0 license terms and provide the same freedom to others. |