Skip to content

Commit 4b5e52a

Browse files
committed
Add error and troubleshooting headers. Clarified the suggestion to a
recomendation on @csrf fields.
1 parent 798ef28 commit 4b5e52a

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

doc/upgrading.txt

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -131,9 +131,12 @@ field/header is missing it allows access. Setting these
131131
fields to ``required`` blocks access if the header/nonce is
132132
missing.
133133

134-
It is suggested that you change your templates so every form
135-
has an @csrf field and change the setting to 'required' for
136-
the csrf_enforce_token.
134+
It is recommended that you change your templates so every form
135+
that is not submitted via GET has an @csrf field. Then change
136+
the csrf_enforce_token setting to 'required'.
137+
138+
Errors and Troubleshooting
139+
~~~~~~~~~~~~~~~~~~~~~~~~~~
137140

138141
If you see the @csrf nonce in the URL, you have added the value to a
139142
form that uses the GET method. You should remove the @csrf token from
@@ -303,6 +306,9 @@ or with::
303306
the important part is that the action field **must not** include any query
304307
parameters ('#' includes query params).
305308

309+
Errors and Troubleshooting
310+
~~~~~~~~~~~~~~~~~~~~~~~~~~
311+
306312
One symptom of failing to do this is getting an error:
307313

308314
Unrecognized scheme in ....
@@ -513,6 +519,9 @@ permissions to your schema.py::
513519
description="User is allowed to Search queries for creator")
514520
db.security.addPermissionToRole('User', s)
515521

522+
Errors and Troubleshooting
523+
~~~~~~~~~~~~~~~~~~~~~~~~~~
524+
516525
If you do not do this, public queries will be listed twice in the edit
517526
interface. Once in the "Queries I created" section and again in the
518527
"Queries others created" section of the query edit page

0 commit comments

Comments
 (0)