Magnolia 5.6 reached end of life on June 25, 2020. This branch is no longer supported, see End-of-life policy.
This page contains an example of how to configure multiple sites to manage different websites mapped to different domains.
Example scenario: Eric has a store where he sells comic books and vinyl records. He wants different sites for his products. Comic books are his main business.
Eric has registered two domains: one for comics and one for vinyl. Since comics is his primary business, he registered the domain
www.best-comics.net
for the comics first, so this will be his main domain.
author instance | public instance | |
---|---|---|
comics | author.best-comics.net | www.best-comics.net |
vinyl | www.best-vinyl.net |
Use only one domain - a subdomain of the main domain - to access the author instance (see Magnolia setup and domains).
Eric has created a lot of pages. When simplified, his website workspace has a structure with two pages in root directory as shown below. The two pages act as the home pages for the two different websites (both have many subpages not shown here).
Page | Title |
---|---|
comics | Best comics |
vinyl | Best vinyl |
This table shows the configuration of the site definitions required by Eric.
Node name | Value |
---|---|
fallback | |
mappings | |
extends | override |
extends | ../comics-site |
comics-site | |
templates | |
prototype | |
mappings | |
website | |
URIPrefix | |
handlePrefix | /comics |
repository | website |
domains | |
best-comics | |
name | www.best-comics.net |
vinyl-site | |
mappings | |
website | |
URIPrefix | |
handlePrefix | /vinyl |
repository | website |
domains | |
best-vinyl | |
name | www.best-vinyl.net |
Note the following points which reflect common practice and the scenario:
comics-site
- that defines a prototype.fallback
site:@extends=../comics-site
.@extends=override
.
Request the URL http://www.best-comics.net. If you are redirected to the admin login page (http://www.best-comics.net/.magnolia/admincentral), the public context contains a virtualURIMapping. This URI mapping is fine for an author context but not for the public context.
To remove the mapping:
Use the Configuration app to search for virtualURIMapping
.
On a standard Magnolia bundle you typically find the following node: /modules/ui-admincentral/virtualURIMapping.
Node name | Value |
---|---|
virtualURIMapping | |
default | Delete this node on the public instance |
class | info.magnolia.multisite.MultiSiteRootVirtualURIMapping |
fromURI | / |
toURI | redirect:/.magnolia/admincentral |
Delete the node /modules/ui-admincentral/virtualURIMapping/default
.
Test the setup. Make sure you have pages shown in content setup in both the author and public instances.
URL | website on browser | rendered page node |
---|---|---|
Public instance | ||
/comics | ||
www.best-vinyl.net | /vinyl | |
Author instance | ||
author.best-comics.net/comics-site
| /comics | |
author.best-comics.net/vinyl-site | /vinyl |
To access the root page of a site in the author instance, which is accessed on a domain that is not mapped to a site, use the following URL:
<protocol>://<author-domain>/<context>/<site-definition-name>
Note that Magnolia creates these links automatically, for example, when you open the Preview tab in the author instance.
Imagine that Eric wants to advertise his vinyl records store from the comic book store and vice versa. So he creates links from pages on the comics-site
to the vinyl-site
and vice versa.
Use the link component from mtk (mtk:components/link
) in your page template to add links:
In this example, on the root page of the comics-site
we add a link to the root page of the vinyl-site
.
When Magnolia resolves links in a multisite context, it creates links that start with the domain:
You can access a site using the site-definition-name. The full pattern of this kind of URL looks like this:
<protocol>://<domain>:<port>/<context>/<site-definition-name>
Note that this only works if the domain is different from the domain which is mapped to the site of the given site-definition-name.
This way of accessing a site and its pages is necessary in the author instance. It is the usual way to access a site in the author instance, since the domain of the author instance usually is different from the domains mapped to the public instance and mapped to the sites. In this scenario, the access URLs of the sites on author are:
Following the above URL pattern, you can access the sites in the public instance using:
Note that the first URL accesses the vinyl site via the comic site domain and the second URL accesses the comic site via the vinyl site domain.
This type of access should be avoided in a public instance because:
To prevent this:
Disable the Add an additional voter uri-starts-with-sitename
rule in the public context. to the rule. This way you can use the same configuration on both the author and public instances.
rules uri-starts-with-sitename matchers 0 class 1 class multipleMatchesPossible Matcher Node name Description info.magnolia.multisite.sites.matchers.SiteNameMatcher info.magnolia.multisite.sites.matchers.AdminOnlyMatcher false 0
is set by default in the uri-starts-with-sitename
rule. Add as a second matcher to ensure the rule is applied in the author instance only.