mirror of
https://github.com/bitinflow/server.git
synced 2026-03-13 13:35:53 +00:00
Fix minor typos
This commit is contained in:
23
README.md
23
README.md
@@ -2,26 +2,26 @@
|
|||||||
|
|
||||||
localtunnel exposes your localhost to the world for easy testing and sharing! No need to mess with DNS or deploy just to have others test out your changes.
|
localtunnel exposes your localhost to the world for easy testing and sharing! No need to mess with DNS or deploy just to have others test out your changes.
|
||||||
|
|
||||||
This repo is the server component. If you are just looking for the CLI localtunnel app, see (https://github.com/defunctzombie/localtunnel)
|
This repo is the server component. If you are just looking for the CLI localtunnel app, see (https://github.com/defunctzombie/localtunnel).
|
||||||
|
|
||||||
## overview ##
|
## overview ##
|
||||||
|
|
||||||
The default localtunnel client connects to the ```localtunnel.me``` server. You can however easily setup and run your own server. In order to run your own localtunnel server you must ensure that your server can meet the following requirements:
|
The default localtunnel client connects to the `localtunnel.me` server. You can, however, easily set up and run your own server. In order to run your own localtunnel server you must ensure that your server can meet the following requirements:
|
||||||
|
|
||||||
* You can setup DNS entries for your domain.tld and for *.domain.tld (or sub.domain.tld and *.sub.domain.tld)
|
* You can set up DNS entries for your `domain.tld` and `*.domain.tld` (or `sub.domain.tld` and `*.sub.domain.tld`).
|
||||||
* The server can accept incoming TCP connections for any non-root TCP port (ports over 1000).
|
* The server can accept incoming TCP connections for any non-root TCP port (i.e. ports over 1000).
|
||||||
|
|
||||||
The above are important as the client will ask the server for a subdomain under a particular domain. The server will listen on any OS assigned TCP port for client connections
|
The above are important as the client will ask the server for a subdomain under a particular domain. The server will listen on any OS-assigned TCP port for client connections.
|
||||||
|
|
||||||
#### setup
|
#### setup
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
// pick a place where the files will live
|
# pick a place where the files will live
|
||||||
git clone git://github.com/defunctzombie/localtunnel-server.git
|
git clone git://github.com/defunctzombie/localtunnel-server.git
|
||||||
cd localtunnel
|
cd localtunnel-server
|
||||||
npm install
|
npm install
|
||||||
|
|
||||||
// server set to run on port 1234
|
# server set to run on port 1234
|
||||||
bin/server --port 1234
|
bin/server --port 1234
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -29,11 +29,12 @@ The localtunnel server is now running and waiting for client requests on port 12
|
|||||||
|
|
||||||
#### use your server
|
#### use your server
|
||||||
|
|
||||||
You can now use your domain with the ```--host``` flag for the ```lt``` client.
|
You can now use your domain with the `--host` flag for the `lt` client.
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
lt --host http://sub.example.tld:1234 --port 9000
|
lt --host http://sub.example.tld:1234 --port 9000
|
||||||
```
|
```
|
||||||
|
|
||||||
You will be assigned a url similar to ```qdci.sub.example.com:1234```
|
You will be assigned a URL similar to `qdci.sub.example.com:1234`.
|
||||||
|
|
||||||
If your server is being a reverse proxy (i.e. nginx) and is able to listen on port 80, then you do not need the ```:1234``` part of the hostname for the ```lt``` client
|
If your server is acting as a reverse proxy (i.e. nginx) and is able to listen on port 80, then you do not need the `:1234` part of the hostname for the `lt` client.
|
||||||
|
|||||||
@@ -35,7 +35,7 @@ server {
|
|||||||
listen 443 default_server ssl spdy;
|
listen 443 default_server ssl spdy;
|
||||||
listen [::]:443 default_server ipv6only=on;
|
listen [::]:443 default_server ipv6only=on;
|
||||||
|
|
||||||
server_name .localtuunel.me;
|
server_name .localtunnel.me;
|
||||||
|
|
||||||
ssl on;
|
ssl on;
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user