Siteaccesses: site and admin #

This page is for developers who configure what a request sees. A siteaccess is a named configuration that the DXP selects for each request: which design, which languages, which part of the content tree, which settings. The idea is the same as the siteaccess of Exponential 6, expressed in YAML.

Contents #

1. The two siteaccesses you start with
2. How settings are resolved
3. Where the configuration lives
4. Adding a site or a language
5. Checking a value

The two siteaccesses you start with #

Source: skeleton guide, section 2. The administration bundle expects its siteaccesses in the group named by admin_group_name (admin_group by default).

How settings are resolved #

Settings under ibexa.system are read in this order, the later winning: default, the siteaccess group, the siteaccess itself, and global. The comment in an installed config/packages/ibexa.yaml says so, and adds the tip: "For multisite installations organize shared config into SiteAccess groups, on single-site you can place shared config under default".

ibexa:
    system:
        default:            # every siteaccess
            content:
                default_ttl: '%httpcache_default_ttl%'
        site_group:         # every siteaccess of the group
            image_variations: { }
        site:               # only this siteaccess
            languages: [eng-GB]

Where the configuration lives #

The recipes write these files under config/packages/; a project may keep them in other YAML files that the kernel imports. Search for them with grep -rn "siteaccess:" config/.

Adding a site or a language #

1. Add the new siteaccess to ibexa.siteaccess.list and to a group (a new site2_group, or the existing site group).
2. Add a matcher under ibexa.siteaccess.match (by host, by URI element, or another matcher the core offers).
3. Give it its scope under ibexa.system: languages, the tree root, the design.
4. Clear the cache and check the value (below).

Add administration siteaccesses only to the admin group, never the public ones.

Checking a value #

php bin/console exponential:debug:config-resolver languages --siteaccess=site
php bin/console exponential:debug:config-resolver design --siteaccess=admin
php bin/console debug:config ibexa siteaccess

exponential:debug:config-resolver (alias ibexa:debug:config-resolver) shows the value a siteaccess resolves (Console commands).

Related pages #

• The admin UI
• Siteaccess settings in Exponential 6, for comparison
• Coming from Exponential 6
• Free documentation: this page is free to copy, translate and improve under the GNU FDL 1.3.