This module contains the implementation of the Keepeek Content Picker for Jahia 8.1.x.x
With this module, a contributor can easily add a Keepeek media asset to a Jahia page.
If you want to be able to select media content from Jahia and Keepeek you can use the DAM Selector module.
Note: Only image and video are handled by this module
This module contains:
- The definition of a
Keepeek Asset Content Reference
content (definition.cnd). - A React application :
Keepeek Content Picker
(KeepeekPicker.jsx). This application is a custom jContent SelectorType (aka picker) and is used to pick a Keepeek asset. - A light implementation of an External Data Provider (EDP) named
Keepeek Asset Provider
(KeepeekDataSource.java).
Not covered in this module:
- CKEditor Keepeek media picker
The module can be installed in 2 ways, from the source or from the store.
- Download the zip archive of the latest release.
- If you already know your Keepeek configuration (API key, site, and host) you can update the default configuration about Keepeek. Update properties in the keepicker_credentials.cfg file.
- Go to the root of the repository.
- Run the
mvn clean install
command. This creates a jar file in the target repository.you must have a java sdk and maven installed
- In jContent, go to
Administration
panel. - In the
Server
section, expandModules and Extensions
and clickModules
. - From the right panel, click
SELECT MODULE
and select the jar file in the target repository. - Finally, click
UPLOAD
.
-
In jContent, navigate to
Administration
. -
In the
Server
section, expand theModules and Extensions
entry and clickModules
. -
From the right panel, click
Available modules
and search for keepeek. -
Click the install icon in the right of the package to download and install the module.
-
Wait until the module is loading.
If the module is properly deployed you should find it in the Installed modules
section.
If you have installed the module from the store or if you didn't configure the properties in the keepicker_credentials.cfg file before to build the module, you must do the post install to have the Keepeek provider starting.
Don't forget to enable the module for one of your project
Skip this section if you have already configured the keepicker_credentials.cfg file during the install from the source process. This configuration doesn't require a server restart.
To request the Keepeek server, you have to configure the module with your Keepeek API access information.
To set up your Keepeek API access:
-
Go to jahia tools (https://<jahia host>/tools).
-
From the tools UI, click
OSGI console
under Administration and Guidance. -
In the top menu expand the entry OSGI and click Configuration.
-
Look for
org.jahia.se.modules.keepicker_credentials.cfg
and click on it. -
Finally, update the appropriate properties and save your changes.
-
If all the properties are set correctly, the provider should start, and you should see the
keepeek
key in the list of External providers. -
Now, you should be able to create a new
Keepeek Content Reference
content or select Keepeek as a provider if you use DAM Selector.