Skip to content

hoppscotch/proxyscotch

Folders and files

NameName
Last commit message
Last commit date

Latest commit

8507eb8 Β· Jun 3, 2022
Jun 3, 2022
Jun 3, 2022
Oct 27, 2020
Feb 17, 2021
May 31, 2022
Jun 2, 2022
Jun 2, 2022
Jan 24, 2022
Jan 22, 2021
Jun 2, 2022
Aug 28, 2020
Oct 14, 2021
Jun 2, 2022
Jun 2, 2022
Jun 2, 2022
Jun 2, 2022
Jun 9, 2020
Jun 2, 2022

Repository files navigation

Hoppscotch

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.

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.