From eaccb41d599b5e825ec2df45c6c5a7d1f3d2d1f6 Mon Sep 17 00:00:00 2001 From: vkuehn Date: Mon, 18 Nov 2024 17:37:47 +0100 Subject: [PATCH] Update configuration.rst to show minimalistic config example --- docs/configuration.rst | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/configuration.rst b/docs/configuration.rst index 701594a1f5..f201a1ba7e 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -55,6 +55,22 @@ You can specify an additional file using the ``--config`` flag. $ locust --config custom_config.conf +Here's a minimalistic example of the configuration file supported by Locust: + +No Options are selected which would make Locust run e.g. headless or distributed. +Have a look later in this article for :ref:`All available configuration options` + +locust.conf +-------------- + +.. code-block:: ini + + locustfile = locust_files/my_locust_file.py + host = https://target-system + users = 1 + spawn-rate = + run-time = 1m + Here's a quick example of the configuration files supported by Locust: locust.conf