Skip to content

Commit

Permalink
Document '*,' SURT in access controls documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
tw4l committed Feb 13, 2024
1 parent abbe636 commit 6cf0626
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/manual/access-control.rst
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,10 @@ Given these rules, a user would:
* but would receive an 'access blocked' error message when viewing ``http://httpbin.org/`` (block)
* would receive a 404 not found error when viewing ``http://httpbin.org/anything`` (exclude)

To match any possible URL in an .aclj file, set ``*,`` as the leading SURT, for example::

*, - {"access": "allow"}


Access Types: allow, block, exclude, allow_ignore_embargo
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down Expand Up @@ -149,6 +153,10 @@ To make this work, pywb must be running behind an Apache or Nginx system that is

For example, this header may be set based on IP range, or based on password authentication.

To allow a user access to all URLs, overriding more specific rules and the ``default_access`` configuration setting, use the ``*,`` SURT::

*, - {"access": "allow", "user": "staff"}

Further examples of how to set this header will be provided in the deployments section.

**Note: Do not use the user-based rules without configuring proper authentication on an Apache or Nginx frontend to set or remove this header, otherwise the 'X-Pywb-ACL-User' can easily be faked.**
Expand Down

0 comments on commit 6cf0626

Please sign in to comment.