Setting up a server

To setup a server, first initialize the configuration by running tunnelize init server.

This will create initial default configuration in tunnelize.json for a server, see Configuration for information about specific attributes.

Default configuration is NOT SAFE for general use outside for testing. Make sure you properly go through configuration and setup your tunnelize server.

Server will be run by just running tunnelize or tunnelize server, after which tunnelize server is ready to accept connections.

For information on how to setup a server as a service so that it keeps running even after OS restarts see here.

Configuring the server

Following is a typical default settings for a server:

{
  "server": {
    "endpoints": { /* ...endpoints... */ },
  }
}

As it can be seen, only endpoints parameter is required to define which endpoints you will allow server to tunnel for you.

Below are all available parameters:

Field	Description	Default Value
`server_port`	Port on which the server listens for tunnel connections.	3456
`server_address`	Address to which the server will bind to.	0.0.0.0
`max_tunnel_input_wait`	Maximum amount of time (in seconds) to wait from tunnel connection to first message from tunnel.	30
`tunnel_key`	Key which tunnel must have in order to be allowed to communicate.	No key required
`monitor_key`	Key which tunnelize tunnel must have in order to execute monitor commands on the server.	No key required
`endpoints`	Configuration for server endpoints. See endpoints for more information.	No default
`encryption`	TLS encryption settings. See encryption	No encryption
`max_tunnels`	Maximum number of tunnels allowed on the server.	100
`max_clients`	Maximum number of clients allowed on the server.	100
`max_proxies_per_tunnel`	Maximum number of proxies per tunnel allowed.	10

Configuring Encryption

It can be one of the two types:

No encryption required

{
    "type": "none"
}

In this case any tunnelize client can connect and pass data in unencrypted connection. This means that all data passed between tunnel and server is visible to a third party.

TLS encryption

{
    "type": "tls", 
    "cert_path": "/path/to/certificate/file", 
    "key_path": "/path/to/key/file"
}

Standard TLS encryption will be used. Keep in mind that in this case Tunnel must also use encryption with a certificate authority (if using self-signed) set or with native-tls if you are using a known certificate authority like Let's Encrypt.

See setting up certificates for information on how to use certificate files.

Configuring Endpoints

Endpoints are configured as follows:

{
  "server": {
    // ... other fields
    "endpoints": { 
        "endpoint-name-1": { 
           "type": "http",
           // ...configuration for HTTP endpoint
        },
        "endpoint-name-2": { 
           "type": "tcp",
           // ...configuration for TCP endpoint
        },
        // ... other endpoints
     },
  }
}

Keys endpoint-name-1 and endpoint-name-2 are endpoint names and they are arbitrary so you can set them to anything you wish as long as they are lowercase and alphanumeric. You can create any number of endpoints to where clients can connect to your local servers. Each endpoint name has to be unique since this is the name that you will need to use tunnel configuration for the proxies.

There are multiple types of endpoints:

Tunnelize Docs

Setting up a server

Configuring the server

Configuring Encryption

Configuring Endpoints