Skip to content
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

docs: Note that reporting percentage needs rate limiting middleware #256

Merged
merged 3 commits into from
Jan 20, 2025
Merged

docs: Note that reporting percentage needs rate limiting middleware #256

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8664a3d
Change conf copyright year to current
janbrasna Jan 19, 2025
e08bf1c
Add contrib middleware note with reporting ref
janbrasna Jan 19, 2025
d70ed42
Trim empty defaults from index.rst
janbrasna Jan 20, 2025
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
2 changes: 1 addition & 1 deletion docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@

# General information about the project.
project = "Django-CSP"
copyright = "2016-2024 Mozilla"
copyright = "2016-%Y Mozilla"

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
Expand Down
5 changes: 5 additions & 0 deletions docs/configuration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,11 @@ policy.
number of CSP violation reports made to your ``report-uri``. A **float** between 0.0 and 100.0
(0.0 = no reports at all, 100.0 = always report). Ignored if ``report-uri`` isn't set.

.. note::
To allow rate limiting, ``csp.contrib.rate_limiting.RateLimitedCSPMiddleware`` must be used
instead of ``csp.middleware.CSPMiddleware``.
See :ref:`violation reporting <reports-chapter>` for more details.

``DIRECTIVES``
A dictionary of policy directives. Each key in the dictionary is a directive and the value is a
list of sources for that directive. The following is a list of all the directives that can be
Expand Down
14 changes: 2 additions & 12 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
.. Django-CSP documentation master file, created by
sphinx-quickstart on Wed Oct 31 13:02:27 2012.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
.. Django-CSP documentation home.
It should contain at least the root `toctree` directive.

==========
django-csp
Expand Down Expand Up @@ -29,12 +27,4 @@ Contents:
contributing


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`


.. _Content-Security-Policy: http://www.w3.org/TR/CSP/
Loading