Site Factory is a site management interface, integrated with the Back Office. It enables you to configure new sites without editing YAML-based SiteAccess configuration.
A SiteAccess that you define for a site by following the configuration
is always treated with higher priority than a SiteAccess created by using the Site Factory.
For example, if you define a French site within a YAML file,
and then create a site that uses the
fr path in Site Factory, matchers ignore the second site.
Site Factory is disabled by default after installation.
If you plan to use Site Factory, you need to enable and configure it. To enable or disable Site Factory, follow respectively:
Enable Site Factory¶
To enable Site Factory, set the
ibexa_site_factory.enabled configuration key to
Next, configure Site Factory by adding empty SiteAccess groups. At least one empty group is required. The number of empty SiteAccess groups must be equal to the number of templates that you want to have when you create the new site.
In this example, you add two SiteAccess groups (
that correspond to the two templates (
site2) that you add in the next step.
Add the groups under the
ibexa.siteaccess configuration key:
1 2 3 4 5 6 7 8 9 10 11 12 13
Uncomment the SiteAccess matcher (
1 2 3 4
ibexadesign defines templates for your sites, so add them before continuing.
Next, add the configuration for
ibexadesign on the same level as
1 2 3 4
Finally, configure designs for empty SiteAccess groups:
1 2 3 4 5 6
Add site template configuration¶
Add thumbnails and names for your site templates:
1 2 3 4 5 6 7 8 9 10
You can check the results of your work in the Back Office by going to the Site tab and selecting the List icon.
There, you should be able to add a new site and choose a design for it.
To be able to see your site online, you need to define a domain for it.
Define domain for production environment
These steps are for
dev environment only.
If you want to define domains in production environment, you will need to configure Apache or Nginx by yourself.
.env file change line 2 to:
Take a look into the
doc/docker/multihost.yml file. Here you can define domains.
To add a new domain, add it in
command: and under frontend and backend aliases as shown in the example below:
1 2 3 4 5 6 7 8 9 10 11 12 13 14
Next, you must define the domains in
0.0.0.0 site.example.com admin.example.com test.example.com www.admin.example.com
Your sites should be now visible under:
Define site directory¶
You can adjust the place where the directory of the new site is created (Location with ID 2 by default).
To do it, go to configuration files and under the
ibexa.system.<scope>.site_factory configuration key add the following parameter:
1 2 3 4 5
Now, all new directories are created under "Ibexa DXP".
The Site Factory is set up, now you can provide sufficient permissions to the Users.
Set the below Policies to allow Users to:
site/view- enter the Site Factory interface
site/create- create sites
site/edit- edit sites
site/change_status- change status of the public accesses to
site/delete- delete sites
For full documentation on how Permissions work and how to set them up, see the Permissions section.
To learn how to use Site Factory, see User documentation.
Disable Site Factory¶
Enabled Site Factory may cause following performance issues:
- ConfigResolver looks for SiteAccesses in the database
- Site Factory matchers are connected to the database in search for new SiteAccesses
You can disable Site Factory to boost ConfigResolver performance. Keep in mind that with disabled Site Factory you are unable to add new sites or use existing ones.
config/packages/ibexa.yaml comment the
ibexa.siteaccess.match: '@Ibexa\SiteFactory\SiteAccessMatcher': ~ if it is uncommented.
3. Remove separate connection to database in
1 2 3 4 5 6
4. Remove separate cache pool in
1 2 3 4 5 6
The Site Factory should be disabled.