Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
cyberw committed Jan 14, 2024
1 parent 352ca4d commit 61b148b
Showing 1 changed file with 5 additions and 11 deletions.
16 changes: 5 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

Swarm is a tool for running [locust](https://github.com/locustio/locust) in a distributed fashion on a set of load generator servers, using SSH.

Swarm supports [locust-plugins](https://github.com/SvenskaSpel/locust-plugins), automatically installing it on load gens if available.
It is intended to be run on your local Linux/MacOS machine and uses SSH tunnels to help work around any network/firewall issues that might otherwise prevent workers from sending data to the master.

## Installation

Expand All @@ -20,18 +20,8 @@ On the loadgens:

```
pip install locust
# if you want to use locust-plugins:
# pip install locust-plugins
# as swarm automatically copies locust-plugins to loadgens every time, you can then uninstall it, leaving only its dependencies:
# pip uninstall locust-plugins
```

Swarm uses SSH to launch remote processes and SSH tunnels for communication, so you should ensure you can access the workers over ssh.

## Other requirements

Servers must be running bash v4.3 or later.

## Detailed help

Run
Expand Down Expand Up @@ -162,6 +152,10 @@ Here's a sequence diagram of how swarm works:

![Sequence diagram](swarm.png)

## With Web UI

Swarm uses `--headless` by default, but if you want to use the locust Web UI you can: just add the (somewhat secret) Locust parameter `--headful`.

## Contributions

Contributions are very welcome! 😁
Expand Down

0 comments on commit 61b148b

Please sign in to comment.