Module Features and Usage
Q: Why a DotNetNuke module and not a Http Module or DotNetNuke Skin Object?
A: The DotNetNuke Module design gives the best flexibility. Not every page on your site will need a Canonical Link, and a one-size fits all approach makes configuration more difficult. With the Canonical Linker module, you can choose the best configuration option for different pages, allowing you to craft a configuration for pages hosting complex modules like the DotNetNuke Forum module, or you can apply it to all pages in the site by ticking the 'show on all pages' option. A module is also easier to install and uninstall, whereas skin objects require modifications to the skin and Http Modules require installation into the web.config.
Q: Why do I see this on my page?
Canonical Link Element (this message is not visible by ordinary users):
<link rel='canonical' href='http://mysite.com/dnnpage.aspx'>
A: This is the standard information / help text for the module. You can change the messages by going into the module settings and changing the values. Note that if you remove the values altogether, the default values will return.
Q: I've added the module to my page, why can't I see it?
A: The module does not have any visible element to it. To see the module and change the settings, make sure you're signed on as a super user, then put the site into 'edit' mode. The module will then appear on the pages it is installed on.
Q: Do I need to run the Url Master module on my site to use the Canonical Linker Module?
A: No. The Canonical Linker module will work with just about every Url Rewriting product available for DNN, including the Url Master module. But it's not a pre-requisite.
Q: Do I need to place this module on every page of my site?
A: It depends. If you have a good 301 redirect scheme on your site, then you don't need to worry too much about Canonical Link Elements. However, if you're using things like tracking Ids, affiliate link ids and similar, then you probably need to implement the canonical Linker module. Note that settings made on different pages with regards to the Canonical Link type are stored at the page level, not across all installed modules.
Q: What's the difference between the Canonical Link Element and a 301 redirect?
A: 301 redirects are server-based permanent redirects that transfer a visitor or search engine crawler to the correct location for a given page. A Canonical Link element is information specifically for search engine crawlers to use if they cannot decide on a canonical Url for the page. A 301 scheme for your DotNetNuke site is preferable to using Canonical Link Elements, because the Canonical Link Element is a 'hint' rather than a directive. Search engines may or may not read it. However, with a 301 redirect, both crawlers and visitors to your site are presented with the correct Url every time.
Q: What's the difference between the options of 'Page Url', 'Requested Url' and 'Page Url with Requested Querystring' in the module settings?
A: These different options are to allow you to choose different ways of generating your canonical links. Here's what they do:
Page Url : the Canonical Link is the Url for the current DNN page, as returned by the configured Friendly Url Provider. This does not include any querystring or any other information. If using a DNN module on that page such as the Blog module (which uses a querystring in the requests) then just the page Url will be shown.
Requested Url : the Canonical Link is the Url for the current page, exactly as requested. You can configure regex find/replace functions in the module settings to change parts of the requested url to remove things like unwanted query strings.
Page Url with Requested Query string : the Canonical Link is the current DNN Page, as in 'Page Url'. However, the current querystring for the request is parsed and added back into the Url by calling the configured Friendly Url Provider. You can also exclude certain parts of the query string, such as a sorting key/value pair, a tracking code, or similar.
You should choose the correct value with regards to the page the module is on.
Licensing and Support Questions
Q: Why do I have this message on my page, telling me I have an unlicenced copy/invalid licence/trial licence?
A: The Canonical Link Master is a premium module and you have to purchase a licence for it to remove this message. If you have purchased a licence and you are still getting the message, you might have a problem with your permissions. The asp.net worker process needs to have read permission on the licence subdirectory, and all files in that subdirectory. On some DNN installations, when you FTP the file up, it isn't given the correct read permissions automatically.
Q: I have purchased the module, and I'm still getting the Trial Licence message
A: There is no functional difference between the trial version and the full version. When you purchase a copy of the module, you get issued with a licence file that removes the licencing messages. So, if you've purchased the module but haven't yet recieved a licence file, please make sure you've requested the licence file from http://www.ifinity.com.au/Licensing/Product/iFinity.CanonicalLinkMaster . If you have obtained the licence message, and it still isn't working correctly, please report the problem to support@ifinity.com.au.
Q: How does the licensing system work?
A: The iFinity licence system works like this for all types of licence - except for a 'Host' Licence, which is explained in the next FAQ.
When you purchase a 1 or 5 domain license, you are licensing the module for 1 to 5 named, top-level domains. Sub-domains and child portals are all treated as a member of the top-level domain and do not require an additional license.
You may distribute the license across any combination of unique DNN installs and domain names as long as the total number of top-level domains is less than or equal to the number of domains licensed from iFinity.
You tell iFinity the number of DNN installs in which you will install the module and the unique top-level domain names within each DNN install.
We generate the necessary license file(s) and send them to you.
If you have more domains than licenses in a DNN install, all non-licensed domains display a message that says “unlicensed software is used on this site”.
If you need 3 domains today but know that you will want a 5-domain name license in the future, purchase the 5-domain today. iFinity will generate the license files for the 2 additional names when you request them in the future.
Example 1 : 5 Domain Licence, issued for:
- domain1.com
- domain2.com
- domain3.com
- domain4.com
- domain5.com.
DNN Install 1
Server 1 |
DNN Install 2
Server 1 |
DNN Install 3
Server 2 |
| www.domain1.com Licensed |
domain3.com Licensed |
www.domain4.comLicensed |
| domain2.comLicensed |
domain3.com/childportalLicensed |
product.domain5.comLicensed |
| test.domain1.comLicensed |
domain3.orgUnlicensed (wrong top level domain) |
domain6.com Unlicensed (not in licence file) |
Example 2 : 1 Domain licence, issued for 'domain1.com', installed on two servers making up a webfarm for domain1.com
DNN Install 1
Server 1 (webfarm) |
DNN Install 1
Server 2 (webfarm) |
| www.domain1.comLicensed |
www.domain1.comLicensed |
| www.domain1.orgUnlicensed (wrong top level domain) |
www.domain2.comUnlicensed (domain not in licence file) |
Q: What does a 'Host' licence give me?
A: A 'Host' licence is a special type of licence unique to the Url Master software. This is because the Url Master works across all domains in a DNN install - so all domains needs to be licensed. A Host licence gives you unlimited domain names in a single DNN install. A Host licence does NOT give you unlimited domains for any DNN install - all of the domains must be associated with portals in a single DNN installation.
All we need for a host licence is the 'host' portal domain, and the Host guid. To order a host licence, use the link shown in the first secton of the 'Friendly Url Settings' page. This will link to the iFinity Licensing page, and will pre-fill out the required details for you.
Q: Can I get a licence for my development/staging/test server?
A: If you've got a test domain, just request it with your licence. There is no charge for test domains, as long as they're obviously a test/staging/development site. You can request 'localhost' or 'devmachine' - whatever domain your testing site runs on.
Q: I've got 2 domains that I'd like to use the product on, and I'm going to have another 2 in a couple of months. Can I purchase a 5 domain licence even though I don't have all 5 domains right now?
A: Yes you can purchase a 5 domain licence, and then 'use up' the domains over time. Just submit a licence request for each additional domain name as you need. Once you've used up the 5 domains, you can also upgrade to a host licence, if all the domains are on the one DNN install. Otherwise, just purchase another 5 domain licence.
Q: I asked for a licence for a particular domain, now I've decided not to use that domain. Can I substitute another domain instead?
A: No. Once a domain licence has been issued, it can't be exchanged for another. Please take the time to choose your licensed domain names carefully as substitutions will not be made.
Q: What does a licence file look like?
A: A licence file is an Xml file containing all the details about the domains you have licensed. It will be sent to you, and when saved in the specified location, will remove the licensing messages from the software. You can't modify the licence files yourself as they are signed with an encrypted key - if you modify the licence file it will become invalid, and you'll need to request a new one to fix it.
Q: I have three domains : mydomain.com, mydomain.co.uk and mydomain.com.au - do I need a single domain licence or a 5 domain licence?
A: You need a 5 domain licence, as the separation of domains occurs at the top-level domain. You can use as many subdomains as you like.
Q: What Support do I get with my licence?
A: In general, you'll get all the support you need to get the software running as advertised when you first install the product. Our lawyers make us put a sunset clause on the support clause in the End User Licence Agreement, so there is an 'official end' to the support you'll get. Support is given via the support forum, and in some cases through instant messaging, email and other arrangements. It may be necessary for you to grant host access to your portal, and possibly FTP access.