Skip to content

Commit 8f127a9

Browse files
author
Alexander Walther
committed
Update README.md
1 parent 06c7d8e commit 8f127a9

File tree

1 file changed

+16
-9
lines changed

1 file changed

+16
-9
lines changed

README.md

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# Spamschutz für REDAXO 5 YForm
1+
# Spamschutz für REDAXO 5 und YForm
22

33
Das Addon `yform_spam_protection` kombiniert verschiedene Maßnahmen, um zuverlässig **Spam und Bots abzuwehren**. Die Einrichtung ist in **weniger als 5 Minuten** erledigt.
44

55
## Features
66

77
* **Einfache Integration** - nur eine Zeile Code in das YForm-Formular einfügen.
8-
* **Bestmögliche Usability** – keine zusätzlichen Eingaben vom Benutzer notwendig.
9-
* **Barrierefrei** – ohne Rechenaufgabe oder Bild-Captcha.
8+
* **Bestmögliche Usability** – keine zusätzlichen Eingaben vom Benutzer notwendig.
9+
* **Barrierefrei** – ohne Rechenaufgabe oder Bild-Captcha.
1010
* **DSGVO-konform** – sofern keine Konfiguration mit externen Anbietern gewählt wird.
1111
* **Mehrsprachig** - Die Fehlermeldung kann je Sprache durch Addons wie Sprog oder XOutputFilter angepasst werden.
1212
* **reCaptcha Plugin** - ermöglicht die Einbindung von google recaptcha
@@ -20,11 +20,13 @@ Weitere geplante Features unter [https://github.com/FriendsOfREDAXO/yform_spam_p
2020
* Den gewünschten YForm-Formularen das Feld `spam_protection` hinzufügen:
2121

2222
**PHP-Schreibweise**
23+
2324
```php
2425
$yform->setValueField('spam_protection', array("honeypot","Bitte nicht ausfüllen.","Ihre Anfrage wurde als Spam erkannt und gelöscht. Bitte versuchen Sie es in einigen Minuten erneut oder wenden Sie sich persönlich an uns.", 0));
2526
```
2627

2728
**Pipe-Schreibweise**
29+
2830
```
2931
spam_protection|honeypot|Bitte nicht ausfüllen|Ihre Anfrage wurde als Spam erkannt und gelöscht. Bitte versuchen Sie es in einigen Minuten erneut oder wenden Sie sich persönlich an uns.|0
3032
```
@@ -34,20 +36,23 @@ spam_protection|honeypot|Bitte nicht ausfüllen|Ihre Anfrage wurde als Spam erka
3436
## Funktionsweise
3537

3638
### Timer
37-
Spambots füllen das Formular in der Regel schneller als ein Mensch aus. Beim 1. Aufruf des Formulars sowie bei jeder weiteren Validierung wird ein Zeitstempel gespeichert.
39+
40+
Spambots füllen das Formular in der Regel schneller als ein Mensch aus. Beim 1. Aufruf des Formulars sowie bei jeder weiteren Validierung wird ein Zeitstempel gespeichert.
3841

3942
Wenn der vorgegebene Zeitwert unterschritten wird (z. B. `5 Sekunden`), dann deutet dies auf einen Spambot hin. Die Validierung schlägt dann fehl.
4043

4144
> Tipp: Zum Testen/Debuggen können die Timer auf einen wesentlich höheren Wert gestellt werden, bspw. 30 Sekunden.
4245
4346
### IP-Sperre
47+
4448
Wird das Formular innerhalb weniger Minuten mehrfach von derselben IP abgesendet, deutet dies auf einen Spambot hin, der möglichst viele Abfragen absenden möchte. Übliches Verhalten ist, im Minutentakt Anfragen abzusenden.
4549

4650
Wenn vorgegebene Limits überschritten werden (z. B. `5` Anfragen in `300 Sekunden`), deutet dies auf einen Spambot hin. Die Validierung schlägt dann fehl.
4751

4852
Die IPs werden temporär gespeichert und nach Ablauf des vorgegebenen Limits (z. B. `300 Sekunden`) gelöscht.
4953

50-
### Honeypot
54+
### Honeypot
55+
5156
Dem Formular wird ein per CSS für Menschen - jedoch nicht für Bots - ausgeblendetes Eingabefeld angeboten. Spambots sind dazu geneigt, jedes Feld auszufüllen.
5257

5358
Wenn das Feld ausgefüllt wurde, deutet dies auf einen Spambot hin. Die Validierung schlägt dann fehl.
@@ -59,30 +64,32 @@ Wenn das Feld ausgefüllt wurde, deutet dies auf einen Spambot hin. Die Validier
5964
* Im REDAXO-Backend unter `YForm` > `Spamschutz` optional Einstellungen vornehmen.
6065

6166
## Achtung
67+
6268
Einige Einstellungen haben aktuell noch keine Funktion. Beteilige dich an der Umsetzung unter [https://github.com/FriendsOfREDAXO/yform_spam_protection/issues](https://github.com/FriendsOfREDAXO/yform_spam_protection/issues)
6369

6470
## Tipps und Tricks
6571

6672
Der 4. Parameter am Feld aktiviert den Debug-Modus
6773

68-
6974
```
7075
spam_protection|honeypot|Bitte nicht ausfüllen|Fehlermeldung|1
7176
```
7277

7378
Bei mehreren Formularen auf einer Seite musst Du jedem Formular einen eindeutigen Namen mitgeben:
7479

7580
**PHP-Schreibweise**
81+
7682
```php
7783
$yform->setObjectparams('form_name','zweites_formular');
7884
```
7985

8086
**Pipe-Schreibweise**
87+
8188
```
8289
objparams|form_name|zweites_formular
8390
```
8491

85-
Sollte trotz aller beachteten Timings und obigem Tipp zu mehreren Formularen beim Versenden der Fehler „session-microtime nicht eingehalten...“ (bei eingeschalteten Debug-Modus) dauerhaft kommen, so ist zu prüfen, ob das Formular evtl. nicht zweimal abgesendet wird.
92+
Sollte trotz aller beachteten Timings und obigem Tipp zu mehreren Formularen beim Versenden der Fehler „session-microtime nicht eingehalten...“ (bei eingeschalteten Debug-Modus) dauerhaft kommen, so ist zu prüfen, ob das Formular evtl. nicht zweimal abgesendet wird.
8693

8794
Mögliche Ursache dafür ist, dass im Template beispielsweise `REX_ARTICLE[]` oder `$this->getArticle()` mehr als einmal verwendet werden.
8895

@@ -93,8 +100,8 @@ Mögliche Ursache dafür ist, dass im Template beispielsweise `REX_ARTICLE[]` od
93100
## Autor
94101

95102
**Friends Of REDAXO**
96-
http://www.redaxo.org
97-
https://github.com/FriendsOfREDAXO
103+
<http://www.redaxo.org>
104+
<https://github.com/FriendsOfREDAXO>
98105

99106
## Credits
100107

0 commit comments

Comments
 (0)