Skip to content

AEM

Installation on AEM

Manual

  1. Download the package from the releases page
  2. Install the package via the AEM package manager
  3. Configure the endpoint to you Ethereal Nexus Dashboard.
  4. Assign your configuration to a sites project.

Adding to your Codebase

* On your AEM Project (Preferred)

  1. Add the github repository
<repositories>
  <repository>
    <id>ethereal-nexus</id>
    <name>GitHub Ethereal Nexus</name>
    <url>https://maven.pkg.github.com/diconium/ethereal-nexus</url>
  </repository>
</repositories>
  1. Add the Maven dependency to you AEM project on module: all file: pom.xml
<dependency>
  <groupId>com.diconium</groupId>
  <artifactId>ethereal-nexus.all</artifactId>
  <version>1.2.16</version>
  <type>zip</type>
</dependency>
  1. Add the Embedded vault package definition on module: all file: pom.xml
<embedded>
    <groupId>com.diconium</groupId>
    <artifactId>ethereal-nexus.all</artifactId>
    <type>zip</type>
    <target>/apps/REPLACE_WITH_YOUR_CUSTOM_NAME-vendor-packages/remote-components/install</target>
</embedded>
  1. Configure the endpoint to you Ethereal Nexus Dashboard.
  2. Assign your configuration to a sites project.

Configuration

You need to configure the AEM instances to recognize and interact with the Ethereal Nexus connector. Steps to Configure Ethereal Nexus in AEM

Steps to Configure Ethereal Nexus in AEM

1. Configure Ethereal Nexus in Cloud Services

  1. In AEM, navigate to Tools > Cloud Services > Legacy Cloud Services.
  2. Under Third Party Services, select Ethereal Nexus Configuration.
  3. Add a new configuration for each environment you want to connect to.
  4. Fill in the details for All Components Configuration (this will be used in template policies).

2. Set Permissions for the Service User

  1. Navigate to Tools > Security > Permissions.
  2. Find the user remote-components-resolver and click Add ACE.
  3. Under Path, enter /content and select the permissions you want to assign.
  4. Under Privileges, select jcr:read.
  5. Click Add to save the changes.

3. Assign the Configuration to Your Site

  1. In AEM, go to Sites and select your site (/content/your-site).
  2. Open Page Properties for your site.
  3. Under Cloud Services Configurations, select the Ethereal Nexus configuration you created previously.

Configure OAuth

ℹ️ Info: This requires configuration on Ethereal Nexus dashboard. For more details, refer to the Access Management documentation.

Requirements:
  • ServerUrl
  • Realm
  • Client ID
  • Client Secret
  • Subject

1. Update the pom.xml to include the auth bundle:

  1. Add the embedded vault package definition on module: all file: pom.xml
<embedded>
    <groupId>com.diconium</groupId>
    <artifactId>ethereal-nexus-bundle-auth</artifactId>
    <target>/apps/REPLACE_WITH_YOUR_CUSTOM_NAME-vendor-packages/remote-components/install</target>
    <type>jar</type>
</embedded>
  1. Under Dependencies, add the following Maven dependency:
<dependency>
    <groupId>com.diconium</groupId>
    <artifactId>ethereal-nexus-bundle-auth</artifactId>
    <version>8.3.11</version>
</dependency>

2. Create the OSGI configuration :

  1. Crete a Osgi configuration for Persistent Identity (PID): com.diconium.keycloak.services.OAuthService
  • serverUrl: https://your-keycloak-server
  • realm: your-realm
  • clientId: your-client-id
  • clientSecret: your-client-secret
  • cacheDuration: 300
  • sslRequired: true
  1. Click Save.

3. Update or create a new Ethereal Nexus configuration in the Cloud Services

  1. Navigate to Tools > Cloud Services > Legacy Cloud Services
  2. update or create a new Ethereal Nexus configuration.
  • Ensure the Authentication Type is set to Bearer.

4. Assign the Configuration to Your Site

  1. In AEM, go to Sites and select your site (/content/your-site).
  2. Open Page Properties for your site.
  3. Under Cloud Services Configurations, select the Ethereal Nexus configuration you created previously.