project spike

slince/spike

A fast reverse proxy that helps to expose your local services to the internet

, _(*1)

, _(*2)

Spike is a fast reverse proxy built on top of ReactPHP that helps to expose your local services to the internet., _(*3)

简体中文, _(*4)

Installation

Install via composer, _(*5)

composer global require slince/spike

Both the server and local machine need to install this., _(*6)

Schematic diagram

, _(*7)

Configure the server

A public machine that can be accessed on the internet is needed. Assuming already. There are two ways to start the server, _(*8)

Based on defaults

Use the following command to start the server, _(*9)

$ spiked --address=127.0.0.1:8088

The above command can create a basic service. If you want to customize more information, you should start the server based on the configuration file., _(*10)

Based on the configuration file.

• Creates a configuration file

Execute the following command to create it., _(*11)

$ spiked init --dir=/home/conf --format=json

Yaml,Xml,Ini and Json(default) files are supported. Use the following command for help., _(*12)

$ spiked init -h

• Open the configuration file and modify the parameters., _(*13)

• Executes the following command to start the service., _(*14)

 $ spiked --config=/home/conf/spiked.json

Configure the client.

You should first create a configuration file for the client., _(*15)

• Execute the following command to create it

$ spike init --dir=/home/conf --format=json

Use the following command for help about this command, _(*16)

$ spike init -h

• Open the configuration file and modify the parameters., _(*17)

• Start the client service., _(*18)

$ spike --config=/home/conf/spike.json

Tunnel

The definition of the tunnel only in the client, the server does not need to do any configuration, so as to achieve the most simplified configuration., _(*19)

Now supports both http and tcp tunnels, _(*20)

Open the configuration file for the client and modify the parameters for "tunnel"., _(*21)

• Add an HTTP tunnel

{
    "protocol": "http",
    "serverPort": 8086,
    "proxyHosts": {
        "www.foo.com": "127.0.0.1:80",
        "www.bar.com": "192.168.1.101:8080"
    }
}

Restarts the client service. Visit "http://www.foo.com:8086", the service will be forwarded to the local "127.0.0.1:80"; Note that resolve "www.foo.com" to the server IP., _(*22)

• Add a TCP tunnel

The services based on the tcp can use the tunnel, such as: mysql, redis, ssh and so on; The following is an example of proxy mysql service, _(*23)

{
    "protocol": "tcp",
    "serverPort": 8087,
    "host": "127.0.0.1:3306"
}

Execute the following command to visit the local mysql service., _(*24)

$ mysql -h SERVER IP -P 8087

Client authentication

The authentication is not enabled on the server based on defaults.You should start the server based on configuration file, if you want to enable this., _(*25)

• Enable authentication

Open the configuration file for the server and modify parameters for "auth" and restart the service., _(*26)

Currently only supports a simple user name password authentication, more authentication methods will be added later., _(*27)

• Modify the client identity information

Open the configuration file for the client and modify parameters for "auth". Keep the same parameters as the server., _(*28)

Configure log

The default to open the console and file two forms of the log; the first will print the logs to the console; the second will write all the logs to the specified file; Default log level is "info"; You can adjust this in the configuration file., _(*29)

List Commands

$ spike list
   _____   _____   _   _   _    _____
  /  ___/ |  _  \ | | | | / /  | ____|
  | |___  | |_| | | | | |/ /   | |__
  \___  \ |  ___/ | | | |\ \   |  __|
   ___| | | |     | | | | \ \  | |___
  /_____/ |_|     |_| |_|  \_\ |_____|

  Spike Client 0.0.1

  Usage:
    command [options] [arguments]

  Options:
    -h, --help            Display this help message
    -q, --quiet           Do not output any message
    -V, --version         Display this application version
        --ansi            Force ANSI output
        --no-ansi         Disable ANSI output
    -n, --no-interaction  Do not ask any interactive question
    -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

  Available commands:
    help        Displays help for a command
    init        Create a configuration file in the specified directory
    list        Lists commands
    list-proxy  Lists all supported proxy hosts by the client

Changelog

See CHANGELOG.md, _(*30)

License

The MIT license. See MIT, _(*31)