/webhookz

Apache License 2.0Apache-2.0

webhookz

Template repository for sending a GitHub webhook to a private server with the OpenZiti Webhook Action

Use this template repository

Do this first: there's a button in the GitHub UI to "Use this template" which will give you a separate commit history based on this repo. Clone your new repo and follow the steps below.

Configure OpenZiti

A private webhook server is included in this repo as a Docker Compose project. These steps will guide you run and publish the server so it can receive the GitHub webhook via OpenZiti.

  1. Sign up for a free account in the Ziti Edge Developer Sandbox (ZEDS) at https://zeds.openziti.org/. We'll create a couple of identities to attach to an OpenZiti network provided by ZEDS.

  2. In ZEDS, follow the "build your app" button. Populate the form with an app name like "my webhook app", two identities "github" and "server", and a service named "webhookz". Finish up with the "build my app" button.

  3. On the following screen click the edit button for the service "webhookz".

    1. Create a config with type intercept.v1.
    {
    "addresses": [
        "webhookz.ziti"
    ],
    "protocols": [
        "tcp"
    ],
    "portRanges": [
        {
        "low": 80,
        "high": 80
        }
    ]
}
    1. Create a config with type host.v1.
    {
    "port": 8080,
    "address": "httpbin",
    "protocol": "tcp"
}

  4. Go back to "manage app" and click the download buttons to get the token files for identities "github" and "server".

  5. Copy "github.jwt" and "server.jwt" into the directory where you cloned this repo.

  6. In your terminal, change to the directory where you cloned this repo. Enroll "github" to obtain the identity file "github.json" in the current directory.

    docker run --rm --volume ${PWD}:/mnt/ openziti/quickstart /openziti/ziti-bin/ziti edge enroll /mnt/github.jwt

  7. In the GitHub UI, create a new GitHub Actions secret named ZITI_WEBHOOK_IDENTITY with the contents of "github.json".

  8. In your terminal, run the Docker Compose project to start the demo webhook server and OpenZiti tunneler.

    docker compose up --detach

    You should now have a new file "server.json" in the directory where you cloned this repo. That is the OpenZiti identity file used by the tunneler running in one of the containers.

  9. Finally, trigger the GitHub Actions workflow to demonstrate sending a GitHub webhook to your private server. Navigate to the workflow in the GitHub UI and punch the "Run workflow" button. You may instead trigger it with the GitHub CLI.

    gh workflow run main.yml

  10. Optionally, follow the private server's log to see the webhook activity from GitHub

    docker compose logs --follow httpbin

Have questions?