{"id":20653488,"url":"https://github.com/t-ski/github-webhook-server","last_synced_at":"2025-03-09T21:53:30.143Z","repository":{"id":212307449,"uuid":"377559088","full_name":"t-ski/github-webhook-server","owner":"t-ski","description":"Multi-channel webhook server for GitHub events.","archived":false,"fork":false,"pushed_at":"2024-05-24T23:14:56.000Z","size":30,"stargazers_count":1,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-17T10:44:34.754Z","etag":null,"topics":["webhook","webhook-server"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/t-ski.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":"2021-06-16T16:22:50.000Z","updated_at":"2024-05-24T23:15:00.000Z","dependencies_parsed_at":"2025-01-17T10:44:32.685Z","dependency_job_id":"82c74f54-747f-4068-a1ef-4d959cad480e","html_url":"https://github.com/t-ski/github-webhook-server","commit_stats":null,"previous_names":["t-ski/github-webhook-server"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/t-ski%2Fgithub-webhook-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/t-ski%2Fgithub-webhook-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/t-ski%2Fgithub-webhook-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/t-ski%2Fgithub-webhook-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/t-ski","download_url":"https://codeload.github.com/t-ski/github-webhook-server/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242757002,"owners_count":20180204,"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":["webhook","webhook-server"],"created_at":"2024-11-16T17:44:31.056Z","updated_at":"2025-03-09T21:53:30.121Z","avatar_url":"https://github.com/t-ski.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Github Webhook Server\n\nMulti-channel webhook server for [GitHub events](https://docs.github.com/en/developers/webhooks-and-events/webhooks/creating-webhooks).\n\n## Installation\n\n``` cli\nnpm i -G t-ski/github-webhook-server\n```\n\n\u003e Install **github-webhook-server** globally in order to work with the presented CLI interface. Project local installations must prepend subsequently stated commands with `npx`.\n\n## CLI Usage\n\n``` cli\ngithub-webhook-server [(--start|-S)=./] [(--stop|-T)] [(--monitor|-M)] [--help]\n```\n\n| Parameter | Shorthand | Description |\n| --------- | --------- | ----------- |\n| **--start** | **-S** | *Start a webhook server with the given config JSON* |\n| **--stop** | **-T** | *Stop (terminate) a webhook server given the associated port* |\n| **--monitor** | **-M** | *Monitor active webhook servers* |\n| **--help** | | *Display help text* |\n\n## Setup\n\nA single webhook server is associated with a statically consumed config file (*.json). A config file contains both globally and hook specific information upon which the server instance is created and maintained.\n\n### Globals\n\nGlobal properties comprise server configurations that affect the spanning context.\n\n``` json\n{\n  \"name\": \"my-hook\",\n  \"port\": 1234\n}\n```\n\n| Property | Desciption | Default |\n| -------- | ---------- | ------- |\n| `name` | *Name to associate with server process* | `null` |\n| `port` | *Port to have the server listen on* | `9797` |\n\n### Hook channels\n\nSince the server can handle many hooks at once, each individual hook must be configured to the global `hooks` property array.  \n\n``` json\n{\n  \"hooks\": [\n    {\n      \"endpoint\": \"/endpoint\",\n      \"secret\": \"abc...xyz\",\n      \"cmd\": \"git pull \u0026\u0026 npm update\",\n      \"module\": \"../app/hook.js\",\n      \"cwd\": \"../app/\"\n    }, …\n  ]\n}\n```\n\n| Property | Desciption | Default |\n| -------- | ---------- | ------- |\n| `endpoint` | *Hook associated endpoint / request pathname as defined on GitHub* | `null` |\n| `secret` | *Hook individual secret as present on GitHub* | `null` |\n| `cmd` | *CLI command to perform upon hook activation* | `null` |\n| `module` | *JS module to execute / interpret upon hook activation* | `null` |\n| `cwd` | *Working directory of the hook bound dynamics* | `./` |\n\n## \n\n\u003csub\u003e© Thassilo Martin Schiepanski\u003c/sub\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ft-ski%2Fgithub-webhook-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ft-ski%2Fgithub-webhook-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ft-ski%2Fgithub-webhook-server/lists"}