Proxysmart Web



User Tools

Site Tools


v2:readme

Table of Contents

1. Proxysmart manual [v2].

1. Brief details

The software allows running your own 4g proxy farm. It runs on a Linux box (PC) with USB hub and the modems.

Functions:

  • IP resets on modems (+ automatic rotation + checking IP uniqueness)
  • WebApp for checking statuses of the modems, for creating users and ports, IP rotations
  • WEB API for all actions
  • Bandwidth quotas and Speed limits per proxy
  • Exposing proxy ports, so they are available from world wide
  • Reading,sending SMS and USSD codes
  • OS spoofing, to simulate OS TCP fingerprints of: MacOS, iOS, Windows,  Android (+any other OS)
  • Proxy ACLs (what to allow/deny to proxy users) - blacklists
  • Creating mobile VPN together with proxies
  • Socks5 supports UDP and QUIC (HTTP/3.0)
  • No leaks
  • Native DNS from mobile carriers
  • Large set of supported USB modems, LAN routers, LTE modules, Android phones.

Basic configuration.

Variables are set in the WebApp→Global_settings and in /etc/proxysmart/conf.txt.

Each variable has brief description in place.

2. Adding modems

2.1 Adding a new modem (USB)

  • remove PIN from the modem’s SIM card and plug in the modem into USB port or USB hub.
  • Check whether your modem Web App (e.g. Huawei’s E8372 / E5xxx or ZTE MF79 or Alcatel MW4x ) requires authentication, and if it does, set its admin password to admin123. Basically to the value of $DEFAULT_HILINK_ADMIN_PASSWORD variable in WebApp→GlobalSettings . Otherwise many functions will not work, and its IMEI will be detected similarly to 2-1.1.2
  • Plug in the modem
  • wait ~5 minutes or run sudo proxysmart.sh reset_gently
  • the modem will appear in the WebApp, click EDIT on it, assign some unique Nickname, HTTP & SOCKS5 ports, Login and Password, then click APPLY
  • refresh the WebApp
  • done!

2.2. Adding a LAN modem.

Configure the server with 2 LAN cards

Assume you have 2 LAN cards, enp6s0 main LAN, enp2s0 is dedicated for LAN modems:

nmcli con

NAME                UUID                                  TYPE      DEVICE 
Wired connection 1  bbbee134-51c3-3830-801f-9636470e0708  ethernet  enp6s0
Wired connection 2  000ed912-2d99-3f37-882b-d79ad13102e7  ethernet  enp2s0 
  • Rename Wired connection 2HUBS
nmcli con modify Wired\ connection\ 2 con-name HUBS
  • Disable DHCP and IPV6 on HUBS and assign static IPv4 address
nmcli con modify HUBS ipv4.method manual \
    ipv4.addresses 192.168.10.100/24 ipv6.method disabled ipv4.route-metric 300 

So you will add the LAN modems to 192.168.10.0/24 network as 192.168.10.1, 192.168.10.2 etc.

systemctl restart NetworkManager

Delete old route

ip ro del default via 192.168.10.1

Confirm you have only 1 default route via main LAN:

ip ro

Output

default via 192.168.1.1 dev enp6s0 proto static metric 100 

Add the modem

  • Change the modem’s web admin password to something stored in WebApp→GlobalSettings as DEFAULT_HILINK_ADMIN_PASSWORD variable.
  • Change the modem’s IP to something unique e.g. 192.168.10.10
  • Put the modem into Ethernet switch routed to the Proxysmart server.
  • On the Proxysmart server make sure you can ping the new modem by its IP you set in previous step.
  • Make sure LAN_MODEMS_ENABLE=1 is in WebApp→GlobalSettings.
  • Add Lan modem in the Webapp→Edit_modems , scroll to the bottom, and add as lanmodem10 , 192.168.10.10 .

Then either wait 5 minutes or run the command proxysmart reset_gently, it will find new modems. Then , refresh the proxysmart Web App and assign proxy logins and passwords to the new modems.

2.3. Adding a virtual modem (backend proxy).

A virtual modem is a in fact a redirect to a 3rd party proxy (HTTP or SOCKS5) so you can build own proxies based on that and resell them.

They even can be rotated if the backend proxy supports it.

How to add?

Make sure BACKEND_PROXIES_ENABLE=1 is in WebApp→Global_settings .

Add them the Webapp→Edit_modems→Virtual modems

, scroll to the bottom, and add each with the following fields

  1. id has to be in the form 'bproxy' + a number
  2. creds is a line with credentials of the backend proxy e.g. http://Mylogin:Mypassword@Server:3128 or socks5://Mylogin:Mypassword@Server:1080
  3. ip_reset is an optional parameter , the URL for triggering IP rotation of the backend proxy

Click SAVE

Then either wait 5 minutes or run the command proxysmart reset_gently, it will find new modems. Then , refresh the proxysmart Web App and assign proxy logins and passwords to the new modems.

3. Proxy credentials for new modems

When adding new modems, please use

  • unique HTTP ports from 8001 to 8999,
  • unique SOCKS ports from 5001 to 5999.

If you want different ports ranges, update firewall.conf accordingly.

  • please use unique nicknames like dongleXXX or whatever else. Don’t use nicknames like randomXXX, that are assigned automatically.

4. Where is WebApp

One of

  • http://localhost:8080/
  • http://LAN_IP:8080/
  • http://VPS_IP:8080/

By default login/password are proxy / proxy.

5. How to use proxies

  • If proxy ports are forwarded via remote cloud VPS: then the proxies can be used from all over the Internet, by that VPS IP and proxy port numbers.
  • From the same LAN where multimodem server is located: by the server’s LAN IP and proxy port numbers.

6. Get list of all modems & their external IPs

Run: proxysmart.sh show_status for table-alike output.

7. Reconfigure all modems & proxies.

Method1. Click the button “Reset Complete” on the main screen of the WebApp in the bottom.

Method2. In linux console, run: proxysmart.sh reset_complete

Also it is done after reboot automatically by a Cron job.

8. How to change proxy credentials for a modem. How to rename a modem.

WebApp method

  • click EDIT on a modem, set new port or password or nickname for a modem
  • click APPLY

9. Reset (change) IP on a modem.

The options are below.

  • From Web App

Click Reset Ip button.

  • From command line.

Run: proxysmart.sh reset_quick_nick dongle1

Where dongle1 is a Dongle “nickname” that is seen from output of proxysmart.sh show_status

  • From Web API.

check WEB API section of this manual.

How to rotate a modem periodically?

  • WebApp method

Update modem’s settings in the WebApp and click APPLY.

  • Cron method

Install a Cron job. Edit a file /etc/cron.d/proxysmart, add a line ( or uncomment a commented line.. )

*/10 * * * * root run-one /usr/local/bin/proxysmart.sh reset_quick_nick dongle3

so that a modem with the Nickname dongle3 is rotated every 10 min.

Repeat for each modem you want to rotate periodically.

10. How many modems can I run on a single computer?

Hi , technically it depends on how powerful this PC is, and how intensively proxies are used.

  • Raspberry PI - 4 proxies (roughly)
  • a miniPC (Intel NUC or similar) - up to 10
  • a Laptop like Core i5 - up to 30.

Also it depends on what Plan you buy.

Also it depends on USB configuration, for maximum number of modems:

  • disable USB3.0 in BIOS
  • use USB2.0 hubs

11. How to set TTL and why?

In some cases custom TTL must be set in order to have Cell Operator think we are not using the modem in hotsport  tethering mode. I.e. we don’t share its data. By default Linux OS has ttl = 64. To change Cell Operator perception of the situation, we want to set it +1 i.e. 65.

Edit WebApp→GlobalSettings and set CUSTOM_TTL_SET=1 and CUSTOM_TTL_VALUE=65 and regenerate settings.

12. How to set MTU and why?

In some cases different MTU values connect with different types of ISP’s. You may want to change it.

Mtu can be only lowered. E.g. if you have MTU 1390, you can set 1340. Not opposite.

- Edit /etc/proxysmart/conf.txt and set CUSTOM_MTU_SET=1 . - Set MTU in the WebApp for each modem.

13. How to set extra settings for a modem.

Those are optional and are set in the WebApp

  • WHITELIST - allowed customers IP’s who are not required to type in proxy password (IP-based auth).
  • bandwidth (speed) limit. Values are in bits per second. E.g. 2/2 mbps will be 2000000/2000000.
  • DENIED_SITES_ENABLE (1 or 0) and DENIED_SITES_LIST (list of blocked sites patterns).
  • Bandwidth Quota, (in Megabytes)
  • MTU

14. How can I access the web interface admin panel of each modem?

Open WebApp. Locate the modem. Configure a proxy on your desktop browser.

Use proxy login & password as desribed below (14.1 chapter).

Visit modem IP via that proxy.

14.1. How can I prevent access to modems web interface via proxy?

Since 2023-09-10 it is enabled by default.

Edit WebApp→GlobalSettings and set

PROXY_ADMIN_ENABLE=1
PROXY_ADMIN_LOGIN=SuperAdmin
PROXY_ADMIN_PASS=Hqmz81mmZr

And regenerate configs. So only admin user is allowed to use modems web interfaces, and normal proxy users are not.

15. How to set monthly traffic quota per modem?

In the WebApp, set monthly traffic quota. Click EDIT & APPLY.

16. How to make my proxes Open (i.e. not requiring authentication )

Set OPEN_PROXIES=1 in WebApp→GlobalSettings and regenerate all configs.

Note, when proxy ports are forrwarded via a VPS, the proxies are available to any internet user. Use it with caution.

17. Get monthly/daily proxy usage.

Click bandwitdh stats in the WebApp, or run proxysmart.sh bandwidth_report_json portIDXXX, you will see these columns:

  • “bandwidth_bytes_day_in”
  • “bandwidth_bytes_day_out”
  • “bandwidth_bytes_month_in”
  • “bandwidth_bytes_month_out”
  • “bandwidth_bytes_yesterday_in”
  • “bandwidth_bytes_yesterday_out”

18. How to get current number of connections for a modem?

Run a command

ss -o state established | grep -c :8038

But change 8038 with HTTP port of a desired proxy

19. How to read SMS from a modem.

You have these options.

  1. Browse to the modem IP ( it is shown as GW in proxysmart.sh show_status ) through the proxy. Click SMS button.
  2. run proxysmart.sh list_sms_for_a_modem_by_imei_json 999999999999999 i.e. IMEI of required modem.
  3. Click SMS in the WebApp

20. How to change WebApp password

By default it is set to proxy / proxy.

In the WebApp→GlobalSettings scroll to the bottom, set new WebApp password. NOTE: login remains proxy.

Command line method.

 sudo htpasswd -b /etc/nginx/htpasswd proxy NewAweSomePassword999999

If you want to change username as well, just delete the file and then assign new password

sudo rm /etc/nginx/htpasswd
sudo htpasswd -b /etc/nginx/htpasswd MyNewUsername NewAweSomePassword999999

How to change WEB port

edit /etc/nginx/sites-enabled/proxysmart.nginx and set other port and restart Nginx.

21. OS Spoofing

Os Spoofing is used to simulate other OS TCP fingerprints, MacOS  iOS  Windows  Android

How to enable OS Spoofing?

In the WebApp set destination OS per each modem.

How to test OS Spoofing ?

Visit one of these websites (IP checkers) through a proxy. Find something like “OS TCP fingerprints”.

  • http://witch.valdikss.org.ru/
  • https://thesafety.us/
  • https://Whoer.net , extended results
  • https://browserleaks.com/ip

What OS can I spoof?

MacOS  iOS  Windows  Android

Can I dump OS TCP fingerprint from a real device and use it?

Yes, contact me.

I enabled OS TCP spoofing, but it is not working!

The reason may be that the operator passes all traffic through its internal proxy, or in other way modifies TCP signatures. Then local OS TCP modifications are overwritten. Is it bad? No! Because still traffic looks natural as it was coming from this operator network.

Try other operator.

22. Performance tuning

When >10 modems are added, and when modem list is generated slowly, play with MAX_PARALLEL_WORKERS_STATUS variable, e.g. set it to 2 or 4. On faster CPU’s it can be set to 8.

Also try to disable OS TCP reporting, i.e. set ENABLE_VALDIK=0 in /etc/proxysmart/conf.txt. It will also make modem list generation faster.

Also you can disable detailed status, set QUICK_STATUS=1 in /etc/proxysmart/conf.txt & refresh the WebApp.

23. How to lock network mode per modem

Set TARGET_MODE in its settings in the Proxysmart WebApp. Allowed values:

  • auto
  • 3g
  • 4g

24. What if a modem connected via 3G or 2G, and I want 4G?

Rotate its IP.

25. I want to add extra users to a proxy

In the WebApp, click EDIT on a modem, add some extra users, click APPLY.

26. Is IPV6 supported?

Yes but it’s off by default.

On modems , edit APN and set APN type for both IPv4 and IPv6 , e.g. Ip4Ip6 or Ip4+ip6, there is a dropdown list for that.

On Proxysmart box: Update WebApp→GlobalSettings with

  • IPV6_SUPPORT=1

and reset configuration proxysmart.sh reset_complete ; or even better do a reboot.

27. Nagios integration.

There is a plugin embedded, run it as root,

/usr/lib/nagios/plugins/proxysmart-nagios-helper.sh IMEI

or

/usr/lib/nagios/plugins/proxysmart-nagios-helper.sh NICKNAME

so it will return OK/WARN/CRIT/UNKNOWN and corresponding exit code.

These links

  • Can be safely passed to your customers. They don’t reveal real dongle parameters like IMEI or Nickname.
  • They don’t require HTTP basic authentication
  • They have limited lifetime , it is set in WebApp→GlobalSettings as RESET_LINK_VALIDITY variable, (default value : 5years).
  • They depend on proxy password. So, when you change proxy password - old IP rotation links will stop working.

A link can be retrieved this way: Open dongle status (click on its IMEI!) in the WebApp, take RESET_SECURE_LINKURL value.

If you realized you gave a link to a customer, and want to revoke it, just set new password for the proxy.

If you want to invalidate all links of all modems, set a new secret: set RESET_LINK_SECRET in WebApp→GlobalSettings .

29. QUIC (UDP) support on Socks5 proxies, for HTTP/3.0

It is needed for proper work of HTTP/3.0 which uses UDP.

QUIC (UDP over socks5) will work either in your LAN or via a VPS. Steps are below.

Steps on VPS :

Make sure you finished the Cloud VPS setup part, with Ansible

cd /root/proxysmart-vps/
nano vars.txt

- set vps_socks5_udp: 1

Save the file (press Control O) and exit the editor (Control x)

Run Ansible again

ansible-playbook ./proxysmart-vps.yml

Steps on Proxysmart server :

set in WebApp->GlobalSettings :

  • QUIC_SUPPORT=1

and reboot or reconfigure all proxies (run proxysmart.sh reset_complete ).

Note: make sure the VPS has enough RAM, each proxy needs 50MB of RAM. Also add swap if needed.

29. “Dirty” IP reset.

It may be needed when you need even faster IP reset. In this case, post-checks are not made, so it is not sure if the modem really went online after IP reset. It can be activated by DIRTY_IP_ROTATION=1 in WebApp→GlobalSettings

30. Exclude some modems

In /etc/proxysmart/conf.txt

  • by Device name, populate this array IGNORED_DEV=( modem132 modem0000000002) – array of Network Interfaces that are not processed
  • by IMEI, populate this array IGNORED_IMEI=( 9999999999999999 8888888888888888 ) – array of IMEI that are not processed

31. Use custom Speedtest server.

It is useful when for some reason you want to run speed tests towards a custom server, instead of Ookla servers. So set up a Apache web server with a large file (500MB) and get 2 URL’s, one will test download and 2nd will test upload. The latter must accept large POST data.

The commands to setup a server part

apt install apache2
dd if=/dev/urandom  of=/var/www/html/file.bin bs=1M count=500

Update WebApp→Global_settings with IP of the WEB server:

SPEEDTEST_CUSTOM=1  
DL_URL=http://v.v.v.v/file.bin
UL_URL=http://v.v.v.v/i.php

Where v.v.v.v is VPS IP.

DL_URL can be an URL of a large enough file (~100Mb+). And UL_URL is an URL that accepts large enough POST request.

32. Minimum time between IP rotations

If you want to avoid too frequent IP rotations triggered by your users – set MINIMUM_TIME_BETWEEN_ROTATIONS=120 e.g. for 120 seconds minimum delay in WebApp→Global_settings .

33. How to block domains

Individual (per proxy) block lists

  • Check (enable) DENIED_SITES_ENABLE in the WebApp
  • DENIED_SITES_LIST is a list of domains that will be blocked, both HTTP and HTTPS, plus their subdomains. E.g. if you list porn.com, then also www1.porn.com,www.porn.com,porn.com are blocked.

Global block list - for all proxies

in WebApp→Global_settings set DENIED_SITES_ENABLE and paste domains or IP's into DENIED_SITES_LIST , click SAVE and re-apply all modems settings.

Note for Socks5 proxies

When a domain blacklist is imposed, then by default users still can access blocked sites by their IP’s.

In order to prevent it, set DENY_IP_REQUESTS=1 in WebApp→Global_settings and run proxysmart.sh reset_complete for resetting all configuration (or reboot).

33.a. How to allow only whitelisted domains.

  • in /etc/proxysmart/conf.txt :
  • Set WHITELIST_SITES_ENABLE=1
  • WHITELIST_SITES_LIST is a list of domains that are allowed, while other are blocked. Both HTTP and HTTPS, plus their subdomains. E.g. if you list bbc.com, then also www.bbc.com,www1.bbc.com are listed.

34. How to re-rotate IP when IP doesn’t change?

In WebApp→Global_settings set RETRY_IP_ROTATIONS=1 .

So when Old_IP == New_IP, then IP rotation is retried. Up to MAX_RETRY_IP_ROTATIONS attempts which is by default 3.

34.1 Prevent non-unique IP’s after IP rotation.

For example to prevent using IP’s that were in use 1 time (or more) within last 24h: set in WebApp→Global_settings :

RETRY_IP_ROTATIONS=1                 # enables Re-rotation
NON_UNIQUE_IP_OCCURS="1"             # how many times an IP must occur to be considered NonUnique. E.g. 1
NON_UNIQUE_IP_PERIOD="24hour"        # during which period an IP must occur to be considered NonUnique. E.g. 1day or 1hour

35. How to forward proxy ports using HAproxy?

Why? In order to enable client IP whitelisting, i.e. 3proxy on proxysmart server will see original client IP and will be able to use whitelising.

Steps:

1. On Proxysmart server

  • set PROXY_PORTS_FORWARDER_SOFTWARE=ssh+haproxy in WebApp→Global_settings
  • run proxysmart.sh reset_complete for resetting all configuration.

2. On the VPS

cd /root/proxysmart-vps/
nano vars.txt

- set haproxy_enabled: 1

Save the file (press Control O) and exit the editor (Control x)

Run Ansible again

ansible-playbook ./proxysmart-vps.yml

3. Post check

Test a proxy via VPS IP and you will original client IP in 3proxy logs.

36. How to use newer 3proxy version 0.9 ?

It is already set in WebApp→Global_settings

37. Where are proxy logs.

On the Proxysmart server in a folder /var/log/3proxy/ , each filename is named for HTTP proxy port.

Logs are rotated daily and 90 copies are saved, details are in /etc/logrotate.d/3proxy.

Logs of IP rotations are in a folder /var/log/proxysmart/dongle_rotations/.

37.1. No logs policy

If you want to run NoLogs policy, create a cron script that deletes the logs, i.e. the files

/var/log/gost/*
/var/log/3proxy/*
/var/log/sniproxy*
/var/log/haproxy*

38. My proxies are slow.

Assume a chain UsbModemPCVPSProxyUser. Final Proxy speed is limited by:

Download speed of the modem.

It can be measured on the side of the PC e.g. in the Proxysmart WebApp by clicking the Speedtest button.

How to improve it?

  • try other carriers
  • try other modems
  • try better location with better signal (i.e. not your Home)

Upload speed from PC to VPS.

Normally it correlates with quality of home internet (Fiber/xDSL) and can be measured by running speedtest on the PC in browser or in Terminal (speedtest-cli). Upload value has to be high.

With different types of port forwardings:

wan (Home Internet is used for ports forwarding) : remote proxy user's DownloadSpeed = min (ModemDownloadSpeed, HomeInternetUploadSpeed )

cell (each modem forwards its proxies through its internet) : remote proxy user's DownloadSpeed = min (ModemDownloadSpeed, ModemUploadSpeed )

How to improve it?

  • get a better home internet with better upload
  • switch from WiFi to Ethernet

Download speed from VPS to the ProxyUser

It can be measured by downloading a file from VPS to the Proxyuser.

How to improve it?

  • Change location of the VPS to a Cloud Hoster that has better reachability to the clients from all over the world

39. My proxies are slower than the same SIM card in a Phone.

Reason 1: Compare LTE category of the modem and the phone. Phone has higher LTE cat e.g. 12..20, while modem has LTE cat 4..6 (depends).

Reason 2: when the speed is really bad (about 1mbps) then it is Operator's throttling. Perhaps you bought a plan that allows only phones/tablets and doesn't allow modems.

40. How to forward proxy ports via each modem individually?

Why is it needed? When home base internet is unstable or its upload speed <15mbps.

A VPS is needed in order to expose the ports this way ( see VPS integration chapter ).

How it works

Each proxy forwards its port through its modem, not using base internet.

PRO's :

  • Home base internet speed & stability is not important

CON's :

  • each modem is working in bidirectional mode
  • proxy speed is limited to 4G Upload speed which is slow

Steps: on Proxysmart server

  • set PROXY_PORTS_FORWARDER_TYPE=cell in WebApp→Global_settings
  • run proxysmart.sh reset_complete for resetting all configuration.

41. Auto-rebooting modems.

Sometimes only a reboot can fix a modem. In order to enable, set AUTOREBOOT_DONGLES=1 in WebApp→Global_settings. How it works:

  • if a situation occurs , “reboot score” of a modem is increased by the value, according to the situation:
SCORE_IP_ROTATION_FAIL=10                   # score increments when IP rotation failed
SCORE_IP_NOT_DETECTED=2                     # score increments when IP not detected
SCORE_IP_RECONNECT_FAIL=10                  # score increments when IP not auto-reconnected
SCORE_WWAN_DATA_FAIL=10                     # score increments when WWAN device can't establish Data connection
SCORE_WEBAPP_FAIL=20                        # score increments when the modem's WebApp is stuck
  • when the modem’s reboot score reaches MAX_REBOOT_SCORE then the modem is rebooted.
  • special case, do USB reset instead of a reboot, when AUTO_USB_RESET_DONGLES is 1, it is useful when modems’ WEB APP is not available.

42. My proxy is offline and showing Red in the WebApp.

Check if the modem has good signal.

Check if the modem has correct APN (set in its Web Dashboard).

Check if its SIM card is active (not blocked on Operator side) and is topped up.

Check the modem on another PC (e.g. your own desktop).

43. Parallel processing of modems.

Edit /etc/proxysmart/conf.txt , set PARALLEL_STARTUP=1 .

So the modems are processed in parallel, in the number of threads defined in MAX_PARALLEL_WORKERS_STATUS variable (default 8).

44. IP's are rotated on their own

If you don't rotate IP's and they are detected each time as a new IP - it is natural behaviour of mobile provider, when it routes its clients through random different gateways every 1 minute or so. T-Mobile USA is known of doing so.

45. Install logging of all requests in single place

*the Goal*

Get single log of all requests from Proxies (HTTP/Socks5) clients and VPN clients.

Installation On Proxysmart server

In the WebApp→GlobalSettings set SNIFFER_ENABLED=1 and click Apply.

run proxysmart.sh reset_complete

Watch the log /var/log/proxy_log.log on Proxysmart server.

It is rotated and 365 daily copies are stored on disk.

Then it is bound to a button “Download Proxy Logs”.

It can also be installed on a VPS if the VPS is working as proxies frontend.

Installation On VPS

Required files (copy from Proxysmart server to the VPS):

/usr/local/bin/proxy_log.sh
/etc/systemd/system/proxy_log.service
/etc/logrotate.d/proxy_log

run :

apt update && apt install tshark
systemctl enable proxy_log --now 

Watch the log /var/log/proxy_log.log on VPS.

Log format

File: /var/log/proxy_log.log

    _ws.col.Time  frame.interface_name   ip.src  tcp.srcport   ip.dst   tcp.dstport  
    #   1          2                        3       4           5           6
    
    socks.remote_name    socks.dst    socks.port   socks.dstport 
    # 7                         8         9         10
    
     http.request.method    http.host  
    #   11                  12        

     tls.handshake.extensions_server_name  x509ce.dNSName
    #   13                                  14

46. PPP modems

These are very old 3g modems like Huawei E303, E173, E156; ZTE MF110, MF193, MF190. In order to make them work with proxysmart,

edit WebApp→GlobalSettings and set PPP_MODEMS_ENABLE=1 .

Make Quectel LTE modules work in PPP mode

Why? sometimes they fail working in QMI mode. So:

  • edit WebApp→GlobalSettings and set PPP_MODEMS_ENABLE=1
  • place a file /etc/udev/rules.d/21-wwan.rules
# ignore QMI_WWAN endpoints on Quectel, to make it work in PPP mode.
SUBSYSTEM=="net", ACTION=="add",  ATTRS{idVendor}=="2c7c" , ATTRS{idProduct}=="0125",  ENV{.LOCAL_ifNum}=="04", PROGRAM="/usr/local/bin/usb_ignore.sh %p"
  • re-plug Quectel modems or reboot Proxysmart server

47. Alerts to Telegram

In Telegram start a chat with a bot https://t.me/userinfobot and get your Telegram numeric ID.

In Proxysmart WebApp→GlobalSettings , set TG_ALERTS_ENABLE ; and set TG_ALERTS_RECEIVER to your Telegram numeric ID.

In Telegram start a chat with Proxysmart bot https://t.me/nagios737bot and send 'hi'.

After that the bot will send you alerts.


2. Project description

1. architecture

  • onsite: box with Ubuntu, USB hub and modems
  • remote: VPS with proxy ports (optional)

2. Online services are used:

  • http://ip.tanatos.org/ip.php which is simple PHP script that returns visitor’s IP. It is used to detect whether a modem is really online. Can be replaced with one of https://ifconfig.co or similar, but I was not happy with their reliabiality, they are down sometimes. The URL is defined in WebApp→Global_settings
  • http://witch.valdikss.org.ru/ : used for detecting p0f and MTU

3. CLI API

1. show status

Show full status of all modems, table (slower).

# proxysmart.sh  show_status 

Output:

Show brief status of all modems, table, (faster)

Run

# proxysmart.sh  show_status_brief

Output:

Show full status of all modems , json

# proxysmart.sh  show_status_json 

Output:

Show status for a single modem, JSON

Arguements - NICK or IMEI.

# proxysmart.sh  show_single_status_json dongle111 

Output:

2. full reconfiguration

Run

# proxysmart.sh reset_complete  

Output:

3. apply setting for a modem by IMEI

JSON output

# proxysmart.sh   apply_settings_for_a_modem_by_imei  868723029999406 

Output:

Plain text output:

 proxysmart.sh  apply_settings_for_a_modem_by_imei_raw    359999999999999 

output:

4. reset IP on a modem

Args: IMEI or NICKNAME.

JSON output:

# proxysmart.sh   reset_modem_by_imei    899999999999999 
# proxysmart.sh   reset_modem_by_imei    Dongle222

Output:

Plain text output:

# proxysmart.sh  reset_quick_nick  899999999999999
# proxysmart.sh  reset_quick_nick  Dongle222

Output:

5. reboot a modem

Args: Nickname or IMEI.

TEXT Output

JSON Output

6.1. Reset a modem via USB

Can accept DEV name, IMEI or Nickname. So

For Text output:

For Json output.

6. Run speedtest

On a single modem:

Args: NICKNAME or IMEI.

# proxysmart.sh  speedtest 353990074160000
# proxysmart.sh  speedtest sierra

Response:

7. report bandwitdh

On a single port

With arbitrary time interval.

8. reset bandwidth counter on a port

ARGS: portID

JSON output

9. list sms on a modem

JSON output

10. send sms

Plain output:

JSON output:

11. purge SMS

Purges SMS from all folders.

Call by IMEI or nickname,

json output:

12. send ussd

Plain output

JSON output:

13. get bandwidth counters from a modem

..use bandwidth stats..

14. Get IP rotations log for a modem

By Nickname or IMEI

15. Get Top hosts from a modem

By Nickname or IMEI

16. Report IP uniqueness

JSON output.

TEXT output.


4. WEB API

1. Web API description.

WEB API endpoint is the URL that Proxysmart WebApp available at.

It can be

  • LAN_IP:8080 when you call it from the same LAN
  • VPS_IP:8080 when you forwardded ports to the Cloud VPS
  • STATIC_IP:8080 when you forwarded ports via your LAN router and your ISP gave you STATIC_IP

Also attach proper username:password (the -u parameter).

Whenever below you are seeing localhost:8080, replace it with the actual WEB API endpoint.

2. List all modems ( full status, slow)

Request:

curl 'http://localhost:8080/apix/show_status_json' -u proxy:proxy 

Response:

3. List all modems ( brief status, fast )

Request:

curl localhost:8080/apix/show_status_brief_json -u proxy:proxy

Response:

3.1. List all active ports

Request:

curl http://localhost:8080/apix/list_ports_json -u proxy:proxy

Response:

4. Single modem status

Request:

( either by IMEI or Nickname )

curl http://localhost:8080/apix/show_single_status_json?arg=dongle111    -u proxy:proxy
curl http://localhost:8080/apix/show_single_status_json?arg=899999999999999    -u proxy:proxy

Response:

5. Reset (change) IP on a modem.

Request:

( either by IMEI or Nickname )

curl http://localhost:8080/apix/reset_modem_by_imei?IMEI=899999999999999 -u proxy:proxy
curl http://localhost:8080/apix/reset_modem_by_nick?NICK=dongle22 -u proxy:proxy

Response:

6. Reboot a modem

Request:

( either by IMEI or Nickname )

curl http://localhost:8080/apix/reboot_modem_by_imei -d IMEI=860493043888886 -u proxy:proxy
curl http://localhost:8080/apix/reboot_modem_by_nick -d NICK=dongle2 -u proxy:proxy

Response:

ETA: ~ 1.5 minute

7. Send SMS

Request:

curl 'http://localhost:8080/modem/send-sms' -u proxy:proxy \
    --data-urlencode 'imei=899999999999999' \
    --data-urlencode 'phone=+11111111111' \
    --data-urlencode "sms=txt txt fff"

Response:

8. Send USSD and read response

Request:

curl 'http://localhost:8080/modem/send-ussd' -u proxy:proxy \
    --data-urlencode 'imei=899999999999999' --data-urlencode 'ussd=*100#'

Response:

9. Read SMS from a modem

Request:

curl 'http://localhost:8080/modem/sms/862329888888888?json=1' -u proxy:proxy

Response:

10. Read bandwidth stats from a port

Args: porID

Request:

curl localhost:8080/apix/bandwidth_report_json?arg=portJFJHFHJ -u proxy:proxy

Response:

With arbitrary time interval:

ARGS: portID, start time, end time.

Request:

curl -G http://localhost:8080/apix/get_counters_port -X GET -d PORTID=portKFJKJKDD --data-urlencode 'START=2023-01-28 18:10' --data-urlencode 'END=2023-01-28 19:20:01' -u proxy:proxy 

Response:

11. del

del

12. Reset bandwidth stats for a port

Request (by portID ):

curl localhost:8080/apix/bandwidth_reset_counter?arg=portJKJKDHJ83  -u proxy:proxy

Response:

{"result":"success","debug":null}

13. Reset a modem via USB

Request either - by network interface e.g. modem77 - by Nickname - by IMEI

curl localhost:8080/apix/usb_reset_modem_json?arg=modem77      -u proxy:proxy
curl localhost:8080/apix/usb_reset_modem_json?arg=dongle22      -u proxy:proxy
curl localhost:8080/apix/usb_reset_modem_json?arg=868888888888889      -u proxy:proxy

Response:

14. Get IP rotations log for a modem

Request - by Nickname - by IMEI

curl localhost:8080/apix/get_rotation_log?arg=899999999999999  -u proxy:proxy 
curl localhost:8080/apix/get_rotation_log?arg=dongle2          -u proxy:proxy 

Response:

15. Apply settings for a modem

Request:

curl http://localhost:8080/modem/settings -d imei=862329099999999 -u proxy:proxy

Response:

15.1. Apply settings for a port

Args: portID

Request:

curl http://localhost:8080/apix/apply_port?arg=port029348 -u proxy:proxy

Response:

15.2. Purge a port

  • it deletes the port object from the DB
  • it stops its proxies

Args: portID

Request:

curl http://localhost:8080/apix/purge_port?arg=port029348 -u proxy:proxy

Response:

16. Purge SMS from a modem

Request either - by Nickname - by IMEI

curl localhost:8080/apix/purge_sms_json?arg=Nick77      -u proxy:proxy
curl localhost:8080/apix/purge_sms_json?arg=868888888888889      -u proxy:proxy

Response:

{ "result": "success", "msg": "" }

17. Get Top hosts from a modem

Request:

18. Report IP uniquness

Request:

19. Store a modem object in Mongodb

This call just stores the object. Then you have to call “Apply Settings for a modem”.

Get all possible fields in the Mongodb schema description.

Request:

20. Store a port object in Mongodb

This call just stores the object. Then you have to call “Apply Settings for a port”.

Get all possible fields in the Mongodb schema description.

Request:

21. Export backup

Destination format: v2

So it can be later imported in V2 version of Proxysmart.

Request:

5. Mongodb integration

5.1. Schema

Mongodb contains 2 collections: modems and ports.

5.1.1. Modems

It contains real modems.

Array of elements, 1 element = 1 modem.

  • 1st element contains only mandatory keys
  • 2nd element contains all possible keys

Example

Notes:

TARGET_MODE - the mode (3g/4g/auto/default) the mode will work in.

5.1.2. Ports

It contains proxy ports given to the users. Each port is connected to a modem by the IMEI key. So you can attach 1 or more ports to a modem.

Array of elements, 1 element = 1 port.

  • 1st element contains only mandatory keys
  • 2nd element contains all possible keys

Example

Notes:

  • bw_quota : bandwidth quota in MB
  • QUOTA_TYPE can be daily/monthly/lifetime. Latter means you allocate the quota forever till it expires.
  • IP_MODE: can be :
    • 4 : ipv4 only
    • 6 : ipv6 only
    • 46 : prefer ipv4 but also allow ipv6
    • 64 : prefer ipv6 but also allow ipv4
    • null : leave default
  • PROXY_VALID_BEFORE: expiry of a port
  • bandlimin: download speed (megabits per second)
  • bandlimout: upload speed (megabits per second)
  • OS - spoofed destination OS, can be
    • (empty or absent field) No spoofing
    • “android:1” Android, p0f compliant but slow
    • “android:3” real Android, almost like Linux
    • “macosx:3” macosx:3
    • “macosx:4” real MacOSX 12.6 / iPhone 13 Pro Max
    • “ios:1” ios:1, p0f compliant
    • “ios:2” ios:2, real Iphone
    • “windows:1” real Windows 10

5.2 Workflow

quick start:

  • Populate Modems collection with modems
  • Populate Ports collection with ports
  • for each added modem call 'Apply settings for a modem' WEB API call. It will configure each modem and its ports

if you edited a modem

call 'Apply settings for a modem' WEB API call for the modem.

if you edited a port

call 'Apply settings for a port' WEB API call for the port (faster)

or

call 'Apply settings for a modem' WEB API call for the modem. (slower, affects all modem's ports)

if you deleted a port

call 'Purge port' WEB API call for the port (faster)

or

call 'Apply settings for a modem' WEB API call for the modem. (slower, affects all modem's ports))

5.3 Configuration

MongoDB URI is defined in /etc/proxysmart/conf.txt :

  • MONGODB_URI="mongodb://proxysmart2:[email protected]:27017/proxysmart?readPreference=primary&ssl=false"

If you want to use other Mongodb collection names instead of modems and ports , define them in /etc/proxysmart/conf.txt :

  • MONGODB_MODEMS_COLLECTION=modemsNEW
  • MONGODB_PORTS_COLLECTION=portsNEW

after changes:

  • systemctl restart proxysmart
  • proxysmart.sh reset_complete

5.4 Moving Mongodb to other server

Sometimes you want to move Mongodb to a cloud server.

In order to do so

  • keep collection name modems
  • if your new mongodb is Mongodb 5+ and doesn’t have backward compatibility with the older clients, upgrade Mongodb Client to 5th version. Run on the Proxysmart box:
apt purge mongo\* -y
. /etc/os-release 
rm -f /etc/apt/sources.list.d/mongodb*
curl -L https://www.mongodb.org/static/pgp/server-5.0.asc | gpg --dearmor | sudo dd of=/etc/apt/trusted.gpg.d/mongodb-5.0.gpg
echo "deb [ arch=amd64,arm64 ] https://repo.mongodb.org/apt/ubuntu $VERSION_CODENAME/mongodb-org/5.0 multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-5.0.list 
apt-get update
apt install mongodb-mongosh mongodb-database-tools -y
ln -sf /usr/bin/mongosh /usr/local/bin/mongo
  • update MONGODB_URI to new Mongodb URI in /etc/proxysmart/conf.txt
  • if your new mongodb URI has +srv extension , install a PIP module: /var/www/proxysmart/venv/bin/pip install "pymongo[srv]"
  • test new Mongodb URI (I assume you updated MONGODB_URI variable in conf.txt above):
    . /etc/proxysmart/conf.txt;
    mongoexport --quiet --uri="$MONGODB_URI" -c modems --forceTableScan

it should return array of all elements in the modems collection

  • systemctl restart proxysmart
  • proxysmart.sh reset_complete

6. Installation

1. Initial installation

Install a fresh OS.

Supported OS and architectures:

Armhf (arm 32 bit) doesn’t have Mongodb support!

Those steps will take 5..10 minutes.

Unplug any 4g modems.

Add an APT repo.

wget -O-  https://pathos.tanatos.org/proxysmart.apt.repo/GPG.txt | \
    gpg --dearmor | sudo dd of=/etc/apt/trusted.gpg.d/proxysmart.gpg

source /etc/os-release
ARCH=$(dpkg --print-architecture)

echo "deb [arch=$ARCH] http://pathos.tanatos.org/proxysmart.apt.repo.v2 $VERSION_CODENAME main" \
    | sudo tee /etc/apt/sources.list.d/proxysmart.list

sudo apt update
sudo apt install proxysmart

Then follow instructions: It will tell what to do next ( run these ).

sudo /usr/lib/proxysmart/install_pkgs.sh
sudo /usr/lib/proxysmart/install_webapp.sh
sudo /usr/lib/proxysmart/install_openvpn.sh

Reboot or run sudo proxysmart.sh reset_complete.

After that either enjoy the Demo version at http://localhost:8080 or check License section.

Rockpi Notes

If LOGRAM is enabled ( a folder /var/log.hdd exists). Disable logging:

  • mongodb, edit /etc/mongodb.conf, comment logpath directive.

Raspberry PI OS (ex-Raspbian) Notes

its kernel doesn't have xt_cgroup module , so you have to rebuild its kernel and include this module. It is recommended to switch to Ubuntu instead.

Development version installation

Why? To unlock new features that are not yet in the Main version.

wget -O-  https://pathos.tanatos.org/proxysmart.apt.repo/GPG.txt | \
    gpg --dearmor | sudo dd of=/etc/apt/trusted.gpg.d/proxysmart.gpg

source /etc/os-release
ARCH=$(dpkg --print-architecture)

echo "deb [arch=$ARCH] http://pathos.tanatos.org/proxysmart.apt.repo.v2.dev $VERSION_CODENAME main" \
    | sudo tee /etc/apt/sources.list.d/proxysmart.list

sudo apt update 
sudo apt install proxysmart
sudo /usr/lib/proxysmart/install_pkgs.sh
sudo /usr/lib/proxysmart/install_webapp.sh
sudo /usr/lib/proxysmart/install_openvpn.sh

Reboot or run sudo proxysmart.sh reset_complete.

2. Upgrade

2.1. Upgrade from older V2

I.e. minor upgrade.

Run these commands:

NOTE when dpkg will ask whether to replace old config file with new one, answer N (No) or just press Enter.

So old config file is saved.

sudo apt update 
sudo apt install proxysmart
sudo /usr/lib/proxysmart/install_pkgs.sh
sudo /usr/lib/proxysmart/install_webapp.sh
sudo /usr/lib/proxysmart/install_openvpn.sh

Reboot or run sudo proxysmart.sh reset_complete.

2.2 Upgrade from V1

I.e. major upgrade V1>V2.

  • In V1, go to WebApp → “Edit modems” and and download Backup file (Export backup for V2).
  • Then run
source /etc/os-release
ARCH=$(dpkg --print-architecture)

echo "deb [arch=$ARCH] http://pathos.tanatos.org/proxysmart.apt.repo.v2 $VERSION_CODENAME main" \
    | sudo tee /etc/apt/sources.list.d/proxysmart.list

sudo apt update
sudo apt install proxysmart
sudo /usr/lib/proxysmart/install_pkgs.sh
sudo /usr/lib/proxysmart/install_webapp.sh
sudo /usr/lib/proxysmart/install_openvpn.sh
  • Open the webapp, import the file you downloaded
  • Reboot or run sudo proxysmart.sh reset_complete.
  • in the webapp→Global settings, revisit all settings and set them per your needs. It is replacement for older conf.txt.

3. Post Installation

Plug in all 4g modems you have, wait ~20 sec to let them initialize.

Now test if ip li shows you any modem* interfaces, otherwise reboot to apply UDEV rules.

If it does, continue next below. (Otherwise reboot to apply UDEV rules.)

Now you can start all the modems:

You have to run proxysmart.sh reset_complete or reboot the multi-modem server.

Command proxysmart.sh show_status will return a table with proxy port, external IP’s.

Navigate to the WebApp ( http://localhost:8080 proxy/proxy) and assign login/password/nicknames/ports to the modems.

Test reboot, reboot the box, wait 1 minute, make sure the WebApp shows the modems.

WebApp

Visit http://your_box_lan_IP_address:8080/ or http://localhost:8080/

Default user:password pair is proxy:proxy

4. Cloud VPS integration.

Why? The VPS is needed to forward proxy ports from a cloud VPS IP back to the Proxysmart multi modem server, so proxy ports are available for all users around the world.

Do I need a VPS?

A VPS is NOT needed when all the conditions are met:

  • you have static IP at 4g proxy farm location, i.e. ISP provides it, and
  • ISP allows incoming connections to that static IP
  • Upload and Download of “ground” Internet is at least 20 Mbps.

Without a VPS, you can forward proxy ports on your Home/Office router to multi-modem server in the LAN. In that case users from around the world will connect to your static IP, so these connections are forwarded to the 4g farm server situated in the LAN.

The VPS server can be a cheap 1GB DigitalOcean / Linode / Vultr VPS or similar.

It has to be located as close as possible to the 4g farm server ( for lowest ping ).

VPS setup steps.

On Proxysmart multi modem server

Go to the WebApp , copy content of the SSH public key from the bottom of the page. We will refer to it as PUBKEY below.

Also it is stored on disk as /root/.ssh/fwd.pub

On VPS

Check if your VPS has no firewall. Disable it if it has – Both inside Linux OS and in hoster panel.

Install & run Ansible.

apt update && apt install git ansible -y
cd ~/
git clone https://github.com/ezbik/proxysmart-vps.git
cd proxysmart-vps

edit the file vars.txt

nano vars.txt

Insert the PUBKEY inside square brackets for the ssh_pub_keys list. Save the file (press Control O) and exit the editor (Control x)

Run Ansible:

ansible-playbook proxysmart-vps.yml

done.

On Proxysmart multi modem server

in WebApp→Global_Settings:

  • set VPS variable to VPS IP
  • set PROXY_PORTS_FORWARDER_ENABLE=1
  • Pick a port for SSH_REMOTE_PORT, in most cases 6902 is fine. The port (TCP) has to be free on the VPS
  • Pick a port for WEB_REMOTE_PORT, in most cases 8080 is fine. The port (TCP) has to be free on the VPS

Run proxysmart.sh reset_complete

On VPS

issue the command ss -tnlp and you will see proxy ports are bound with sshd daemon. That means the ports are forwarded.

On your private desktop or any other PC
  • visit http://vps_ip:8080 for the WebApp , default login:password is proxy:proxy
  • you can ssh to VPS IP and port 6902, and that goes to the multi-modem-server:22.

Cloud VPS IP change

If CLoud VPS IP is changed, update it on multi-modem-server side by defining new VPS variable in WebApp→Global_settings and rerun proxysmart.sh reset_complete there (or reboot).

5. Forwarding ports through your own LAN router.

Why? It is needed to forward proxy ports from a your ISP IP address back to the Proxysmart multi modem server, so proxy ports are available for all users around the world.

It is suitable when all the conditions are met:

  • you have static IP at 4g proxy farm location, i.e. ISP provides it, and
  • ISP allows incoming connections to that static IP
  • Upload and Download of “ground” Internet is at least 20 Mbps.

Without a VPS, you can forward proxy ports on your Home/Office router to multi-modem server in the LAN. In that case users from around the world will connect to your static IP, so these connections are forwarded to the 4g farm server situated in the LAN.

Steps

Consult with documentation of your LAN router. Forward these ports from ISP IP address to the LAN IP of proxysmart server:

  • TCP 8001-8999 for HTTP proxies
  • TCP 5001-5999 for SOCKS5 pproxies
  • TCP 8080 for the WebApp
  • TCP 1194 for Openvpn (if it is working in TCP mode)
  • UDP 1194 for Openvpn (if it is working in UDP mode)

Notes

Also edit settings WebApp→GlobalSettings, replace myrouter.com with your actual Hostname or IP addresss.

So proxy credentials & links will be shown with your actual Hostname or IP addresss.

PROXY_PORTS_FORWARDER_ENABLE=0
REWRITE_WEBAPP_URL=1
REWRITE_WEBAPP_TO="http://myrouter.com:8080"
REWRITE_HOST_IN_PROXY_CREDS=1
REWRITE_HOST_IN_PROXY_CREDS_TO="myrouter.com"

click SAVE.

.. so forwarding system ports to a VPS is disabled.

Then finally reconfigure the system by running proxysmart.sh reset_complete .

7. License

1. Demo license

Installation is shipped with default demo license.

It allows you to run proxy on 1 modem.

In order to run more modems, buy a License.

2. Requesting a License

2.1. Get the machine data

Method1. From the WebApp:

  • Open the proxysmart WebApp at http://localhost:8080 or http://LAN_IP:8080
  • Scroll down to the Machine Data text.
  • Copy MachineData value to the Clipboard.

Method2. From the CLI:

  • Open terminal
  • Run sudo proxysmart.sh license_status
  • Copy machine_data value

2.2. Contact Sales Team

Send the copied value to proxysmart.org

2. License installation

You will be given the license and license signature. Both are sequences of numbers and characters. Then submit both either via WebApp or CLI:

submitting via WebApp

Open the WebApp , http://localhost:8080 , expand License section and type in the keys & submit both.

submitting via CLI

run commands

proxysmart.sh submit_license LICENSE
proxysmart.sh submit_license_signature LICENSE_SIGNATURE

3. Restoring Demo license.

If your paid license expired or broken, restore DEMO license, run:

sudo cp -v /usr/share/doc/proxysmart/examples/license.txt* /etc/proxysmart/

8. Mobile (4G/5G) VPN

Together with building proxies, it is possible to build Residential VPN.

Assumption is, your proxies are already available via Cloud VPS.

8.1 Installation

8.1.1 Installation with TCP protocol (through VPS)

If ports forwarded through a VPS

Steps on VPS

Assume the VPS is already “integrated” - see VPS integration topic.

Pick a free TCP port on the VPS, run ss -tnlp on the VPS and it will show USED ports, so pick up a free one e.g. 1501. We will call it OPENVPN_REMOTE_PORT.

Steps on Proxysmart server

  • WebApp→GlobalSettings
  • set OPENVPN_SERVER_PORT=1501 , to the free TCP port on Cloud VPS.
  • set OPENVPN_INTEGRATION=1 so that Proxysmart will understand Openvpn is in use.
  • set OPENVPN_LOCAL_PORT=1194
  • Click SAVE

So VPN client certificates will be generated with these values and VPN clients will connect there ( 3.3.3.3:1501 )

Go to the WebApp main screen and download OpenVPN profiles for each port.

8.1.2. Installation with TCP protocol (through LAN router)

If ports forwarded through the LAN router

Steps on LAN router

Your external IP of the LAN router is $EXT_IP .

You forwarded TCP port 1194 to the LAN IP of the Proxysmart server. We will call it OPENVPN_SERVER_PORT.

Steps on Proxysmart server

  • WebApp→GlobalSettings
  • set OPENVPN_SERVER_PORT=1194 , to the OPENVPN_SERVER_PORT from the step above.
  • set OPENVPN_SERVER_HOST to $EXT_IP

So VPN client certificates will be generated with this value, so VPN clients will connect there ( $EXT_IP:$OPENVPN_SERVER_PORT/TCP )

You can download them later as from the WebApp at http://localhost:8080/vpn_profiles/ or grab from /home/vpn/ folder.

8.1.3. Installation with UDP protocol (through VPS)

Steps on VPS

Make sure you finished the Cloud VPS setup part, with Ansible, so VPS part is done.

Steps on Proxysmart server

Pick a free UDP port on the VPS, run ss -unlp on the VPS and it will show USED ports, so pick up a free one e.g. 1501.

  • WebApp→Global_Settings
  • set OPENVPN_SERVER_PORT=1501 , to the free UDP port on Cloud VPS.
  • set OPENVPN_INTEGRATION=1 so that Proxysmart will understand Openvpn is in use.
  • set VPS_SOCKS5_SERVER to scheme with authentication on VPS e.g. socks5://px:[email protected]:2323
  • Click SAVE

So VPN client certificates will be generated with these values and VPN clients will connect there ( 3.3.3.3:1501 )

Go to the WebApp main screen and download OpenVPN profiles for each port.

8.1.4. Installation with UDP protocol (through LAN router)

If ports forwarded through the LAN router

Steps on LAN router

Your external IP of the LAN router is $EXT_IP .

You forwarded UDP port 1194 to the LAN IP of the Proxysmart server. We will call it OPENVPN_SERVER_PORT.

Steps on Proxysmart server

  • WebApp→GlobalSettings
  • set OPENVPN_SERVER_PORT=1194 , to the OPENVPN_SERVER_PORT from the step above.
  • set OPENVPN_SERVER_HOST to $EXT_IP

So VPN client certificates will be generated with this value, so VPN clients will connect there ( $EXT_IP:$OPENVPN_SERVER_PORT/UDP )

You can download them later as from the WebApp at http://localhost:8080/vpn_profiles/ or grab from /home/vpn/ folder.

8.2. Many users with the same profile

By default only 1 device (PC, mobile, tablet) can use 1 OpenVPN profile. If you want multiple devices use 1 profile, edit /etc/openvpn/server.conf , comment out ;duplicate-cn line by removing the ; character, and run proxysmart.sh reset_complete.

8.3. Mobile VPN, how to connect

So download the VPN profiles and connect using any VPN client software.

  • Download and install software:

Windows: https://openvpn.net/community-downloads/ or https://openvpn.net/client-connect-vpn-for-windows/

MacOS: https://tunnelblick.net/

Android: https://play.google.com/store/apps/details?id=de.blinkt.openvpn or https://f-droid.org/en/packages/de.blinkt.openvpn/

IOS: https://apps.apple.com/us/app/openvpn-connect/id590379981

  • Import downloaded OpenVPN profile, tap Connect.
  • use Login and Password from the corresponding proxy.

8.4. Mobile VPN, FAQ

8.4.1. Switch Openvpn protocol

In WebApp→GlobalSettings set OPENVPN_PROTOCOL to tcp or udp and run proxysmart.sh reset_complete

On Clients, either download profiles again, or change protocol in client settings.

8.5. Mobile VPN logs

Logs of openvpn sessions - /var/log/openvpn/sessions.log. Format:

'$time','$type','$local_port','$proto','$duration','$bytes_in','$bytes_out','$Real_IP','$Real_PORT','$Ovpn_CERT','$Ovpn_IP','$IMEI','$proxy_login','$auth_reject_why'
  • type - session_start / session_stop / auth_reject
  • local_port - local port of Openvpn server
  • proto - tcp-server or udp
  • duration - when type is session_stop, how many the session lasted
  • Real_IP, Real_PORT - of a client
  • auth_reject_why - when type is session_stop, the reason why auth was rejected

9. Bugs and Limitations

LTE modules

  • IPV6 is not supported

LAN routers

  • IPV6 is not supported

Android phones

  • No P0f-spoofing with Proxysmart APK app.

VPN users

  • IPV6 is not supported
v2/readme.txt · Last modified: 2024/05/24 14:04 by 127.0.0.1

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki