Download the PHP package bnomei/kirby3-redirects without Composer
On this page you can find all versions of the php package bnomei/kirby3-redirects. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download bnomei/kirby3-redirects
More information about bnomei/kirby3-redirects
Files in bnomei/kirby3-redirects
Package kirby3-redirects
Short Description Setup performant HTTP Status Code Redirects from within the Kirby Panel
License MIT
Homepage https://github.com/bnomei/kirby3-redirects
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package kirby3-redirects
Kirby Redirects
Features
- ✏️ Define HTTP Status Code redirects from within the Kirby Panel.
- 🔀 Setup redirects from any request URI to any response URI, not just Kirby routes.
- 🕵️ Match on query-strings like
?foo=barand forward data with regex(?P<year>\d{4}). - 🛡️ Protects your website from attacks by blocking 50+ routes/patterns of other popular CMS.
- 🪝 With the hooks you can add custom logic like logging 404s.
- 🏎️ Highly performant due to caching on repeated valid requests.
Installation
- unzip master.zip as folder
site/plugins/kirby3-redirectsor git submodule add https://github.com/bnomei/kirby3-redirects.git site/plugins/kirby3-redirectsorcomposer require bnomei/kirby3-redirects
Setup: add Redirects section to Site blueprint
Add the plugin-redirects section to your site.yml. This will allow you to create redirects in via the Panel or
programmatically.
site/blueprints/site.yml
[!TIP] If you want to able to set all HTTP Status code from within the panel, not just the 3xx range, you can use
extends: plugin-redirectsinstead.[!TIP] Instead of using the site blueprint you can also use the
redirectssection in any pages blueprint as long as you adjust thebnomei.redirects.mapoption accordingly so the plugin knows where to find the redirects.
Usage
In the Structure Field within the Panel add a Request-URIs fromuri, set a Response-URIs touri and a HTTP Status Code code like 301 or 302.
| fromuri | to | code |
|---|---|---|
projects/cool |
projects/changed-slug |
301 |
projects/cool.html |
projects/changed-slug |
301 |
projects\/.*\.html |
projects/changed-slug |
301 |
some/broken-link |
https://exter.nal |
301 |
blog\/(?P<year>\d{4})_(?P<slug>.*)\.html |
blog/$year/$slug |
301 |
Exact redirects
For generated redirect maps with many known 301 redirects, use bnomei.redirects.exact. It is checked before the
Panel-managed map and only performs strict request URI lookups. Regex patterns and placeholders are intentionally not
processed in this list.
site/config/config.php
site/redirects/exact.php
Shielding your website from attacks
This plugin will block 50+ routes/patterns of other popular CMS. It is enabled by default and will reduce the load on your website caused by bots/attackers looking for vulnerabilities found in other CMS.
- Drupal
- Joomla
- Magento
- Shopify
- Wordpress
You can track any redirects, including the blocked requests from the shield, using the redirect:before and
404:before hooks.
Hooks
This plugin will trigger the following hooks, which you could use to build your own tracking or logging.
redirect:before($code, $redirect)404:before($route, $path, $method)
site/config/config.php
Programmatically changing the redirects table
The site methods appendRedirects and removeRedirects allow you to programmatically change the redirects table (if
stored in a Page/Site-Object Field, see map config option).
Performance
Redirects are checked against exact redirect entries first and then against the configured redirect map. Unmatched public requests are not written to the cache.
Similar Plugins
- kirby-retour while featuring a nice UI and built-in 404 tracking it can only handle Kirby routes (with pattern matching) but not any request URI.
Settings
| bnomei.redirects. | Default | Description |
|---|---|---|
| code | 301 |
|
| querystring | true |
do keep querystring in request URI. example: https://kirby3-plugins.bnomei.com/projects?id=12 => projects?id=12 |
| only-empty-results | false |
only redirect if the result is empty in the router |
| exact | null |
Strict request URI lookup map for generated redirects: ['/old' => '/new']. Runs before map and does not process regex patterns. |
| exact.code | 301 |
HTTP status code used for exact redirects. |
| map | callback |
A closure to get the structure from content/site.txt. Define you own if you want the section to be in a different blueprint or skip the blueprint and just use code. |
| shield.enabled | true |
Block various routes of other popular CMS |
Disclaimer
This plugin is provided "as is" with no guarantee. Use it at your own risk and always test it yourself before using it in a production environment. If you find any issues, please create a new issue.
License
It is discouraged to use this plugin in any project that promotes racism, sexism, homophobia, animal abuse, violence or any other form of hate speech.
