Luminati HTTP/HTTPS Proxy manager
Clone or download
Latest commit 0006b83 Sep 18, 2018
Permalink
Failed to load latest commit information.
bin 1.107.727 Sep 18, 2018
build 1.95.360 May 14, 2018
db 1.107.727 Sep 18, 2018
lib 1.107.727 Sep 18, 2018
src/pub 1.107.727 Sep 18, 2018
util 1.107.727 Sep 18, 2018
www 1.103.790 Jul 30, 2018
.babelrc 1.90.546 Apr 6, 2018
.gitattributes v1.74.604 Dec 12, 2017
.gitignore ignore CVS diff files Jun 2, 2016
.travis.yml 1.97.727 Jun 1, 2018
CHANGELOG.md 1.107.727 Sep 18, 2018
Dockerfile 1.79.778 Jan 18, 2018
README-zh-CN.md 1.107.727 Sep 18, 2018
README.md 1.107.727 Sep 18, 2018
appveyor.yml 1.97.727 Jun 1, 2018
package.json 1.107.727 Sep 18, 2018
test.js 1.107.671 Sep 17, 2018
versions.json 1.107.727 Sep 18, 2018
webpack.config.js 1.105.672 Aug 21, 2018
zon_config.json 1.107.727 Sep 18, 2018

README.md

Luminati Proxy manager

dependencies Status devDependencies Status optionalDependencies Status

A forward HTTP/HTTPS proxy on your side, to accelerate/compress/rotate/distribute/manage/monitor/report/log/debug traffic to your proxies around the world.

With Luminati HTTP/HTTPS Proxy manager you can drive the Luminati residential IPs or Luminati static IPs.

This tool requires a Luminati account.

Read this in 中文.

Features

  • Highly scalable
  • Connection pool for faster response time
  • Easy setup for multiple configurations using a simple web interface
  • Statistics
  • Automatically rotate IP every X requests
  • Load balancing using multiple Super Proxies
  • SSL analyzing (using a self-signed certificate)
  • SOCKSv5 proxy

Installation

Windows

Download the Luminati Proxy Manager installer

Linux/MacOs - Install script

  • Run the setup script to install
wget -qO- https://luminati.io/static/lpm/luminati-proxy-latest-setup.sh | bash

Or

curl -L https://luminati.io/static/lpm/luminati-proxy-latest-setup.sh | bash

Linux/MacOS - Manual install

  • Install Node.js 8 (nodejs.org) Node.js version for the proxy manager should be any v 8.X.X. The Proxy Manager will not work properly with later node versions.
  • Make sure npm version is 4.6.1 or higher
    • if not, run: sudo npm install -g npm@4.6.1
  • Install Luminati Proxy from the terminal prompt:
sudo npm install -g @luminati-io/luminati-proxy

If the command is returning an error try installing using --unsafe-perm flag

sudo npm install -g @luminati-io/luminati-proxy --unsafe-perm

If you are trying to install the Proxy Manager from china on Mac/Linux please run the following command first to make sure npm is installing with allowed registry:

 npm config set registry https://registry.npm.taobao.org

After this command ran successfully install using:

sudo npm install -g @luminati-io/luminati-proxy --unsafe-perm=true --allow-root

Upgrade

  • Use npm to upgrade
sudo npm install -g @luminati-io/luminati-proxy

Or use the cli command:

luminati --upgrade

Specific Version

  • To install a specific proxy manager version, choose a version from releases

  • Run (VERSION_NUMBER is the version you've chosen (example: 1.75.355)):

sudo npm install -g @luminati-io/luminati-proxy@VERSION_NUMBER

Release Notes

You can review the CHANGELOG.md for list of changes in every version

Usage

First run

After running the app for the first time:

luminati

Point your browser to the app admin UI http://127.0.0.1:22999 to set up credentials and configure your proxies.

After logging in, you will see that the default configuration for the Luminati proxy includes a "dropin" proxy running on port 22225. This mode is explained in detail below.

Run as daemon

To run the proxy manager in the background:

luminati --daemon

Dropin replacement for existing super-proxies

Luminati Proxy comes with a "dropin mode" which behaves exactly like the existing super-proxies. When running a proxy in dropin mode, you do not need to log in via the administrative UI in order to make requests through your proxies. Rather, the proxy username and password are provided with each request to the proxy server. This mode is enabled by default, and you can use this mode as an easy replacement when migrating from the regular super-proxy to the Luminati Proxy Manager.

Dropin mode is enabled by default. To disable the dropin proxy, use the flag --no-dropin:

luminati --no-dropin

For full documentation on the API for making requests through the dropin proxy, see the API Example page in your Luminati.io account.

Complete list of command line options

luminati --help
Usage:
  luminati [options] config1 config2 ...

Options:
  --port, -p               Port for the HTTP proxy                      [number]
  --proxy_type             Decide if to save proxy into the configuration file.
                           specifing "persist" in "proxy_type" value will create
                           port and save it in the configuration file.  [string]
  --multiply               Multiply the port definition given number of times
                                                                        [number]
  --ssl                    Enable SSL analyzing       [boolean] [default: false]
  --log                    Log level                 [string] [default: "error"]
  --iface                  Interface or IP to listen on
                                                   [string] [default: "0.0.0.0"]
  --customer               Luminati customer                            [string]
  --zone                   Zone                     [string] [default: "static"]
  --password               Zone password                                [string]
  --proxy                  Hostname or IP of super proxy
                                  [string] [default: "zproxy.lum-superproxy.io"]
  --proxy_port             Super proxy port            [number] [default: 22225]
  --proxy_count            Minimum number of super proxies to use
                                                           [number] [default: 1]
  --secure_proxy           Use SSL when accessing super proxy
                                                      [boolean] [default: false]
  --short_username         Use Shorthand username for super proxy credentials
                                                      [boolean] [default: false]
  --proxy_switch           Automatically switch super proxy on failure
                                                           [number] [default: 5]
  --proxy_retry            Automatically retry on super proxy failure
                                                           [number] [default: 2]
  --use_proxy_cache        Cache resolved ips of superagents
                                                       [boolean] [default: true]
  --insecure               Enable SSL connection/analyzing to insecure hosts
                                                      [boolean] [default: false]
  --country                Country                                      [string]
  --state                  State                                        [string]
  --city                   City                                         [string]
  --asn                    ASN                                          [number]
  --ip                     Datacenter IP                                [string]
  --vip                    VIP                                          [number]
  --ext_proxies            A list of proxies from external vendors. Format:
                           [username:password@]ip[:port]                 [array]
  --ext_proxy_username     default username for external vendor ips     [string]
  --ext_proxy_password     default password for external vendor ips     [string]
  --ext_proxy_port         default port for external vendor ips         [number]
  --dns                    DNS resolving                                [string]
  --reverse_lookup_dns     Process reverse lookup via DNS
                                                      [boolean] [default: false]
  --reverse_lookup_file    Process reverse lookup via file              [string]
  --reverse_lookup_values  Process reverse lookup via value              [array]
  --debug                  Luminati request debug info                  [string]
  --session                Luminati session for all proxy requests      [string]
  --sticky_ip              Use session per requesting host to maintain IP per
                           host                       [boolean] [default: false]
  --pool_size              Session pool size               [number] [default: 3]
  --pool_type              Pool session iteration order
                                                [string] [default: "sequential"]
  --keep_alive             Generate request to keep session alive after given
                           idle time (seconds)                          [number]
  --seed                   Session ID seed used for identifying sessions from
                           this proxy                                   [string]
  --max_requests           Maximum requests per session   [string] [default: 50]
  --session_duration       Maximum duration of session (seconds)        [string]
  --throttle               Throttle requests above given number         [number]
  --whitelist_ips          Whitelist ip list for granting access to proxy
                                                           [array] [default: []]
  --race_reqs              Race several requests at once and choose fastest
                                                                        [number]
  --www                    HTTP port for browser admin UI       [default: 22999]
  --www_whitelist_ips      Whitelist IPs to access browser admin UI. [string]
                           [default:"127.0.0.1"]
			   [example: --www_whitelist_ips "212.17.0.1"]
  --ws                     websocket port used for request logs [default: 22998]
  --config                 Config file containing proxy definitions
                               [string] [default: "~/.luminati.json"]
  --database               Database file containing logs and cached values
                            [string] [default: "~/.luminati.sqlite3"]
  --cookie                 Cookie Jar file
                                [string] [default: "~/.luminati.jar"]
  --mode                   Defines a set of permissible operations within the
                           UI/API                     [string] [default: "root"]
  --dropin                 Create dropin mode proxy port (default: 22225)
                                                       [boolean] [default: true]
  --dropin_port            Port for dropin mode                 [default: 22225]
  --no_usage_stats         Disable collection of usage statistics
                                                      [boolean] [default: false]
  --token                  A Google authorization token for accessing
                           luminati.io                                  [string]
  --proxy_creds_check      Validate proxy credentials  [boolean] [default: true]
  --request_stats          Enable requests statistics  [boolean] [default: true]
  --test_url               A url for testing proxy
                              [string] [default: "http://lumtest.com/myip.json"]
  --no-www                 Disable local web
  --no-config              Working without a config file
  --no-cookie              Working without a cookie file
  --daemon, -d             Start as a daemon
  --stop-daemon            Stop running daemon
  --upgrade                Upgrade proxy manager
  --version, -v            Show version number                         [boolean]
  --help, -h, -?           Show help                                   [boolean]
  --api                                   [default: "https://luminati-china.io"]

Docker

A docker image can be found on https://hub.docker.com/r/luminati/luminati-proxy/

docker pull luminati/luminati-proxy

docker run luminati/luminati-proxy luminati

docker run luminati/luminati-proxy luminati --version

Make sure to forward appropriate ports. Proxy manager uses by default 22999 for the web console and the api, 22555 for dropin and 24000 for first configurable proxy.

  • To run docker with cli option see the below example:
docker run luminati/luminati-proxy luminati --www_whitelist_ips "172.17.0.1" --ssl true

You can add many more options to this run.

Docker with predefined config file

To use lpm's config file, docker volumes can be used: https://docs.docker.com/storage/volumes/

Following this instructions will make your docker runs with specific config file:

  • create volume
docker volume create lpm-vol
  • Inspect the recently created volume
docker inspect lpm-vol

Should output something like this:

  [
    {
        "CreatedAt": "2018-02-01T12:59:58+02:00",
        "Driver": "local",
        "Labels": null,
        "Mountpoint": "/var/lib/docker/volumes/lpm-vol/_data",
        "Name": "lpm-vol",
        "Options": {},
        "Scope": "local"
    }
  ]
  • Take the mountpoint path /var/lib/docker/volumes/lpmvol/_data and run
cd /var/lib/docker/volumes/lpmvol/_data
  • put .luminati.json to this directory (here also will be the logs and other files generated by the container)
  • run docker image and attach this volume:
  docker run --rm --name 'lpm1' --mount source=lpmvol,target=/root
"luminati/luminati-proxy" luminati

SSL Requests

The --ssl parameter is for SSL analyzing, HTTPS requests can be made without it.

Help

The FAQ can be found on the luminati FAQ

If you do not find the answer there, feel free to open an issue on github.

Or contact support@luminati.io.

REST API

Working documentation of the API can be found inside the app.

A non-working version of it can be found here

Node.js API

The proxy manager can be used as a required module for node.js applications - eliminating the need to run it as a standalone process.

The API supports both Promises and Generators. Internally, it uses the request module and supports all of its features.

Promises

'use strict';
const Luminati = require('luminati-proxy').Luminati;

const proxy = new Luminati({
    customer: 'CUSTOMER', // your customer name
    password: 'PASSWORD', // your password
    zone: 'gen', // zone to use
    proxy_count: 5, //minimum number of proxies to use for distributing requests
});
proxy.on('response', res=>console.log('Response:', res));
proxy.listen(0, '127.0.0.1').then(()=>new Promise((resolve, reject)=>{
    proxy.request('http://lumtest.com/myip', (err, res)=>{
        if (err)
            return reject(err);
        resolve(res);
    });
})).then(res=>{
    console.log('Result:', res.statusCode, res.body);
}, err=>{
    console.log('Error:', err);
}).then(()=>proxy.stop());

Generators

'use strict';
const etask = require('./util/etask.js');
const Luminati = require('luminati-proxy').Luminati;

etask(function*(){
    const proxy = new Luminati({
        customer: 'CUSTOMER', // your customer name
        password: 'PASSWORD', // your password
        zone: 'gen', // zone to use
        proxy_count: 5, //minimum number of proxies to use for distributing requests
    });
    yield proxy.listen(0, '127.0.0.1'); // port and ip to listen to
    let res = yield etask.nfn_apply(proxy, '.request',
        ['http://lumtest.com/myip']);
    console.log('Result:', res.statusCode, res.body);
    yield proxy.stop();
});