Giter Club home page Giter Club logo

keepicker's Introduction

keepicker

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

Module content

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

Quick Start

Deploy the module

The module can be installed in 2 ways, from the source or from the store.

From the source

  1. Download the zip archive of the latest release.
  2. 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.
  3. Go to the root of the repository.
  4. Run the mvn clean install command. This creates a jar file in the target repository.

    you must have a java sdk and maven installed

  5. In jContent, go to Administration panel.
  6. In the Server section, expand Modules and Extensions and click Modules.
  7. From the right panel, click SELECT MODULE and select the jar file in the target repository.
  8. Finally, click UPLOAD.

From the store

  1. In jContent, navigate to Administration.

  2. In the Server section, expand the Modules and Extensions entry and click Modules.

  3. From the right panel, click Available modules and search for keepeek.

  4. Click the install icon 201 in the right of the package to download and install the module.

  5. Wait until the module is loading.

Check install

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

Post Install (optional)

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:

  1. Go to jahia tools (https://<jahia host>/tools).

  2. From the tools UI, click OSGI console under Administration and Guidance.

  3. In the top menu expand the entry OSGI and click Configuration.

  4. Look for org.jahia.se.modules.keepicker_credentials.cfg and click on it.

  5. Finally, update the appropriate properties and save your changes.

  6. If all the properties are set correctly, the provider should start, and you should see the keepeek key in the list of External providers.

  7. Now, you should be able to create a new Keepeek Content Reference content or select Keepeek as a provider if you use DAM Selector.

keepicker's People

Contributors

hduchesne avatar jahia-ci avatar janin-michel-mathias avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.