docs(*): Change http to https [skip ci]

Author: julienloizelet

.github/workflows/markdown.yml

@@ -27,8 +27,8 @@ jobs:
         run: |
           gem install awesome_bot
           cd extension
-          awesome_bot --files README.md --allow-dupe --allow 401 --skip-save-results --white-list ddev.site,crowdsec --base-url http://localhost:8080/
-          awesome_bot docs/*.md --skip-save-results --allow-dupe --allow 401 --white-list ddev.site,crowdsec,php.net/supported-versions.php --base-url http://localhost:8080/docs/
+          awesome_bot --files README.md --allow-dupe --allow 401 --skip-save-results --white-list ddev.site --base-url http://localhost:8080/
+          awesome_bot docs/*.md --skip-save-results --allow-dupe --allow 401 --white-list ddev.site,https://crowdsec,php.net/supported-versions.php --base-url http://localhost:8080/docs/
 
       - name: Generate table of contents
         uses: technote-space/toc-generator@v4

docs/DEVELOPER.md

@@ -219,7 +219,7 @@ Finally, run
 
 
 ```bash
-ddev exec BOUNCER_KEY=your-bouncer-key AGENT_TLS_PATH=/var/www/html/cfssl LAPI_URL=http://crowdsec:8080 
+ddev exec BOUNCER_KEY=your-bouncer-key AGENT_TLS_PATH=/var/www/html/cfssl LAPI_URL=https://crowdsec:8080 
 MEMCACHED_DSN=memcached://memcached:11211 REDIS_DSN=redis://redis:6379 /usr/bin/php ./my-own-modules/crowdsec-php-lib/vendor/bin/phpunit --testdox --colors --exclude-group ignore ./my-own-modules/crowdsec-php-lib/tests/Integration/IpVerificationTest.php
 ```
 
@@ -230,14 +230,14 @@ and`GeoLite2-Country.mmdb`. You can download these databases by creating a maxmi
 Then, you can run:
 
 ```bash
-ddev exec BOUNCER_KEY=your-bouncer-key AGENT_TLS_PATH=/var/www/html/cfssl LAPI_URL=http://crowdsec:8080  
+ddev exec BOUNCER_KEY=your-bouncer-key AGENT_TLS_PATH=/var/www/html/cfssl LAPI_URL=https://crowdsec:8080  
 /usr/bin/php ./my-own-modules/crowdsec-php-lib/vendor/bin/phpunit --testdox --colors --exclude-group ignore ./my-own-modules/crowdsec-php-lib/tests/Integration/GeolocationTest.php
 ```
 
 **N.B**: If you want to test with `curl` instead of `file_get_contents` calls to LAPI, you have to add `USE_CURL=1` in 
 the previous commands.
 
-**N.B**: If you want to test with `tls` authentification, you have to add `BOUNCER_TLS_PATH` environment varibale 
+**N.B**: If you want to test with `tls` authentification, you have to add `BOUNCER_TLS_PATH` environment variable 
 and specify the path where you store certificates and keys. For example:
 
 ```bash
@@ -386,7 +386,7 @@ ddev xdebug
 
 To generate a html report, you can run:
 ```bash
-ddev exec XDEBUG_MODE=coverage BOUNCER_KEY=your-bouncer-key LAPI_URL=http://crowdsec:8080
+ddev exec XDEBUG_MODE=coverage BOUNCER_KEY=your-bouncer-key LAPI_URL=https://crowdsec:8080
 MEMCACHED_DSN=memcached://memcached:11211 REDIS_DSN=redis://redis:6379 /usr/bin/php  ./my-own-modules/crowdsec-php-lib/tools/coding-standards/vendor/bin/phpunit  --configuration ./my-own-modules/crowdsec-php-lib/tools/coding-standards/phpunit/phpunit.xml
 
 ```
@@ -397,7 +397,7 @@ You should find the main report file `dashboard.html` in `tools/coding-standards
 If you want to generate a text report in the same folder:
 
 ```bash
-ddev exec XDEBUG_MODE=coverage BOUNCER_KEY=your-bouncer-key LAPI_URL=http://crowdsec:8080
+ddev exec XDEBUG_MODE=coverage BOUNCER_KEY=your-bouncer-key LAPI_URL=https://crowdsec:8080
 MEMCACHED_DSN=memcached://memcached:11211 REDIS_DSN=redis://redis:6379 /usr/bin/php  ./my-own-modules/crowdsec-php-lib/tools/coding-standards/vendor/bin/phpunit  --configuration ./my-own-modules/crowdsec-php-lib/tools/coding-standards/phpunit/phpunit.xml --coverage-text=./my-own-modules/crowdsec-php-lib/tools/coding-standards/phpunit/code-coverage/report.txt 
 ```
 
@@ -519,7 +519,7 @@ Let's add the `max_remediation_level` configuration with `captcha` value:
 ```php
 $configs = [
     'api_key' => $bouncerKey,
-    'api_url' => 'http://crowdsec:8080',
+    'api_url' => 'https://crowdsec:8080',
     'fs_cache_path' => __DIR__ . '/.cache'
     'max_remediation_level' => 'captcha' // <== ADD THIS LINE
     ];
@@ -543,7 +543,7 @@ Replace:
 ```php
 $configs = [
     'api_key' => $bouncerKey,
-    'api_url' => 'http://crowdsec:8080',
+    'api_url' => 'https://crowdsec:8080',
     'fs_cache_path' => __DIR__ . '/.cache',
 ];
 ```
@@ -553,7 +553,7 @@ with:
 ```php
 $configs = [
     'api_key' => $bouncerKey,
-    'api_url' => 'http://crowdsec:8080',
+    'api_url' => 'https://crowdsec:8080',
     'cache_system' => 'redis',
     'redis_dsn' => 'redis://redis:6379'
 ];
@@ -564,7 +564,7 @@ Or, if `Memcached` is more adapted than `Redis` to your needs:
 ```php
 $configs = [
     'api_key' => $bouncerKey,
-    'api_url' => 'http://crowdsec:8080',
+    'api_url' => 'https://crowdsec:8080',
     'cache_system' => 'memcached',
     'memcached_dsn' => 'memcached://memcached:11211'
 ];
@@ -610,7 +610,7 @@ Try with the `full-example-live-mode.php` file:
 
 
 ```bash
-ddev exec php my-own-modules/crowdsec-php-lib/scripts/full-example-live-mode.php <YOUR_BOUNCER_KEY> 1.2.3.4 http://crowdsec:8080
+ddev exec php my-own-modules/crowdsec-php-lib/scripts/full-example-live-mode.php <YOUR_BOUNCER_KEY> 1.2.3.4 https://crowdsec:8080
 ```
 
 #### Simulate LAPI down by using a bad url
@@ -619,7 +619,7 @@ If you run this script twice, LAPI will not be called, the cache system will rel
 You can this behaviour by testing with a bad LAPI url.
 
 ```bash
-ddev exec php my-own-modules/crowdsec-php-lib/scripts/full-example-live-mode.php <YOUR_BOUNCER_KEY> 1.2.3.4 http://crowdsec:BAD
+ddev exec php my-own-modules/crowdsec-php-lib/scripts/full-example-live-mode.php <YOUR_BOUNCER_KEY> 1.2.3.4 https://crowdsec:BAD
 ```
 
 As you can see, you can check the API event if LAPI is down. This is because of the caching system.
@@ -641,7 +641,7 @@ ddev exec php my-own-modules/crowdsec-php-lib/scripts/clear-cache.php <YOUR_BOUN
 One more time, get the remediation for the IP "1.2.3.4":
 
 ```bash
-ddev exec php my-own-modules/crowdsec-php-lib/scripts/full-example-live-mode.php <YOUR_BOUNCER_KEY> 1.2.3.4 http://crowdsec:8080
+ddev exec php my-own-modules/crowdsec-php-lib/scripts/full-example-live-mode.php <YOUR_BOUNCER_KEY> 1.2.3.4 https://crowdsec:8080
 ```
 
 This is a ban (and cache miss) as you can see in your terminal logs.
@@ -652,7 +652,7 @@ This is a ban (and cache miss) as you can see in your terminal logs.
 This library interacts with a CrowdSec agent that you have installed on an accessible server.
 
 The easiest way to interact with the local API (LAPI) is to use the `cscli` tool,but it is also possible to contact it
-through a certain URL (e.g. `http://crowdsec:8080`).
+through a certain URL (e.g. `https://crowdsec:8080`).
 
 ### Use the CrowdSec cli (`cscli`)
 
@@ -739,10 +739,10 @@ Then, you should use some `curl` calls to contact the LAPI.
 For example, you can get the list of decisions with commands like:
 
 ```bash
-curl -H "X-Api-Key: <YOUR_BOUNCER_KEY>" http://crowdsec:8080/v1/decisions | jq
-curl -H "X-Api-Key: <YOUR_BOUNCER_KEY>" http://crowdsec:8080/v1/decisions?ip=1.2.3.4 | jq
-curl -H "X-Api-Key: <YOUR_BOUNCER_KEY>" http://crowdsec:8080/v1/decisions/stream?startup=true | jq
-curl -H "X-Api-Key: <YOUR_BOUNCER_KEY>" http://crowdsec:8080/v1/decisions/stream | jq
+curl -H "X-Api-Key: <YOUR_BOUNCER_KEY>" https://crowdsec:8080/v1/decisions | jq
+curl -H "X-Api-Key: <YOUR_BOUNCER_KEY>" https://crowdsec:8080/v1/decisions?ip=1.2.3.4 | jq
+curl -H "X-Api-Key: <YOUR_BOUNCER_KEY>" https://crowdsec:8080/v1/decisions/stream?startup=true | jq
+curl -H "X-Api-Key: <YOUR_BOUNCER_KEY>" https://crowdsec:8080/v1/decisions/stream | jq
 ```
 
 ## Commit message

scripts/check-ip.php

@@ -16,10 +16,10 @@
 if (!$requestedIp || !$bouncerKey) {
     die('Usage: php check-ip.php <IP> <BOUNCER_KEY>');
 }
-// Instantiate the Stream logger with info level(optional)
+// Instantiate the Stream logger
 $logger = new Logger('example');
 
-// Display logs with INFO verbosity
+// Display logs with DEBUG verbosity
 $streamHandler = new StreamHandler('php://stdout', Logger::DEBUG);
 $streamHandler->setFormatter(new LineFormatter("[%datetime%] %message% %context%\n"));
 $logger->pushHandler($streamHandler);
@@ -31,7 +31,7 @@
 // Init
 $configs = [
     'api_key' => $bouncerKey,
-    'api_url' => 'http://crowdsec:8080',
+    'api_url' => 'https://crowdsec:8080',
     'fs_cache_path' => __DIR__ . '/.cache',
 ];
 $bouncer = new Bouncer($configs, $logger);

scripts/clear-cache.php

@@ -13,7 +13,7 @@
 
 // Parse arguments
 $bouncerApiKey = $argv[1]; // required
-$apiUrl = $argv[3] ?: 'http://crowdsec:8080';
+$apiUrl = $argv[3] ?: 'https://crowdsec:8080';
 
 if (!$bouncerApiKey) {
     echo 'Usage: php clear-cache.php <api_key>';
@@ -24,10 +24,10 @@
 // Configure paths
 $logPath = __DIR__.'/.crowdsec.log';
 
-// Instantiate the Stream logger with info level(optional)
+// Instantiate the Stream logger
 $logger = new Logger('example');
 
-// Display logs with INFO verbosity
+// Display logs with DEBUG verbosity
 $streamHandler = new StreamHandler('php://stdout', Logger::DEBUG);
 $streamHandler->setFormatter(new LineFormatter("[%datetime%] %message% %context%\n"));
 $logger->pushHandler($streamHandler);
@@ -39,7 +39,7 @@
 // Instantiate the bouncer
 $configs = [
     'api_key' => $bouncerApiKey,
-    'api_url' => 'http://crowdsec:8080',
+    'api_url' => 'https://crowdsec:8080',
     'fs_cache_path' => __DIR__ . '/.cache',
 ];
 $bouncer = new Bouncer($configs, $logger);

scripts/full-example-live-mode.php

@@ -11,7 +11,7 @@
 // Parse arguments
 $bouncerApiKey = $argv[1]; // required
 $requestedIp = $argv[2]; // required
-$apiUrl = $argv[3] ?: 'http://crowdsec:8080';
+$apiUrl = $argv[3] ?: 'https://crowdsec:8080';
 
 if (!$bouncerApiKey || !$requestedIp) {
     echo 'Usage: php full-example-live-mode.php <api_key> <requested_ip> [<api_url>]';
@@ -22,10 +22,10 @@
 // Configure paths
 $logPath = __DIR__.'/crowdsec.log';
 
-// Instantiate the Stream logger with info level(optional)
+// Instantiate the Stream logger
 $logger = new Logger('example');
 
-// Display logs with INFO verbosity
+// Display logs with DEBUG verbosity
 $streamHandler = new StreamHandler('php://stdout', Logger::DEBUG);
 $streamHandler->setFormatter(new LineFormatter("[%datetime%] %message% %context%\n"));
 $logger->pushHandler($streamHandler);

scripts/refresh-cache.php

@@ -14,15 +14,15 @@
     die('Usage: php refresh-cache.php <BOUNCER_KEY>');
 }
 
-// Instantiate the Stream logger with info level(optional)
+// Instantiate the Stream logger with warning level
 $logger = new Logger('example');
 $fileHandler = new RotatingFileHandler(__DIR__ . '/crowdsec.log', 0, Logger::WARNING);
 $logger->pushHandler($fileHandler);
 
 // Instantiate the bouncer
 $configs = [
     'api_key' => $bouncerKey,
-    'api_url' => 'http://crowdsec:8080',
+    'api_url' => 'https://crowdsec:8080',
     'fs_cache_path' => __DIR__ . '/.cache'
 ];
 $bouncer = new Bouncer($configs, $logger);