Giter Club home page Giter Club logo

webhookproxy's Introduction

Webhook Proxy

Proxies Github webhooks to internal servers.

Getting started

Build

make

Creating an endpoint

base64EncodedSecret=$(echo -n "foobar" | base64)
curl -X POST \
    -d '{"name": "receive-all-hook", "team": "my-team-name", "secret": "'$base64EncodedSecret'", "url": "http://internal-server.org/myapp"}' \
    http://localhost:8080/hooks

The response will be something like:

{
  "id":"368a1500082a071a7629c6ad704f7289e220fcc9",
  "name":"receive-all-hook",
  "team":"my-team-name",
  "url":"http://internal-server.org/myapp",
  "proxy_url":"/hooks/368a1500082a071a7629c6ad704f7289e220fcc9",
  "created_at":"2018-05-16T10:54:58.1838475Z"
}

Use proxy_url as webhook url when creating the webhook in GitHub and use the secret that you generated when creating the webhook proxy endpoint (in the example above, this would be foobar).

Listing endpoints

curl http://localhost:8080/hooks
[
    {
        "id":"368a1500082a071a7629c6ad704f7289e220fcc9",
        "name":"receive-all-hook",
        "team":"my-team-name",
        "url":"http://internal-server.org/myapp",
        "proxy_url":"/hooks/368a1500082a071a7629c6ad704f7289e220fcc9",
        "created_at":"2018-05-16T10:54:58.1838475Z"
    }
]

Listing specific endpoint

curl http://localhost:8080/hooks/368a1500082a071a7629c6ad704f7289e220fcc9
{
    "id":"368a1500082a071a7629c6ad704f7289e220fcc9",
    "name":"receive-all-hook",
    "team":"my-team-name",
    "url":"http://internal-server.org/myapp",
    "proxy_url":"/hooks/368a1500082a071a7629c6ad704f7289e220fcc9",
    "created_at":"2018-05-16T10:54:58.1838475Z"
}

Deleting endpoint

curl -X DELETE http://localhost:8080/hooks/368a1500082a071a7629c6ad704f7289e220fcc9

Server responds with 204 No Content if ok.


Contact us

Code/project related questions can be sent to:

For NAV employees

We are also available on the slack channel #github-webhooks for internal communication.

webhookproxy's People

Contributors

davidsteinsland avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

webhookproxy's Issues

Rette feil/mangler i henhold til krav i navikt/utvikling (funnet av roboten repo-linter)

Dette er en autogenerert issue, laget av et skript som går gjennom alle NAV sine kodebaser på Github og gjør diverse sjekker. Her er en liste over ting som må endres.

Kodebasen mangler en CODEOWNERS-fil

Dette er en fil som skal ligge i rotkatalogen, og angir hvilket team som eier kodebasen, på et maskinlesbart format. Den enkleste varianten, som vil holde for de fleste, er å ha en CODEOWNERS-fil som ser slik ut: (Merk at det skal være asterisk/stjerne foran navn på teamet!)

* @navikt/teamnavn

Gyldige teamnavn på Github er:

  • @navikt/apen-kildekode (Åpen kildekode)
  • @navikt/aura (aura)
  • @navikt/bris (bris)
  • @navikt/core (Core)
  • @navikt/dagpenger (Dagpenger)
  • @navikt/developers (Developers)
  • @navikt/digisos (DIGISOS)
  • @navikt/digisyfo (Digisyfo)
  • @navikt/dolly-freg (Dolly-freg)
  • @navikt/forenklet-oppfolging (forenklet oppfølging)
  • @navikt/gjenlevende (gjenlevende)
  • @navikt/gosys (Gosys)
  • @navikt/informasjon-og-veiledning (Informasjon og veiledning)
  • @navikt/integrasjon (Integrasjon)
  • @navikt/kuhr-helse (kuhr-helse)
  • @navikt/machine-users (machine-users)
  • @navikt/melosys (Melosys)
  • @navikt/mobilarbeidsplass (MobilArbeidsplass)
  • @navikt/nav-frontend-admins (nav-frontend-admins)
  • @navikt/nav-labs (NAV-labs)
  • @navikt/pam (PAM)
  • @navikt/peon (peon)
  • @navikt/personoversikt (Personoversikt)
  • @navikt/pus (pus)
  • @navikt/redaktorer (redaktører)
  • @navikt/samordning (samordning)
  • @navikt/selvbetjening-core (selvbetjening-core)
  • @navikt/team-arbeid (Team Arbeid)
  • @navikt/team-oppfolging-fo (Team oppfølging - FO)
  • @navikt/team-personbruker (Team Personbruker)
  • @navikt/team-soknad (Team søknad)

Her er en oppdatert liste over team i Github.
Mangler teamet deres i lista? Ta kontakt med noen i Core-teamet på Github, så kan de opprette et team til dere.

Hvis det trengs spesielle tilpasninger, så ligger det mer dokumentasjon om CODEOWNERS-filformatet her:

https://help.github.com/articles/about-codeowners/

Spørsmål og svar

Jeg har meninger om disse rådene - kan jeg komme med tilbakemeldinger?

Skriv i vei, på Slack-kanalen #open-source.

Kodebasen vår er ikke open source, derfor er det ikke noe poeng

Selv om koden i dag ikke er åpen for innsyn, så ta høyde for at den kan komme til å bli det i fremtiden. Uansett så vil forbedringene være til hjelp, enten kodebasen er åpen eller ei!

Hvem har ansvaret for å fikse det her?

Det er i utgangspunktet den/de/teamet som eier kodebasen som må fikse.

Det er en feil i rådene

Alle roboter gjør jo feil, denne også. Lag en issue på https://github.com/navikt/repo-linter.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.