Skip to content

Latest commit

 

History

History
198 lines (122 loc) · 7.97 KB

README.md

File metadata and controls

198 lines (122 loc) · 7.97 KB
Raw

WhatsApp Chat Proxy

github CI

If you are unable to connect directly to WhatsApp, a proxy can be used as a gateway between you and our servers. To help yourself or others re-establish connection to WhatsApp, you can set up a proxy server.

If you already have a proxy to use, you can connect it to WhatsApp by following the steps in this article.

Frequently asked questions

PLEASE READ THIS BEFORE OPENING AN ISSUE We have an FAQ, which you can find here: FAQ.md

What you'll need

  1. Docker (enable Docker on startup if your host system allows)
  2. Docker compose (optional)

Setting up your proxy

UPDATE There is now a pre-built image hosted in Meta's DockerHub repository. You no longer need to build the default image (if you don't want to customize it of course).

docker pull facebook/whatsapp_proxy:latest

You can then skip down to Running the proxy and substitute any tag of whatsapp_proxy:1.0 with facebook/whatsapp_proxy:latest.

1. Clone the repository to your local machine

git clone https://github.com/WhatsApp/proxy.git

You should see a folder called proxy created in the current directory.

2. Install Docker for your system

To confirm Docker is successfully installed:

docker --version

should display a line similar to Docker version 20.10.21, build baeda1f.

2. (Optional) Install Docker compose

For Linux users, if your version of Docker doesn't come pre-installed with Docker compose, you can install a one-off version (For Linux).

# Download the pkg
sudo curl -L https://github.com/docker/compose/releases/latest/download/docker-compose-$(uname -s)-$(uname -m) -o /usr/bin/docker-compose
# Enable execution of the script
sudo chmod +x /usr/bin/docker-compose

3. Build the proxy host container

Navigate to the repo directory

cd proxy

Build the proxy host container with

docker build proxy/ -t whatsapp_proxy:1.0

You should see a message similar to [+] Building 6.6s (18/18) FINISHED. The container will be compiled and tagged as whatsapp_proxy:1.0 for easy reference.

Running the proxy

Manually execute the container

You can manually execute the Docker container with the following docker command

docker run -it -p 80:80 -p 443:443 -p 5222:5222 -p 8080:8080 -p 8443:8443 -p 8222:8222 -p 8199:8199 -p 587:587 -p 7777:7777 whatsapp_proxy:1.0

You will see lines ending with Certificate generation completed.. The HAProxy is running in the background and will continue to do so until you close this process.

Check your connection

To confirm HAProxy is running, visit http://<host-ip>:8199 where <host-ip> is your public IP address. You can also use this link to monitor proxy statistics.

NOTE: If your public IP address is not accessible, you will need to enable port forwarding (for the ports above) for the router/gateway you are using. Since this operation is device-specific, we are not going to go into it in details in this doc.

If you prefer OpenMetrics output you can use http://<host-ip>:8199/metrics for monitoring HAProxy metrics.

Miscellanous

An Overview of the WhatsApp Proxy Architecture

Depending on the scenario in which you utilize your proxy, the proxy container exposes multiple ports. The basic ports may include:

  1. 80: Standard web traffic (HTTP)
  2. 443: Standard web traffic, encrypted (HTTPS)
  3. 5222: Jabber protocol traffic (WhatsApp default)
  4. 587 or 7777: *.whatsapp.net traffic including media (HTTPS)

There are also ports configured which accept incoming proxy headers (version 1 or 2) on connections. If you have a network load balancer you can preserve the client IP address if you want.

  1. 8080: Standard web traffic (HTTP) with PROXY protocol expected
  2. 8443: Standard web traffic, encrypted (HTTPS) with PROXY protocol expected
  3. 8222: Jabber protocol traffic (WhatsApp default) with PROXY protocol expected

Certificate generation for SSL encrypted ports

Ports 443 and 8443 are protected by a self-signed encryption certificate generated at container start time. There are some custom options should you wish to tweak the settings of the generated certificates

  • SSL_DNS comma separate list of alternative hostnames, no default
  • SSL_IP comma separate list of alternative IPs, no default

They can be set with commands like

docker build . --build-arg SSL_DNS=test.example.com

Advanced

Automate the container lifecycle with Docker compose

Docker Compose is an automated tool to run multi-container deployments, but it also helps automate the command-line arguments necessary to run a single container. It is a YAML definition file that denotes all the settings to start up and run the container. It also has restart strategies in the event the container crashes or self-restarts. Docker Compose helps manage your container setup and necessary port forwards without user interaction. We recommend utilizing Docker Compose because you usually don’t want to manually run the container outside of testing scenarios.

We provide a sample docker-compose.yml file for you which defines a standard deployment of the proxy container.

Once Docker compose is installed, you can test your specific configuration by running Docker compose interactively with:

docker compose -f /path/to/this/repo/docker-compose.yml up

This will allow you to see the output from the build + container hosting process and check that everything is set up correctly.

When you are ready to run the container as a service, do*:

docker compose -f /path/to/this/repo/docker-compose.yml up -d

*Note the -d flag which means "daemonize" and run as a service.

To stop the container you can similarly do:

docker compose down

Automate host reboots with Docker compose

Once you have Docker compose set up, you can also automate the deployment for host reboots by utilizing a systemd service (if your hosting environment supports it).

We provide a sample docker_boot.service service definition for you which you should customize to your own environment.

To install and setup the systemd service*:

# Copy the service definition to systemd folder
cp -v docker_boot.service /etc/systemd/system/
# Enable starting the service on startup
systemctl enable docker_boot.service
# Start the service (will docker compose up the container)
systemctl start docker_boot.service
# Check container status with
docker ps

*Make sure to update the path to your specific docker-compose.yml file in the service definition docker_boot.service

Kubernetes deployment

If you would like to configure your proxy using Kubernetes, or run the Docker runtime through Kubernetes, please see our Helm chart README

Read more about other type of deployments here.

Contributors

The authors of this code are Sean Lawlor (@slawlor).

To learn more about contributing to this project, see this document.

License

This project is licensed under MIT.