From 17ac3359e357aa949352b579d855567cc8ad5338 Mon Sep 17 00:00:00 2001
From: Alon Livne <2005alonlivne@gmail.com>
Date: Sat, 11 Jan 2025 17:14:02 +0200
Subject: [PATCH] add proxy gateway docs

Add docs for using proxy gateways to run multiple workers on remote
machines
---
 docs/remote.rst | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/docs/remote.rst b/docs/remote.rst
index f42fb81..6fe806f 100644
--- a/docs/remote.rst
+++ b/docs/remote.rst
@@ -66,6 +66,20 @@ new socket host with something like this::
     pytest -d --tx socket=192.168.1.102:8888 --rsyncdir mypkg
 
 
+Using proxies to run multiple workers on remote machines
+---------------------------------------
+
+In case you want to run multiple workers on a remote machine,
+you can create a proxy gateway for the machine, and run multiple
+workers using the `via` attribute.::
+
+    pytest -d --px id=my_proxy//socket=192.168.1.102:8888 --tx 5*popen//via=my_proxy
+
+Here we declare a proxy gateway using the `--px` arg, and
+create 5 workers that run on the remote server using the proxy.
+Note that the proxy gateway does not run a worker, thus only 5
+workers are created.
+
 
 Running tests on many platforms at once
 ---------------------------------------