Go to file
yzy613 f95bb6c6d3
Update nps_use.md
2020-02-09 16:00:11 +08:00
.github/ISSUE_TEMPLATE Update issue templates 2019-11-28 21:21:16 +08:00
bridge change server global value to concurrency safety, fix #315 2020-01-18 16:53:52 +08:00
client migrate mux to nps-mux 2020-01-09 22:59:24 +08:00
cmd custom npc systemd service script, increase open files limit 2020-01-22 11:54:40 +08:00
conf fixes #353 2020-01-13 18:31:03 +08:00
docs Update nps_use.md 2020-02-09 16:00:11 +08:00
gui/npc change all version 2020-01-16 16:27:18 +08:00
image add work flow 2020-01-05 21:00:31 +08:00
lib change all version 2020-01-16 16:27:18 +08:00
server change server global value to concurrency safety, fix #315 2020-01-18 16:53:52 +08:00
web fixed #347,api is not enabled by default 2020-01-13 17:29:25 +08:00
.gitattributes Update .gitattributes 2018-12-11 16:54:21 +08:00
.gitignore feat: go mod supported 2019-08-10 11:10:01 +08:00
.travis.yml change build.sh 2019-12-17 00:47:07 +08:00
Dockerfile.npc change package path 2020-01-08 21:57:14 +08:00
Dockerfile.nps change package path 2020-01-08 21:57:14 +08:00
LICENSE License 2019-03-27 11:23:16 +08:00
Makefile feat: go mod supported 2019-08-10 11:10:01 +08:00
README.md Merge branch 'master' into dev 2020-01-08 23:24:46 +08:00
README_zh.md change docs path 2020-01-08 23:17:50 +08:00
build.android.sh change package path 2020-01-08 21:57:14 +08:00
build.sh change all version 2020-01-16 16:27:18 +08:00
go.mod bump mux version 2020-01-18 17:10:48 +08:00
go.sum bump mux version 2020-01-18 17:10:48 +08:00

README.md

NPS

Gitter Build Status GitHub All Releases

README|中文文档

NPS is a lightweight, high-performance, powerful intranet penetration proxy server, with a powerful web management terminal.

image

Feature

  • Comprehensive protocol support, compatible with almost all commonly used protocols, such as tcp, udp, http(s), socks5, p2p, http proxy ...
  • Full platform compatibility (linux, windows, macos, Qunhui, etc.), support installation as a system service simply.
  • Comprehensive control, both client and server control are allowed.
  • Https integration, support to convert backend proxy and web services to https, and support multiple certificates.
  • Just simple configuration on web ui can complete most requirements.
  • Complete information display, such as traffic, system information, real-time bandwidth, client version, etc.
  • Powerful extension functions, everything is available (cache, compression, encryption, traffic limit, bandwidth limit, port reuse, etc.)
  • Domain name resolution has functions such as custom headers, 404 page configuration, host modification, site protection, URL routing, and pan-resolution.
  • Multi-user and user registration support on server.

Didn't find the feature you want? It doesn't matter, click Enter the document to find it!

Quick start

Installation

releases

Download the corresponding system version, the server and client are separate.

Server start

After downloading the server compressed package, unzip it, and then enter the unzipped folder.

  • execute installation command

For linux、darwin sudo ./nps install

For windows, run cmd as administrator and enter the installation directory nps.exe install

  • start up

For linux、darwin sudo nps start

For windows, run cmd as administrator and enter the program directory nps.exe start

After installation, the windows configuration file is located at C:\Program Files\nps, linux or darwin is located at /etc/nps

If you don't find it started successfully, you can check the log (Windows log files are located in the current running directory, linux and darwin are located in /var/log/nps.log).

  • Access server IP:web service port (default is 8080).
  • Login with username and password (default is admin/123, must be modified when officially used).
  • Create a client.

Client connection

  • Click the + sign in front of the client in web management and copy the startup command.
  • Execute the startup command, Linux can be executed directly, Windows will replace ./npc with npc.exe and execute it with cmd.

If you need to register to the system service, you can check Register to the system service

Configuration

  • After the client connects, configure the corresponding penetration service in the web.
  • For more advanced usage, see Complete Documentation

Contribution

  • If you encounter a bug, you can submit it to the dev branch directly.
  • If you encounter a problem, you can feedback through the issue.
  • The project is under development, and there is still a lot of room for improvement. If you can contribute code, please submit PR to the dev branch.
  • If there is feedback on new features, you can feedback via issues or qq group.