https://github.com/ximing/nrp

A reverse proxy implemented in Node.js, designed to assist in exposing a local server behind a NAT or firewall to the internet.
https://github.com/ximing/nrp

Last synced: 14 days ago
JSON representation

A reverse proxy implemented in Node.js, designed to assist in exposing a local server behind a NAT or firewall to the internet.

• Host: GitHub
• URL: https://github.com/ximing/nrp
• Owner: ximing
• License: mit
• Created: 2024-02-13T11:43:26.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-02-18T15:10:03.000Z (9 months ago)
• Last Synced: 2024-03-17T17:49:09.152Z (8 months ago)
• Language: TypeScript
• Size: 251 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![build workflow](https://github.com/ximing/nrp/actions/workflows/build.yml/badge.svg)

# Quick Start

## Usage

### Server

Provide the following `nrps.yaml` configuration on a server capable of providing external network access:

```yaml

port: 9000

vhost_http_port: 9001

```

```bash

npm i -g @nrpjs/server

nrps -c nrps.yaml

```

### Client

Provide the following `nrpc.yaml` configuration on the client machine that needs to be proxied:

```yaml

bind_port: 9000 # NRP 服务监听的端口

bind_host: 127.0.0.1 # NRP 服务监听的端口

subdomain_host: subdomain.com # 你拥有的域名，用于子域名访问

http:

  test:

    subdomain: demo

    local_port: 3000

```

```bash

npm i -g @nrpjs/client

nrpc -c nrpc.yaml

```