/alfresco-transform-core

Primary LanguageJavaGNU Lesser General Public License v3.0LGPL-3.0

Alfresco Transform Core

Build Status

Contains the common transformer (T-Engine) code, plus a few actual implementations.

Sub-projects

  • alfresco-transformer-base - library packaged as a jar file which contains code that is common to all the transformers; see the sub-project's README
  • alfresco-docker-<name> - multiple T-Engines; each one of them builds both a SpringBoot fat jar and a Docker image

Documentation

In addition to the sub-projects (such as alfresco-transformer-base README above) some additional documentation can be found in:

Note: if you're interested in the Alfresco Transform Service (ATS) that is part of the enterprise Alfresco Content Services (ACS) please see:

Building and testing

The project can be built by running the Maven command:

mvn clean install -Plocal,docker-it-setup

The local Maven profile builds local Docker images for each T-Engine.

Artifacts

Maven

The artifacts can be obtained by:

  • downloading from Alfresco repository
  • getting as Maven dependency by adding the dependency to your pom file:
<dependency>
    <groupId>org.alfresco</groupId>
    <artifactId>alfresco-transformer-base</artifactId>
    <version>version</version>
</dependency>

and Alfresco Maven repository:

<repository>
  <id>alfresco-maven-repo</id>
  <url>https://artifacts.alfresco.com/nexus/content/groups/public</url>
</repository>

Docker

The core T-Engine images are available on Docker Hub:

Release Process

For a complete walk-through check out the build-and-release.MD under the docs folder.

Contributing guide

Please use this guide to make a contribution to the project.