Bridge
The bridge is optional library that can be included to use Berlioz in tandem with PageSeeder. You can configure the Bridge using the Berlioz settings to specify which PageSeeder instance to connect to and how users can authenticate.
Properties summary
| Property | Default | Description |
|---|---|---|
bridge.authenticator.name | "pageseeder" | The type of authenticator (only "pageseeder is supported) |
bridge.authenticator.member-of | null | The list of groups or projects a PageSeeder user must be a member of to successfully authenticate to the application |
bridge.api-url | "http://localhost:8282" | URL to connect to the PageSeeder API |
bridge.api.scheme | bridge.scheme | Scheme, host and port values when the api-url property is not specified. |
bridge.api.host | bridge.host | |
bridge.api.port | bridge.port | |
bridge.uri-url | "http://localhost:8080" | URL to connect to PageSeeder |
bridge.uri.scheme | bridge.scheme | Scheme, host and port values when the uri-url property is not specified. |
bridge.uri.host | bridge.host | |
bridge.uri.port | bridge.port | |
bridge.siteprefix | "/ps" | The PageSeeder site prefix |
bridge.scheme | "http" | The fallback values for the scheme, host of port values. |
bridge.host | "localhost" | |
bridge.port | "8080" or "8282" | |
pageseeder.session.timeout | 60 | The timeout in minutes of PageSeeder sessions |
Deprecation warning!
The bridge.uri-url and bridge.uri.* properties are confusing and likely to be deprecated in the future and should not be used.
Default configuration
The default configuration is the equivalent of
<bridge api-url="http://localhost:8282"
uri-url="http://localhost:8080"
siteprefix="/ps">
<authenticator name="pageseeder"/>
</bridge>
<pageseeder>
<session timeout="60"/>
</pageseeder>
Properties reference
Property bridge.authenticator.name
The authenticator controls how user can be authenticated on your Berlioz application using PageSeeder. At present, the bridge only provides the "pageseeder" authenticator, so if specified this property should be set to "pageseeder"
Property bridge.authenticator.member-of
By default, the authenticator will accept any user who is a PageSeeder member that is if it has a login and password on PageSeeder.
However, it is possible to restrict the groups that users need to be members of in order to authenticate to a Berlioz application. This property defines a comma-separated list of projects or groups that a member needs to belong to in order to authenticate.
It is possible to use wildcards in place of group names.
In the example below, any user who is a member of a PageSeeder group under the 'dev' or 'management' projects will be able to authenticate.
<bridge> <authenticator member-of="dev-*,management-*"/> </bridge>
Property bridge.api-url
This property defines the base URL of the PageSeeder API to connect to.
On a typical setup, the Berlioz application is located on the same server as PageSeeder so communications can occur on a non-secure scheme (http) on localhost using the default API port (8282).
So the default is:
<bridge api-url="http://localhost:8282"/>
There is no need to define this property unless:
- The PageSeeder instance to connect to is on a remote host
- The PageSeeder instance does not use the default API scheme or port
- The
bridge.scheme,bridge.hostandbridge.portproperties have been defined and would result in the wrong API URL
Properties bridge.api.*
The API scheme, host and port values can be specified individually. However it is generally clearer to specify the full URL using the bridge.api-url property.
The bridge.api-url property overrides the bridge.api.scheme, bridge.api.host and bridge.api.port values.
The configurations below are equivalent
<bridge api-url="http://localhost:8282"/>
<bridge> <api scheme="http" host="localhost" port="8282"/> </bridge>
Property bridge.uri-url
This property defines the base URL of PageSeeder for end-users.
Deprecation warning!
This property is potentially confusing and should not be used.
Properties bridge.uri.*
These properties define sheme, host and port of PageSeeder URLs for end-users.
Deprecation warning!
These properties are potentially confusing and should not be used.
Property bridge.siteprefix
This property can be used to customize the siteprefix where PageSeeder is installed. It is rarely necessary to set a different property.
The default is equivalent to:
<bridge siteprefix="/ps"/>
Properties bridge.scheme, bridge.host, bridge.port
These properties define the fallback values of the sheme, host and port of PageSeeder.
Deprecation warning!
These properties are potentially confusing and should not be used.
Property pageseeder.session.timeout
By defaullt PageSeeder sessions last for 60 minutes, this property can be used in cases when PageSeeder has been configured to use a different timeout value.
The default is equivalent to:
<pageseeder> <session timeout="60"/> </pageseeder>
Created on , last edited on