Skip to content

Commit 7cc7711

Browse files
docs(timeout): Update docs for timeout setting
1 parent 33fec5d commit 7cc7711

File tree

6 files changed

+15
-14
lines changed

6 files changed

+15
-14
lines changed

.github/workflows/end-to-end-auto-prepend-test-suite.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ jobs:
4848

4949
- name: Install DDEV
5050
env:
51-
DDEV_VERSION: v1.21.1
51+
DDEV_VERSION: v1.21.4
5252
run: |
5353
# @see https://ddev.readthedocs.io/en/stable/#installationupgrade-script-linux-and-macos-armarm64-and-amd64-architectures
5454
sudo apt-get -qq update

.github/workflows/end-to-end-test-suite.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ jobs:
4848

4949
- name: Install DDEV
5050
env:
51-
DDEV_VERSION: v1.21.1
51+
DDEV_VERSION: v1.21.4
5252
run: |
5353
# @see https://ddev.readthedocs.io/en/stable/#installationupgrade-script-linux-and-macos-armarm64-and-amd64-architectures
5454
sudo apt-get -qq update

docs/DEVELOPER.md

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -54,16 +54,8 @@ __We will suppose here that you want to install WordPress 5.9. Please change "5.
5454

5555
#### DDEV installation
5656

57-
This project is fully compatible with DDEV 1.21.1, and it is recommended to use this specific version.
58-
For the DDEV installation, please follow the [official instructions](https://ddev.readthedocs.io/en/stable/#installation).
59-
On a Linux distribution, you can run:
60-
```
61-
sudo apt-get -qq update
62-
sudo apt-get -qq -y install libnss3-tools
63-
curl -LO https://raw.githubusercontent.com/drud/ddev/master/scripts/install_ddev.sh
64-
bash install_ddev.sh v1.21.1
65-
rm install_ddev.sh
66-
```
57+
This project is fully compatible with DDEV 1.21.4, and it is recommended to use this specific version.
58+
For the DDEV installation, please follow the [official instructions](https://ddev.readthedocs.io/en/stable/users/install/ddev-installation/).
6759

6860
### Prepare DDEV WordPress environment
6961

docs/USER_GUIDE.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -149,10 +149,19 @@ By default, `file_get_contents` method is used to call Local API. This method re
149149
Here, you can choose to use `cURL` requests instead. Beware that in this case, you need to have php `cURL` extension
150150
installed and enabled on your system.
151151

152+
153+
***
154+
155+
`Connection details → Local API request timeout`
156+
157+
By default, the maximum allowed time to perform a Local API request is 120 seconds. You can change this setting here.
158+
If you set a negative value, request timeout will be unlimited.
159+
152160
![Connection details](images/screenshots/config-bouncing.jpg)
153161

154162
***
155163

164+
156165
`Bouncing → Bouncing level`
157166

158167
Choose if you want to apply CrowdSec directives (`Normal bouncing`) or be more permissive (`Flex bouncing`).
19.2 KB
Loading

inc/admin/settings.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ function adminSettings()
6868
<br>If not checked, calls are done with <i>file_get_contents</i> method (<i>allow_url_fopen</i> is required for this).</p>');
6969

7070
// Field "timeout"
71-
addFieldString('crowdsec_api_timeout', 'Local Api request timeout', 'crowdsec_plugin_settings', 'crowdsec_settings',
71+
addFieldString('crowdsec_api_timeout', 'Local API request timeout', 'crowdsec_plugin_settings', 'crowdsec_settings',
7272
'crowdsec_admin_connection', function ($input) {
7373
if ((int) $input === 0) {
7474
add_settings_error('Local API timeout', 'crowdsec_error', 'Local API timeout: Must be different than 0.');
@@ -77,7 +77,7 @@ function adminSettings()
7777
}
7878

7979
return (int) $input !== 0 ? (int) $input : Constants::API_TIMEOUT ;
80-
}, ' seconds. <p>Authorized timeout for a Local API request.<br> Set a negative value to allow unlimited timeout.<br> Default to' . Constants::API_TIMEOUT .'.',
80+
}, ' seconds. <p>Maximum execution time (in seconds) for a Local API request.<br> Set a negative value (e.g. -1) to allow unlimited request timeout.<br>Default to ' . Constants::API_TIMEOUT .'.',
8181
Constants::API_TIMEOUT, 'width: 115px;', 'number');
8282

8383
/************************************

0 commit comments

Comments
 (0)