GitXplorerGitXplorer
z

port-mapper

public
20 stars
5 forks
0 issues

Commits

List of commits on branch master.
Unverified
086356992bf4a48fe08f9b6236a939e3939b88aa

Update readmes

zzhyupe committed 7 years ago
Unverified
29b2b5101dc7109ce62b61e0bb435b5b2a3bb261

Fix readmes

zzhyupe committed 7 years ago
Unverified
51d0f9a31f58eabdef0cd66c6bc44bc3cc365d3c

Update dependency

zzhyupe committed 7 years ago
Unverified
14a2dce8afd2cd8fab34f3776f9e232e4a41e708

Fix bug

zzhyupe committed 10 years ago
Unverified
303b48b065d4ac77378a1274a85f028575b4af8a

Fix no logs folder problem

zzhyupe committed 10 years ago
Unverified
20573cc44322cc17bd73e2b4ba3f0cc62e886056

Update readme

zzhyupe committed 10 years ago

README

The README file for this repository.

port-mapper

A port mapping tool by node.js which helps accessing a back server (in LAN, etc), via a front server having public ip(s) and a client server that could access the back server. Tested on Minecraft 1.7.2 server.

The project is published under GPLv2 License.

Principle introduce (Simplified Chinese)

Other languages

Requirements

  • A front server has public ip(s)
  • A client server that can access the back server (You can just use the back server)
  • node.js runtime on both front and client server

How to

  1. Edit settings in config.json .
  2. Upload files to both servers.
  3. Run npm install in port-mapper's folder on both servers.
  4. Run server.js on the front server.
  5. Run client.js on the client server.

[Notice] You must do the step 4 first, or the client won't work correctly.

Setting Definition

Settings should be defined in config.json

DO NOT delete config.example.json. We need it to make sure the config structure is the latest version and the tool can work properly.

{
    "LOG_LEVEL"    : "INFO", // The minimum level of log to be logged

    "GATEWAY"      : "",     // The ip or domain of the front server

    "SERVER_HOST"  : "",     // The ip or domain of the back server
    "SERVER_PORT"  : 80,     // The port of service on the back server

    "CONNECT_SIGN" : "",     // Auth been the two server and avoid unexpected forward
    "CONNECT_PORT" : 1201,   // The port to connect with the front server
    "TRANS_PORT"   : 1202,   // The port to trans to the front server
    "PUBLIC_PORT"  : 80,     // The port you can access from internet
    "PUBLIC_AUTH"  : false   // Authority client before mapping
         // false - disabled
         // true  - enabled, generate a random code when back server connected
         // "*"   - enabled, use a specified code
}

Contributors

List of contributors can be found at here.