Skip to content

Commit

Permalink
chore: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
mcharytoniuk committed Aug 13, 2024
1 parent 4282c51 commit 3d00084
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,13 @@ Run the following to start a Paddler’s agent (replace the hosts and ports with
--management-port 8085
```

#### Naming the Agents

> [!NOTE]
> Available since v0.6.0
With the `--name` flag, you can assign each agent a custom name. This name will be displayed in the management dashboard and not used for any other purpose.

### Running Load Balancer

Load balancer collects data from agents and exposes reverse proxy to the outside world.
Expand All @@ -93,6 +100,8 @@ To start the load balancer, run:

`management-host` and `management-port` in agents should be the same as in the load balancer.

#### Enabling Dashboard

You can enable dashboard to see the status of the agents with
`--management-dashboard-enable=true` flag. If enabled, it is available at the
management server address under `/dashboard` path.
Expand Down

0 comments on commit 3d00084

Please sign in to comment.