readme.md

What's JPRQ?

• JPRQ is a free and open tool for exposing local servers to public network (the internet)
• It can expose TCP protocols, such as HTTP, SSH, etc. Any server!

---

How to install

Windows

📹Video tutorial

1. Install the latest release of JPRQ
   

2. Place the file where it is convenient for you
   
   (At this point, you can use the program, but you will need to manually call the .exe file)
   

3. Create jprq.bat file so we can use the "jprq" keyword to call the .exe file
   

   @echo off
   "C:\Exact\Path\To\File\jprq-windows-386.exe" %*

4. Awesome! Finally, we need to add to the environment variable " PATH", the path to the folder where we created .bat file (step 3)
   
   

Congratulations! You can check if everything is working with the jprq command in CMD

---

MacOs and Linux

$ brew install jprq

or

$ curl -fsSL https://jprq.io/install.sh | sudo bash

Arch-based distros

1. JPRQ is available on the AUR.

   git clone https://aur.archlinux.org/jprq.git
   cd jprq
   makepkg -si

2. You can use an AUR helper like yay to install it:

   yay -S jprq

How to use

First obtain auth token from https://jprq.io/auth, then

jprq auth <your-auth-token>

Replace 8000 with the port you want to expose

jprq http 8000

For exposing any TCP servers, such as SSH

jprq tcp 22

For using custom subdomains

jprq http 3000 -s <custom-name>

For using jprq debugger (with v2.1 or higher)

jprq http 3000 --debug

Serve static files using built-in HTTP Server (with v2.2 or higher)

jprq serve .

Serve on a different domain using CNAME (with v2.3 or higher)

jprq http 3000 --cname example.com

Press Ctrl+C to stop it

Update as of Oct 21, 2023

** jprq is now members-only service **

What does that mean?

• it still stays open and free to self-host
• to use the service I maintain, buy me a coffee and leave your github username
• I will send you invite link to keep using jprq