Installation

Supported Alfresco versions

Currently Alfred API supports the following Alfresco versions:

  • 23.1
  • 23.2
  • 23.3
  • 23.4
  • 25.1

Alfred API depends on the Alfresco MVC framework version 9.0.0. Installation depends on the tools that you use to build and install, but below are examples of a few common ways. Further details can be found on its README.

(Note that previous versions of Alfred API needed Dynamic Extensions For Alfresco. Since version 5.0.0, however, Dynamic Extensions is no longer needed.)

Install with Gradle

An example when using Gradle and the Alfresco Docker Gradle plugin is:

alfrescoSM group: 'com.gradecak.alfresco-mvc', name: 'alfresco-mvc-rest', version: '9.0.0'
alfrescoSM group: 'com.gradecak.alfresco-mvc', name: 'alfresco-mvc-aop', version: '9.0.0'
alfrescoAmp group: 'eu.xenit.alfred.api', name: 'alfred-api-231', version: '6.0.0'

Note above example also installs Alfred API as AMP.

Install manually

If you install your Alfresco manually, you can download the JARs directly from Maven Central and place them on your Tomcat’s classpath.

cp alfresco-mvc-aop-9.0.0.jar /usr/local/tomcat/shared/lib/
cp alfresco-mvc-rest-9.0.0.jar /usr/local/tomcat/shared/lib/

Artifacts

Prebuilt

Artifacts can be freely obtained through Maven Central. The application is available as an Alfresco AMP artifact, which is the preferred distribution for production environments.

To install the AMP, follow the Alfresco AMP installation guidelines your version of Alfresco: