Alfresco Source Code Walkthrough

[angelborroy]

Alfresco Content Service deployment includes several services in order to provide different features for the product.

Alfresco Content Service Deployment

This blog post describes how these services are deployed, packaged and built from source code.

Resources

• Alfresco Docker Images for deployment are available in https://hub.docker.com/u/alfresco
• ZIP Distribution files for deployment are (mainly) available in https://nexus.alfresco.com/nexus
• Packaged JAR libraries for the different modules are also available in https://nexus.alfresco.com/nexus
• Source Code is available in https://github.com/alfresco/

alfresco

This service is a WAR application deployed in Tomcat.

• Sample deployment for Docker Compose is available in https://github.com/Alfresco/acs-deployment/blob/master/docker-compose/community-docker-compose.yml
• Packaging for ZIP Distribution file and Docker Image is available in https://github.com/Alfresco/acs-community-packaging
• Source code is available in https://github.com/Alfresco/alfresco-community-repo

activemq

This service is an standard ActiveMQ with some customizations available in https://github.com/Alfresco/alfresco-docker-activemq

transform-misc

This Spring Boot service runs as a standalone application.

• Packaging for Docker Image is available in https://github.com/Alfresco/alfresco-transform-core/tree/master/alfresco-transform-misc/alfresco-tra...
• Source code is available in https://github.com/Alfresco/alfresco-transform-core/tree/master/alfresco-transform-misc/alfresco-tra...

alfresco-pdf-renderer

This Spring Boot service runs as a standalone application.

• Packaging for Docker Image is available in https://github.com/Alfresco/alfresco-transform-core/tree/master/alfresco-transform-pdf-renderer/alfr...
• Source code is available in https://github.com/Alfresco/alfresco-transform-core/tree/master/alfresco-transform-pdf-renderer/alfr...

imagemagick

This Spring Boot service runs as a standalone application.

• Packaging for Docker Image is available in https://github.com/Alfresco/alfresco-transform-core/tree/master/alfresco-transform-imagemagick/alfre...
• Source code is available in https://github.com/Alfresco/alfresco-transform-core/tree/master/alfresco-transform-imagemagick/alfre...

libreoffice

This Spring Boot service runs as a standalone application.

• Packaging for Docker Image is available in https://github.com/Alfresco/alfresco-transform-core/tree/master/alfresco-transform-libreoffice/alfre...
• Source code is available in https://github.com/Alfresco/alfresco-transform-core/tree/master/alfresco-transform-libreoffice/alfre...

tika

This Spring Boot service runs as a standalone application.

• Packaging for Docker Image is available in https://github.com/Alfresco/alfresco-transform-core/tree/master/alfresco-transform-tika/alfresco-tra...
• Source code is available in https://github.com/Alfresco/alfresco-transform-core/tree/master/alfresco-transform-tika/alfresco-tra...

solr6

This service is a WAR deployed in a Jetty server.

• Packaging for ZIP Distribution file and Docker Image is available in https://github.com/Alfresco/SearchServices/tree/master/search-services/packaging
• Source code is available in https://github.com/Alfresco/SearchServices

share

This service is a WAR deployed in Tomcat server.

• Packaging for ZIP Distribution file and Docker Image is available in https://github.com/Alfresco/share/tree/develop/packaging
• Source code is available in https://github.com/Alfresco/share/tree/develop/share

content-app

This service is an Angular app deployed on an NGINX or Apache Httpd server

• Packaging for ZIP Distribution file and Docker Image is available in https://github.com/Alfresco/alfresco-content-app/tree/develop/docker
• Source code is available in https://github.com/Alfresco/alfresco-content-app

proxy

This service is a customized NGINX server with some customizations available in https://github.com/Alfresco/acs-ingress/tree/acs-community-ingress

Building Alfresco from Source Code

In order to build the projects, following software needs to be installed in your computer:

• Java 11
• Maven 3
• Docker (only to build Docker Images)
• Node.js (only for content-app)

Every service is built from source code, packaged and published to Docker Hub as Docker Image or to Nexus Repository as ZIP Distribution file. Every GitHub project includes instructions on how to perform these operations.

Let's take SearchServices project as sample in order to build this service from source code.

Step 1: Clone the source code from GitHub

$ git clone https://github.com/Alfresco/SearchServices.git

Step 2: Build the Maven Project

$ cd SearchServices/search-services
$ mvn clean package -DskipTests

Step 3: ZIP Distribution file is produced by this Maven build in the following path

packaging/target/alfresco-search-services-2.1.0-SNAPSHOT.zip

Step 4: Docker Image can be built from packaging folder

$ cd packaging/target/docker-resources
$ docker build . -t searchservices:local
...
Successfully built a656068d4ec3
Successfully tagged searchservices:local

In case you want to build an specific version instead of master branch, just checkout the version tag (2.0.1 in the sample below) after cloning the project from GitHub.

$ git checkout 2.0.1