Skip to content
Provides an HTTP service that is useful for developers working with third party services performing some kind of webhooks.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
client
deploy
proxy-tester
server
.gitignore
.travis.yml
Dockerfile
README.md
deploy.sh
package-lock.json
package.json

README.md

Callback proxy service

Provides an HTTP service that is useful for developers working with third party services performing some kind of webhooks. You set up a local proxy, and make it publically available over the internet and you use that public address when communicating with the third party. Those public webhook calls will smoothly land on your local development environment.

Build status Release Docker image pulls Docker image layers Docker image size

Running

Build and install necessary dependencies:

$ npm run build

Start the application in development mode:

$ npm run dev

This starts three processes that is watching for changes:

  • server: Starts a HTTP server, serving the server application on port 8181, re-starting automatically if server-files are changed.
  • client / start: Starts the client application on port 3000, re-loading the page automatically if client-files are changed.
  • client / watch-css: Watches for changes to *.scss files and compiles them to *.css.

In production mode, the server and client would be served on the same port, but in development mode we use different ones in order to get auto-reloads working properly.

Configuration

The service is configured using a YAML file, located at /etc/callback-proxy-service/callback-proxy-service.yaml (but can be overridden with the environment variable CONFIG_FILE_PATH). Here's an example configuration file:

http:
  configPort: 8181
  proxyPort: 8182
  proxyEndpoint: https://callback-proxy.example.com
  session:
    secret: ...
ui:
  suggestionPath: :8080
database:
  fileName: /var/callback-proxy-service/callback-proxy-service.json
  callbackHistorySize: 10
  targetHistorySize: 10
ldap:
  domain: ...
  url: ...
  searchBase: ...
  attributes:
    username: sAMAccountName
    name: cn
    email: mail
log:
  level: warn

Deploying

The service exposes two ports. One port (8182) for the actual proxy calls. This one needs to be exposed publically. The other port (8181) provides a UI for configuring proxy endpoints and should only be exposed on the local network.

Kubernetes

There's an example Kubernetes deployment file here.

You can’t perform that action at this time.