Code Monkey home page Code Monkey logo

holer's Introduction

Holer

Holer exposes local servers behind NATs and firewalls to the public internet over secure tunnels.
Support forwarding message based on TCP protocol.

Holer是一个将局域网中的应用映射到公网访问的端口映射软件,支持转发基于TCP协议的报文。 Demo

How it works

1. Holer使用

Holer支持如下两种使用方式:

(1) 使用公开的holer或者开通holer服务,通过holer客户端软件经holer服务器实现公网访问;
(2) 使用holer服务端软件搭建holer服务,通过holer客户端软件经自己服务器实现公网访问。

如果下载holer软件遇到问题,请从这里下载:软件地址

1.1. 安装 Java

安装Java 1.7或者更高版本; 执行命令 java -version 检查Java是否可用。

1.2. 安装Web服务端

以Tomcat为例,安装并启动Tomcat

在浏览器里输入如下URL来检查Tomcat服务是否可以正常访问:
http://127.0.0.1:8080

1.3. 配置holer

下载并解压软件包holer-client.zip 修改配置文件:
holer-client/conf/holer.conf

设置HOLER_ACCESS_KEY如下:

HOLER_ACCESS_KEY=HOLER_CLIENT-2F8D8B78B3C2A0AE

1.4. 启动holer

进入目录:
cd holer-client/bin

Windows系统:
执行命令 startup.bat 或者双击 startup.bat

Linux系统:
执行命令 bash startup.sh

然后就可以通过如下URL来访问Web应用:
http://holer65530.wdom.net 或者 http://holer.org:65530

1.5. 设置开机启动

进入目录:
cd holer-client/bin

Windows系统:
双击 setup.vbs
注意事项:
请确保当前用户对如下目录具有读取、写入、执行、修改等权限:
C:\ProgramData\Microsoft\Windows\Start Menu\Programs\StartUp

Linux系统:
执行命令 bash setup.sh
注意事项:
CentOS 7, RedHat 7, Ubuntu 18 及更高版本,建议执行命令bash setup-service.sh设置开机启动;

根据提示输入holer access keyholer server host
输入示例:

------------------------------------------
Enter holer access key: HOLER_CLIENT-2F8D8B78B3C2A0AE
------------------------------------------
Enter holer server host: holer.org
------------------------------------------

1.6. 公网和内网的地址映射关系

Holer Access Key Domain Name Internet Address Local Address
HOLER_CLIENT-2F8D8B78B3C2A0AE holer65530.wdom.net holer.org:65530 127.0.0.1:8080
HOLER_CLIENT-3C07CDFD1BF99BF2 holer65531.wdom.net holer.org:65531 127.0.0.1:8088
HOLER_CLIENT-2A623FCB6E2A7D1D holer65532.wdom.net holer.org:65532 127.0.0.1:80
HOLER_CLIENT-AF3E6391525F70E4 N/A holer.org:65533 127.0.0.1:3389
HOLER_CLIENT-822404317F9D8ADD N/A holer.org:65534 127.0.0.1:22
HOLER_CLIENT-27DD1389DF1D4DBC N/A holer.org:65535 127.0.0.1:3306

如果您本地的Tomcat端口是80或者8088,请选择匹配的key进行设置。

请参考博客文章获得更多的使用示例和帮助。

1.7. Go版本的holer客户端

Go版本的holer客户端软件(源代码软件包)是由GO语言实现,支持多种操作系统和硬件架构。

1.7.1. 启动holer

这里以Windows & Linux x86-64bit 为例,启动holer执行如下命令:

Windows系统:
holer-windows-amd64.exe -k HOLER_CLIENT-2F8D8B78B3C2A0AE -s holer.org
也可以执行命令 startup.bat 或者双击 startup.bat

Linux系统:
nohup ./holer-linux-amd64 -k HOLER_CLIENT-2F8D8B78B3C2A0AE -s holer.org &
也可以执行命令 bash startup.sh
首次启动根据提示输入holer access keyholer server host
输入示例:

------------------------------------------
Enter holer access key: HOLER_CLIENT-2F8D8B78B3C2A0AE
------------------------------------------
Enter holer server host: holer.org
------------------------------------------

1.7.2. 设置开机启动

进入目录:
cd holer-client/bin

Windows系统:
双击 setup.vbs
注意事项:
请确保当前用户对如下目录具有读取、写入、执行、修改等权限:
C:\ProgramData\Microsoft\Windows\Start Menu\Programs\StartUp

Linux系统:
执行命令 bash setup.sh
注意事项:
CentOS 7, RedHat 7, Ubuntu 18 及更高版本,建议执行命令bash setup-service.sh设置开机启动;
根据提示输入holer access keyholer server host
输入示例:

------------------------------------------
Enter holer access key: HOLER_CLIENT-2F8D8B78B3C2A0AE
------------------------------------------
Enter holer server host: holer.org
------------------------------------------

2. Holer服务端软件使用

用户也可以下载 holer-server.zip 搭建自己的holer服务端。
Holer Server

2.1. 搭建holer服务端准备工作

(1) 准备一台Linux系统或者Windows系统主机;

(2) 安装Java 1.8及以上版本,执行命令 java -version 检查Java是否可用;

(3) 安装并启动Nginx, 建议安装其稳定版本;

(4) 安装MariaDB并设置root用户密码;

(5) 设置安全规则,允许访问Holer服务端端口6060、600以及端口映射规则所涉及的端口;

(6) 建议申请域名并且完成域名备案,并设置域名泛解析(*.域名)和直接解析主域名(@.域名),如果没有域名可以直接使用IP和端口访问。

2.2. 配置并启动holer服务端

解压软件包,打开配置文件 holer-server/resources/application.yaml

2.2.1. 修改数据库用户名和密码

spring:
  datasource:
    username: root
    password: 123456

2.2.2. 修改域名和Nginx主目录

holer
  domain:
    name: your-domain.com
  nginx:
    #home: /usr/local/nginx
    home: C:/nginx-1.14.2

将示例中的域名your-domain.com修改成自己备案过的域名,如果没有域名,请忽略该配置项。

Linux系统默认安装Nginx路径 /usr/local/nginx
Windows系统中可以先将Nginx复制到某个目录下,然后在配置文件中指定其主目录。

注意事项:
请确保Nginx主目录下存在配置文件:conf/nginx.conf
Nginx目录结构示例:

Nginx主目录
├── conf
│   ├── nginx.conf
.   .
.   .

如果需要用到HTTPS功能,Window系统版本的Nginx默认支持HTTPS功能,Linux系统需要下载Nginx源码,配置和编译以及安装执行如下命令:

./configure --with-http_ssl_module
make;make install

2.2.3. 启动holer服务端

Linux系统执行启动命令如下:

cd holer-server
chmod 755 holer
bash holer start

Windows系统执行启动命令如下:

cd holer-server
startup.bat

或者双击 startup.bat

2.2.4. 设置开机启动

进入目录:
cd holer-server/bin

Windows系统:
双击 setup.vbs
注意事项:
请确保当前用户对如下目录具有读取、写入、执行、修改等权限:
C:\ProgramData\Microsoft\Windows\Start Menu\Programs\StartUp

Linux系统:
执行命令 bash setup.sh
注意事项:
CentOS 7, RedHat 7, Ubuntu 18 及更高版本,建议执行命令bash setup-service.sh设置开机启动。

2.3. 创建端口映射

2.3.1. 登录holer管理系统

如果配置文件application.yaml中设置了域名,并且指定了Nginx主目录,则在浏览器输入URL http://holer.your-domain.com 如果没有设置域名访问,则通过IP和端口登录系统 http://IP地址:600 Holer Login

登录系统需要输入默认的管理员账号,默认用户名: admin 密码: admin123

用户也可以在文件holer-server/resources/conf/holer-data.sql中修改默认的用户名和密码,然后重启holer服务端使其生效。

2.3.2. 创建客户端和端口映射

在用户列表页面中创建一个holer客户端
http://holer.your-domain.com/view/holer-client.html Holer Client

在端口映射页面中为该holer客户端创建端口映射
http://holer.your-domain.com/view/holer-port.html Holer Port

在数据统计页面中查看报表信息
http://holer.your-domain.com/view/holer-report.html Holer Report

2.3.3. 配置holer客户端使其与holer服务端实现端口映射功能

在用户列表页面中选中一条客户端记录,在页面右上角点击详情按钮,弹出的详情框下点击复制按钮; Holer Copy

然后将详情信息粘贴到记事本里,严格按照详情信息里的使用说明进行操作,这样即可完成holer客户端配置,从而实现基于自己holer服务端的端口映射功能。

Support

用户可以使用上述公开的key和端口,也可以申请holer服务;
如果需要holer服务,请联系 QQ 2353941272 或微信 wangyudongdom 开通。
Holer服务详情,请访问Wisdom
Wisdom

holer's People

Contributors

wisdomfamily avatar after-projects avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.