Create your first redirections
This knowledge base article explains how to start creating a redirection plan using redirection.io. On this page, you will learn :
- how to create 1:1 redirects
- how to create redirection rules to bulk-redirect URLs
- how to manage priorities across redirections
This tutorial assumes that you have installed a working instance of redirection.io. If it is not yet the case, you can either read our install documentation, learn how to setup on Azure Cloud, or use our open source Docker example.
We are going to create a first redirection rule, as explained in our documentation.
- In the "rules" menu, hit the "Create a new rule" link
- In the "Source URL" field, type
/test. This means that this rule will be triggered (executed) every time an incoming request has the
/testpath. There are several other triggers that allow to narrow the matching of incoming requests, but for now we will continue with this simple rule.
- Hit the "Next" button. The second step allows to create example requests for this rule. Examples are useful, because they help make sure that the rule behaves exactly as you expect it. Of course, for the moment this is the only rule (and its trigger is very simple), but when a redirection plan ages, it can get really complicated to understand how rules are applied, in which order, and check that adding a new rule will not break already redirected URLs.
- The "Actions" step allows to define which actions have to be executed when this rule is triggered by a request. Choose the "Redirection" action, enter a target URL, and hit the "Next" button
- The final step, named "Impact", explains how this rule behaves on the examples created during the second step. You can get detailed information, for each example, by clicking on its line.
- If the behavior seems correct, bit the "Save this rule" button
The rule is now created, and the last step is to publish the ruleset to have it applied to your server. Look at the orange bar at the top of the screen: click on the "Publish changes" button, the "Publish this version".
After some time, the published ruleset will be applied on your server. The delay before the rules are applied is about 20 seconds. You can also restart the
redirectionio-agent service, as the agent tries to load rules when it is restarted:
sudo systemctl restart redirectionio-agent
Open the url
http://<IP ADDRESS OF YOUR SERVER>/test, and you should get redirected to
/other-url (or the target that you have defined in the rule).
The first step, in order to have a domain name managed using your brand new redirection service, is to target its DNS to the IP address of your server. In the DNS panel of your domain name registrar, change the
A field and enter the public IP address provided by your hosting provider. Of course, you have to perform a similar step it if you want to redirect a subdomain. Say that you just configured the domain
Once the DNS propagation is complete, requests performed to your
example.com domain name will be handled by the redirection server. Go to
http://example.com/test : a redirection is made using the first rule created above. As this rule does not have a domain name, it will be applied to every incoming request, whatever the domain name, provided the path of the request is
/test. Let's delete this rule, we do not need it anymore.
Create a new rule and click on the "Add marker" button, in the "Source URL" field. Markers are placeholders that can catch several strings based on conditions. Create a marker of the "anything" type:
Hit the "Next" button, and choose "HTTP 410 response" as the action to be executed. Go ahead, and save the rule. Publish the rule, and once it is applied to your production, you should get a "410 Gone" response for every request performed to the redirection server, whatever the requested URL.
Now, we are going to explicitly allow your
example.com domain name to be redirected. Let's create a new rule. In the "Source URL" field, type
://example.com/, then add a "anything" marker:
http://example.com/test-value as examples (check the "must match" switch), and choose the "redirection" action. In the "Target URL" field, type the URL to redirect to. Save and publish the rule. Here is how the ruleset should look at that point:
After a few minutes, try to load http://example.com/test in your browser: you should be redirected to the domain entered in "Target URL".
We have not covered much of redirection.io capacities until now. Try several expressions in the "Trigger" and "Action" sections to create specific redirections:
|Source URL||Target URL|
- the first rule will redirect every request performed in http or https on the domain
example.comfor every page under
- the second rule will redirect every request performed in http or https on
- the third rule will redirect every request performed in http or https on the domain
example.comfor every page to the same path like the original request, but in https on the host
Obviously, the second and third rules could collide, as both of their triggers match the incoming URL
https://example.com/some-specific-url, for example. This is the reason why redirection.io offers a "priority" feature. When editing a rule, you can define its priority: the higher the value, the higher the priority of the rule. Setting the priorities for your rules allow to create a deterministic redirection plan, which is obviously what one would want:
However, when the redirection plan becomes larger, it can be hard to keep all priorities in mind. This is the reason why examples are so important; they help, at the rule level, check that the ruleset behaves correctly. See the "Impact" section for the third rule:
Clicking on the example line opens an inspector lateral panel, which includes several tools:
- "Current rule matching" explains if the currently edited rule matches the example request
- "Matched rules" lists all the rules that match this example request
- "Detailed actions" give the cumulative detail of the actions performed by each rule, and help understand the expected response for this example request
The second tab is particularly useful in the case of examples that trigger several rules of the ruleset. In this case, you can move the position of the currently applied rule within the rules stack, which dynamically changes its priority in the ruleset and ensures a coherent state: