qs-forward

qs-forward

Use qs-forward with QuickSocket to enable easy local development and testing!

Getting Started

Want to jump in quick? Head over to the releases page to download the latest version of qs-forward.

Choose your preferred archive format and extract to a directory of your choice. Don’t forget to add the folder to your $PATH!

What is qs-forward?

Developing with QuickSocket locally can be frustrating when receiving callbacks directly over HTTPS. The reasons for this are twofold:

  • QuickSocket will not allow for plain HTTP callbacks due to security concerns.
  • Accessing your local device publically requires port-forwarding and router configuration.

Both of these make for a less-than-ideal local development experience. For this reason, QuickSocket now supports a new Forward callback mechanism that alleviates both painpoints described above.

How does it work?

Typically, QuickSocket calls back to your back-end software directly over HTTPS. This is still the preferred mechanism for production and test environments.

However, using the new Forward callback mechanism, QuickSocket can instead forward callbacks over WebSocket to qs-forward, which can then callback to your back-end software over HTTP or HTTPS and complete the loop.

This allows for seamless local testing without any changes or disparity between your local and production environments.

qs-forward diagram

NOTE: As shown above, qs-forward uses a WebSocket connection to your environment to receive callbacks – this WebSocket connection will consume Actions like a standard WebSocket connection. For more information on Actions and pricing, consult the QuickSocket documentation.

Configure in QuickSocket Portal

Before using qs-forward, ensure your environment is configured correctly in the Callback tab. The Forward callback mechanism must be selected.

Usage

qs-forward --client-id ... --client-secret ... http://localhost:8080/api

TLS

By default, callbacks from qs-forward to your back-end application will attempt to verify any provided certificates when using HTTPS. If you’d like to disable this, you can provide the --tls-skip-verify flag on the command-line.

Troubleshooting

If you encounter errors when first running qs-forward, check the following:

  • Your device has an active internet connection.
  • The --client-id and --client-secret you provided are correct for the environment you are targeting.
  • You have a positive number of Actions remaining in the environment you are attempting to connect to.
  • The environment is configured to use Foward as the callback mechanism.

GitHub

View Github