Skip to content
This repository has been archived by the owner on May 23, 2020. It is now read-only.
/ redirect Public archive

Advanced redirect plugin for October CMS (abandoned)

License

Notifications You must be signed in to change notification settings

adrenth/redirect

Repository files navigation

Adrenth.Redirect

The #1 Redirect plugin for October CMS (Editors' choice)

This is the best Redirect-plugin for October CMS. With this plugin installed you can manage redirects directly from October CMS' beautiful interface. Many webmasters and SEO specialists use redirects to optimise their website for search engines. This plugin allows you to manage such redirects with a nice and user-friendly interface.

This plugin is fully compatible with OctoberCMS build 434+. This is a new optimised version for PHP 7.0. PHP5 is not supported as of version 4.

What does this plugin offer?

This plugin adds a 'Redirects' section to the main menu of October CMS. This plugin has a unique and fast matching algorithm to match your redirects before your website is being rendered.

DEMO

http://demo.alwindrenth.nl/backend

Username: demo

Password: demo

Features

  • Quick matching algorithm
  • A test utility for redirects
  • Matching using placeholders (dynamic paths)
  • Match placeholders using regular expressions
  • Exact path matching
  • Importing and exporting redirect rules
  • Schedule redirects (e.g. active for 2 months)
  • Redirect to external URLs
  • Redirect to internal CMS pages
  • Redirect log
  • Categorize redirects
  • Statistics
    • Hits per redirect
    • Popular redirects per month (top 10)
    • Popular crawlers per month (top 10)
    • Number of redirects per month
    • And more...
  • Multilingual (Need help translating! Contact me at [email protected])
  • Supports MySQL, SQLite and PostgreSQL
  • HTTP status codes 301, 302, 303, 404, 410
  • Caching

Supported database platforms

  • MySQL
  • PostgreSQL
  • SQLite

Supported HTTP status codes

  • HTTP/1.1 301 Moved Permanently
  • HTTP/1.1 302 Found
  • HTTP/1.1 303 See Other
  • HTTP/1.1 404 Not Found
  • HTTP/1.1 410 Gone

Supported HTTP request methods

  • GET
  • POST
  • HEAD

Performance

All redirects are stored in the database and will be automatically "published" to a file which the internal redirect mechanism uses to determine if a certain request needs to be redirected. This is way faster than querying a database.

This plugin is designed to be fast and should have no negative effect on the performance of your website.

To gain maximum performance with this plugin:

  • Use the latest version of PHP7 (really you should)
  • Enable redirect caching using a "in-memory" caching method (see Caching).
  • Maintain your redirects frequently to keep the number of redirects as low as possible.
  • Try to use placeholders to keep your number of redirect low (less redirects is better performance).

Caching

If your website has a lot of redirects it is recommended to enable redirect caching. You can enable redirect caching in the settings panel of this plugin.

Only cache drivers which support tagged cache are supported. So driver file and database are not supported. For this plugin database and file caching do not increase performance, but can actually have a negative influence on performance. So it is recommended to use an in-memory caching solution like memcached or redis.

How caching works

If caching is enabled (and supported) every request which is handled by this plugin will be cached. It will be stored with tag Adrenth.Redirect.

When you modify a redirect all redirect cache will be invalidated automatically. It is also possible to manually clear the cache using the 'Clear cache' button in the Backend.

Placeholders

This plugin makes advantage of the symfony/routing package. So if you need more info on how to make placeholder requirements for your redirection URLs, please go to: https://symfony.com/doc/current/components/routing/introduction.html#usage

Contribution

Please feel free to contribute to this awesome plugin.

Questions? Need help?

If you have any question about how to use this plugin, please don't hesitate to contact me. I'm happy to help you. You can also visit the support forum and drop your questions/issues there.

Kind regards,

Alwin Drenth -- Author of the Redirect plugin


If you love this quality plugin as much as I do, please rate my plugin, or consider a donation to support this plugin and my other quality October CMS plugins. Donate to PayPal or donate BitCoin to 1KowxskQEFLh7PUFeWxtPp1JMzH42bseaD.


Other plugins by Alwin Drenth

HtmlPurifier

HtmlPurifier - Adds a standards compliant HTML filter to October CMS.

RssFetcher

RssFetcher - Fetches RSS/Atom feeds from different sources to publish on your website or dashboard.