Redirect access to pages and media files by asking the client to refetch resources at the new location with redirect status 301 or 302. The development of the Redirect2 plugin intend to provide feature like Redirect Directives of the Apache HTTP Server.

Search and install the plugin using the Extension Manager. Refer to Plugins on how to install plugins manually.

The redirect rules can be defined throught the admin menu (redirect manager) and stored in conf/redirect.conf file. Lines that start # are just comments, and also text after # (at least one white space needs before #) are ignored as comment.

Each rule consists three fields – status, origin, destination – but the status field can be omitted assuming a temporary redirect status (302).

redirect.conf

# Example rederect map (redirect.conf)
# Status  Origin            Destination
   301     ns1:              ns2:ns2a:        # Rule 1
   302     ns1:ns1a:         ns3:             # Rule 2
   301     ns1:ns1a:page1    ns4:page2        # Rule 3
           ns1:ns1c:         page#lostpages   # Rule 4
 
# images and media files  
   302     :ns1:image.png    http://example.com/image2.png  # external
   301     :ns1:             :ns1:example.pdf

• The origin and destination ID of page/media or namespaces must be absolute and cleaned (no specialchars, all lowercase).
• Put : in front of the ID for media, otherwise any ID are assumed for pages.
• If the origin field ends :, all pages/media files under the given namespace will be redirected. You may also put : to the end of destination ID to keep page/media name in the new namespace.

Every page/media access are checked against redirect rules until applicable one found by reducing sub namespace. This means that the order of redirect rules is less significant. For example, the access to the page ns1a:ns1b:page is to be tested in following sequence:

These are example behavior of page redirections when example redirect.conf file above used.

EXPERIMANTAL : The Regex test feature is disabled by default config setting.

You may need more complex redirect rules instead of simple pagename matching. The redirect2 plugin tentatively covers the limitted feature of RedirectMatch Directives of the Apache HTTP Server.

If the origin field is enclosed in % marks, a regular expression (regex) matching used instead of simple pagename matching.

# Example rederect map (redirect.conf)
# Status     Origin            Destination
302       %^:ns1:(.*\.pdf)$%    :ns2:$1

• Any regex rules are to be tested against page/media ID if normal pagename matching sequence has failed.
• Regex rules are used as defined order in the redirect conf file.
• Regex tests will break when an applicable rule is found.

The origin can be non-existing page, which should be redirected to specified destination. This however conflicts with NotFound plugin that will display a custom page for non-existing 404 page and prevent such redirect. The redirect2 plugin alternatively supports own 404 page.

Please do not define redirection loop in the redirect.conf rule file. Anyway, the redirect2 will stop if the destination page found in the breadcrumbs list, even thought it does not eliminate potential infinite redirect loop.

The plugin can be configured with the configuration manager in the admin menu.

useRedirectMatch EXPERIMENTAL	enable regular expressions matching rule for redirect. (default value = off)
show_msg	Display a message about the redirection? (default value = off)
msg_target	Limit redirection message to … (default value = 'only for admin')
404page	Pagename to display when the page is not found (like http 404 response) (default value = none)
logging	enable logging. The redirection.log file is stored in data/cache directory. (default value = off)

• Update README.md (2023-11-13 10:49)
• update version (2023-11-13 10:48)
• use dokuwiki\Cache \Cache class (2023-11-13 10:47)
• use autoloader (2023-11-13 10:22)
• remove require_once() calls (2023-11-13 00:11)