hoppscotch/proxyscotch

Proxyscotch

API request builder - Helps you create your requests faster, saving you precious time on your development.

A simple proxy server created by @SamJakob for Hoppscotch and formerly hosted by Apollo Software Limited.

Installation 📦

Proxyscotch requires zenity on Linux. This is available in most distribution package managers.

We're still working on automated installers. For now, copy the binary to a user-writeable location and launch the application.
A dialog will open and explain the certificate installation process - there are more detailed instructions in our wiki.

Demo 🚀

https://hoppscotch.io

Building 🏗️

These are bash scripts. In order to execute them on Windows, you will need to use some form of bash shell on Windows. We recommend Git Bash.

• macOS:

# To build the desktop tray application:
$ ./build.sh darwin

# To build the server application:
$ ./build.sh darwin server

• For Linux desktops:

# To build the desktop tray application:
$ ./build.sh linux

# To build the server application:
$ ./build.sh linux server

• For Windows desktops:

# To build the desktop tray application:
$ ./build.sh windows

# To build the server application:
$ ./build.sh windows server

The build output is placed in the out/ directory.

Installers 🧙

The installers/ directory contains scripts for each platform to generate an installer application.
Each platform's installer directory, contains the relevant information for that installer.

• macOS
• Windows
• Linux

Usage 👨‍💻

Desktops 🖥️

The proxy will add a tray icon to the native system tray for your platform, which will contain all of the options for the proxy.

Servers 🖧

To use the proxy on a server, clone the package, build the server using the instructions above, and use:

$ ./out/<platform>-server/server --host="<hostname>:<port>" --token="<token_or_blank>"

# e.g. on Linux
$ ./out/linux-server/server --host="<hostname>:<port>" --token="<token_or_blank>"

# or on Windows
$ ./out/windows-server/server.exe --host="<hostname>:<port>" --token="<token_or_blank>"

• The host and token parameters are optional. The defaults are as follows:
• host: localhost:9159
• token: blank; allowing anyone to access (see below)

NOTE: When the token is blank it will allow anybody to access your proxy server. This may be what you want, but please be sure to consider the security implications.

Server Command-Line Options

The server binary supports various options to customize your instance. Each of these are in the format shown in the example above, e.g., host would be specified as --host="your host here", or banned outputs would be --banned-outputs="banned output 1,banned output 2".

• host (default: localhost:9159) -- the hostname the server should listen on.
• token (default: <blank>) -- the proxy Access Token used to restrict access to the server (feature disabled if left blank).
• allowed-origins (default: *) -- a comma separated list of allowed origins (for the Access-Control-Allow-... (CORS) headers) (use * to permit any)
• banned-outputs (default: <blank>) -- a comma separated list of values to redact from responses (feature disabled if left blank).
• banned-dests (default: <blank>) -- a comma separated list of destination hosts to prevent access to (feature disabled if left blank).

Each of these may be passed as command-line parameters so to apply these or deploy changes, simply change your invocation of the Proxyscotch server to your preferred command-line options and re-run proxyscotch.

Docker Container

The Proxyscotch server is also available as a Docker container hosted in Docker Hub and as of version 0.1.2 and above you can pass environment variables to it to configure the container. The container exposes the proxy through port 9159.

Environment Variables the container accepts:

• PROXYSCOTCH_TOKEN (default: <blank>) -- the proxy Access Token used to restrict access to the server (feature disabled if left blank).
• PROXYSCOTCH_ALLOWED_ORIGINS (default: *) -- a comma separated list of allowed origins (for the Access-Control-Allow-... (CORS) headers) (use * to permit any)
• PROXYSCOTCH_BANNED_OUTPUTS (default: <blank>) -- a comma separated list of values to redact from responses (feature disabled if left blank).
• PROXYSCOTCH_BANNED_DESTS (default: <blank>) -- a comma separated list of destination hosts to prevent access to (feature disabled if left blank).

You can provide these values to the container as follows:

• Via docker run:

  docker run -d \
  -e PROXYSCOTCH_TOKEN=<token> \
  -e PROXYSCOTCH_ALLOWED_ORIGINS=<allowed_origins> \
  -e PROXYSCOTCH_BANNED_OUTPUTS=<banned_outputs> \
  -e PROXYSCOTCH_BANNED_DESTS=<banned_dests> \
  -p <host_port>:9159 \
  hoppscotch/proxyscotch:v0.1.4
  

• Via docker-commpose:

# docker-compose.yml

services:
  proxyscotch:
    image: hoppscotch/proxyscotch:v0.1.4
    environment:
      - PROXYSCOTCH_ALLOWED_ORIGINS=<allowed_origins>
      - PROXYSCOTCH_BANNED_OUTPUTS=<banned_outputs>
      - PROXYSCOTCH_BANNED_DESTS=<banned_dests>
    ports:
      - "<host_port>:9159"