Merge pull request #20 from crowdsecurity/update-doc

update doc

Author: mobula9

crowdsec.php

@@ -4,7 +4,7 @@
  * Plugin URI: https://github.com/crowdsecurity/cs-wordpress-bouncer
  * Description: Safer Together. Protect your WordPress application with CrowdSec.
  * Tags: crowdsec-bouncer, wordpress, security, firewall, captcha, ip-scanner, ip-blocker, ip-blocking, ip-address, ip-database, ip-range-check, crowdsec, ban-hosts, ban-management, anti-hacking, hacker-protection, captcha-image, captcha-generator, captcha-generation, captcha-service
- * Version: 0.5.0
+ * Version: 0.5.3
  * Author: CrowdSec
  * Author URI: https://www.crowdsec.net/
  * Github: https://github.com/crowdsecurity/cs-wordpress-blocker

inc/admin/advanced-settings.php

@@ -254,7 +254,7 @@ function convertInlineIpRangesToLongArray(string $inlineIpRanges): array
         return $input;
     }, '<p>The <em><a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For" '.
     'target="_blank">X-forwarded-For</a></em> HTTP Header will be trust only when the client IP is in this list.'.
-    '<br><strong>Comma (,)</strong> separated ips or ips ranges. Example: 1.2.3.4/24, 2.3.4.5, 3.4.5.6/27',
+    '<br><strong>Comma (,)</strong> separated ips or ips ranges. Example: 1.2.3.4/24, 2.3.4.5, 3.4.5.6/27.<br><br>Some common CDN IP list: <a href="https://www.cloudflare.com/fr-fr/ips/" target="_blank">Cloudflare</a>, <a href="https://api.fastly.com/public-ip-list" target="_blank">Fastly</a>',
     'fill the IPs or IPs ranges here...', '');
 
     // Field "crowdsec_hide_mentions"

inc/templates/advanced-settings.php

@@ -55,5 +55,8 @@ function updateDsnDisplay () {
 			<input type="hidden" name="nonce" value="<?php echo wp_create_nonce('crowdsec_prune_cache'); ?>">
 		</form>
 		</div>
+		<p>
+			Feel free to ask any questions about this plugin, make your suggestions or raise issues on the <a href="https://wordpress.org/support/plugin/crowdsec/">plugin support page</a> or directly on <a href="https://github.com/crowdsecurity/cs-wordpress-bouncer/issues/new">Github</a>.
+		</p>
 	</div>
 </div>

inc/templates/settings.php

@@ -12,6 +12,9 @@
                 submit_button();
                 ?>
 			</form>
+			<p>
+			Feel free to ask any questions about this plugin, make your suggestions or raise issues on the <a href="https://wordpress.org/support/plugin/crowdsec/">plugin support page</a> or directly on <a href="https://github.com/crowdsecurity/cs-wordpress-bouncer/issues/new">Github</a>.
+			</p>
 		</div>
 	</div>
 </div>

inc/templates/theme.php

@@ -12,6 +12,9 @@
                 submit_button();
                 ?>
 			</form>
+			<p>
+			Feel free to ask any questions about this plugin, make your suggestions or raise issues on the <a href="https://wordpress.org/support/plugin/crowdsec/">plugin support page</a> or directly on <a href="https://github.com/crowdsecurity/cs-wordpress-bouncer/issues/new">Github</a>.
+			</p>
 		</div>
 	</div>
 </div>

readme.txt

@@ -13,6 +13,8 @@ This plugin blocks detected attackers or displays them a captcha to check they a
 
 == Description ==
 
+Note: You must first have CrowdSec [installed on your server. The installation is very simple](https://doc.crowdsec.net/Crowdsec/v1/getting_started/installation/#installation).
+
 CrowdSec is composed of a behavior detection engine, able to block classical attacks like credential bruteforce, port scans, web scans, etc.
 
 Based on the type and number of blocked attacks, and after curation of those signals to avoid false positives and poisoning, a global IP reputation DB is maintained and shared with all network members.

scripts/publish-release.sh

@@ -21,11 +21,11 @@ git_base_dir=`git rev-parse --show-toplevel`
 # Update version everywhere (add and commit changes), tag and release
 git checkout main
 if [[ $platform == 'linux' ]]; then
-   sed -i -E "s/Version [0-9]+\.[0-9]+\.[0-9]/Version $NEW_GIT_VERSION_WITHOUT_V_PREFIX/" $git_base_dir/crowdsec.php
+   sed -i -E "s/Version: [0-9]+\.[0-9]+\.[0-9]/Version: $NEW_GIT_VERSION_WITHOUT_V_PREFIX/" $git_base_dir/crowdsec.php
    sed -i -E "s/Stable tag: [0-9]+\.[0-9]+\.[0-9]/Stable tag: $NEW_GIT_VERSION_WITHOUT_V_PREFIX/" $git_base_dir/crowdsec.php
    sed -i -E "s/v[0-9]+\.[0-9]+\.[0-9]/v$NEW_GIT_VERSION_WITHOUT_V_PREFIX/" $git_base_dir/inc/constants.php
 else
-   sed -i "" -E "s/Version [0-9]+\.[0-9]+\.[0-9]/Version $NEW_GIT_VERSION_WITHOUT_V_PREFIX/" $git_base_dir/crowdsec.php
+   sed -i "" -E "s/Version: [0-9]+\.[0-9]+\.[0-9]/Version: $NEW_GIT_VERSION_WITHOUT_V_PREFIX/" $git_base_dir/crowdsec.php
    sed -i "" -E "s/Stable tag: [0-9]+\.[0-9]+\.[0-9]/Stable tag: $NEW_GIT_VERSION_WITHOUT_V_PREFIX/" $git_base_dir/crowdsec.php
    sed -i "" -E "s/v[0-9]+\.[0-9]+\.[0-9]/v$NEW_GIT_VERSION_WITHOUT_V_PREFIX/" $git_base_dir/inc/constants.php
 fi
@@ -36,4 +36,14 @@ git commit -m "bump version to v$NEW_GIT_VERSION_WITHOUT_V_PREFIX"
 git tag v$NEW_GIT_VERSION_WITHOUT_V_PREFIX
 git push
 git push origin v$NEW_GIT_VERSION_WITHOUT_V_PREFIX
-gh release create --draft v$NEW_GIT_VERSION_WITHOUT_V_PREFIX --title v$NEW_GIT_VERSION_WITHOUT_V_PREFIX
+gh release create --draft v$NEW_GIT_VERSION_WITHOUT_V_PREFIX --title v$NEW_GIT_VERSION_WITHOUT_V_PREFIX
+
+
+P1 - "Force Captcha wall for these decision types:"
+
+P2 - add the trusted proxy ip from cloudflare by default https://www.cloudflare.com/fr-fr/ips/
+P2 - Afficher les logs
+P2 Stream mode passif : permettre de ne pas raffraichir la liste (Ex avec un REDIS partagé)
+
+P3 - "Force Ban wall for these decision types:"
+P3 - "Bypass any walls for these decision types:"