docs(express): README matches the middleware - #44
Merged
Merged
Conversation
Documents monitor as the default mode, that apiKey must be passed (the SDK never reads WEBDECOY_API_KEY itself), trustProxy instead of reading X-Forwarded-For, onBlocked's next argument, honeytoken, rules, and the current apiUrl default.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The Express README described the pre-0.7 middleware:
mode: 'monitor', which never blocks. Now says so and showsmode: 'enforce'.apiKeymust be passed; the SDK never readsWEBDECOY_API_KEYby itself.X-Forwarded-For/X-Real-IP; since 0.12.0 it usesreq.iportrustProxy.mode,honeytoken,rules,trustProxy,threshold, andonBlocked'snext;apiUrldefault isin.webdecoy.com.README only, no code change.