{"id":19175819,"url":"https://github.com/handcraftedbits/docker-nginx-unit-webhook","last_synced_at":"2026-06-15T06:02:41.942Z","repository":{"id":95812357,"uuid":"63910584","full_name":"handcraftedbits/docker-nginx-unit-webhook","owner":"handcraftedbits","description":"A Docker container that provides a webhook unit for NGINX Host","archived":false,"fork":false,"pushed_at":"2017-09-26T02:28:44.000Z","size":9,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-04T01:56:25.366Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/handcraftedbits.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-07-22T00:16:41.000Z","updated_at":"2019-01-22T13:42:44.000Z","dependencies_parsed_at":"2023-04-30T11:48:20.351Z","dependency_job_id":null,"html_url":"https://github.com/handcraftedbits/docker-nginx-unit-webhook","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/handcraftedbits%2Fdocker-nginx-unit-webhook","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/handcraftedbits%2Fdocker-nginx-unit-webhook/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/handcraftedbits%2Fdocker-nginx-unit-webhook/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/handcraftedbits%2Fdocker-nginx-unit-webhook/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/handcraftedbits","download_url":"https://codeload.github.com/handcraftedbits/docker-nginx-unit-webhook/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240254288,"owners_count":19772392,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-09T10:25:29.131Z","updated_at":"2026-06-15T06:02:36.896Z","avatar_url":"https://github.com/handcraftedbits.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# NGINX Host Webhook Unit [![Docker Pulls](https://img.shields.io/docker/pulls/handcraftedbits/nginx-unit-webhook.svg?maxAge=2592000)](https://hub.docker.com/r/handcraftedbits/nginx-unit-webhook)\n\nA [Docker](https://www.docker.com) container that provides a webhook unit for\n[NGINX Host](https://github.com/handcraftedbits/docker-nginx-host).\n\nWebhooks are useful for creating an endpoint that, when accessed, runs a command on the server hosting the webhook.\nThis is commonly used by REST APIs as a way to subscribe to an event.  For example, [GitHub](https://github.com)'s APIs\ncan call a webhook whenever a push has been made to a Git repository.\n\nThis container makes use of [adnanh/webhook](https://github.com/adnanh/webhook) to create webhooks.\n\n# Features\n\n* adnanh/webhook 2.6.2\n\n# Usage\n\n## Configuration\n\nIt is highly recommended that you use container orchestration software such as\n[Docker Compose](https://www.docker.com/products/docker-compose) when using this NGINX Host unit as several Docker\ncontainers are required for operation.  This guide will assume that you are using Docker Compose.\n\nTo begin, start with a basic `docker-compose.yml` file as described in the\n[NGINX Host configuration guide](https://github.com/handcraftedbits/docker-nginx-host#configuration).  Then, add a\nservice for the NGINX Host webhook unit (named `webhooks`):\n\n```yaml\nwebhooks:\n  image: handcraftedbits/nginx-unit-webhook\n  environment:\n    - NGINX_UNIT_HOSTS=mysite.com\n    - NGINX_URL_PREFIX=/webhooks\n  volumes:\n    - data:/opt/container/shared\n    - /home/me/webhooks.json:/opt/container/webhooks.json\n```\n\nObserve the following:\n\n* We mount `/opt/container/webhooks.json` using the local file `/home/me/webhooks.json`.  This is a file containing our\n  webhook configuration.  Refer to the [documentation](https://github.com/adnanh/webhook/blob/master/README.md) for\n  information on the contents of this file.\n* As with any other NGINX Host unit, we mount our data volume, in this case named `data`, to `/opt/container/shared`.\n\nFinally, we need to create a link in our NGINX Host container to the `webhooks` container in order to host the\nwebhooks.  Here is our final `docker-compose.yml` file:\n\n```yaml\nversion: \"2.1\"\n\nvolumes:\n  data:\n\nservices:\n  proxy:\n    image: handcraftedbits/nginx-host\n    links:\n      - webhooks\n    ports:\n      - \"443:443\"\n    volumes:\n      - data:/opt/container/shared\n      - /etc/letsencrypt:/etc/letsencrypt\n      - /home/me/dhparam.pem:/etc/ssl/dhparam.pem\n\n  webhooks:\n    image: handcraftedbits/nginx-unit-webhook\n    environment:\n      - NGINX_UNIT_HOSTS=mysite.com\n      - NGINX_URL_PREFIX=/webhooks\n    volumes:\n      - data:/opt/container/shared\n      - /home/me/webhooks.json:/opt/container/webhooks.json\n```\n\nThis will result in making the webhooks available at `https://mysite.com/webhooks`.\n\n## Running the NGINX Host Webhook Unit\n\nAssuming you are using Docker Compose, simply run `docker-compose up` in the same directory as your\n`docker-compose.yml` file.  Otherwise, you will need to start each container with `docker run` or a suitable\nalternative, making sure to add the appropriate environment variables and volume references.\n\n# Reference\n\n## Environment Variables\n\n### `WEBHOOK_VERBOSE`\n\nUsed to show verbose webhook logging (e.g., rule matching, command execution) if set to `true`.\n\n**Default value**: `false`\n\n### Others\n\nPlease see the NGINX Host [documentation](https://github.com/handcraftedbits/docker-nginx-host#units) for information\non additional environment variables understood by this unit.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhandcraftedbits%2Fdocker-nginx-unit-webhook","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhandcraftedbits%2Fdocker-nginx-unit-webhook","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhandcraftedbits%2Fdocker-nginx-unit-webhook/lists"}