Skip to content

Docs: Format HTML in rack-protection README #300

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jkowens merged 1 commit into from
Dec 22, 2022
Merged

Docs: Format HTML in rack-protection README #300

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions _includes/rack-protection-readme.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,8 +84,11 @@ <h2>Session Hijacking</h2>

<h2>Cookie Tossing</h2>

<p>Prevented by:
* <a href="http://www.sinatrarb.com/protection/cookie_tossing"><code>Rack::Protection::CookieTossing</code></a> (not included by <code>use Rack::Protection</code>)</p>
<p>Prevented by:</p>

<ul>
<li><a href="http://www.sinatrarb.com/protection/cookie_tossing"><code>Rack::Protection::CookieTossing</code></a> (not included by <code>use Rack::Protection</code>)</li>
</ul>

<h2>IP Spoofing</h2>

Expand All @@ -112,9 +115,9 @@ <h1>Installation</h1>
<h1>Instrumentation</h1>

<p>Instrumentation is enabled by passing in an instrumenter as an option.
~~~~
use Rack::Protection, instrumenter: ActiveSupport::Notifications
~~~~</p>

<p>The instrumenter is passed a namespace (String) and environment (Hash). The namespace is ‘rack.protection’ and the attack type can be obtained from the environment key ‘rack.protection.attack’.</p>
<pre><code> use Rack::Protection, instrumenter: ActiveSupport::Notifications
</code></pre>

<p>The instrumenter is passed a namespace (String) and environment (Hash). The namespace is <code>rack.protection</code> and the attack type can be obtained from the environment key <code>rack.protection.attack</code>.</p>