Skip to main content

Customizing Alfresco Deployments

Customizing Alfresco: how to

In our last post, we talked about how to install and configure Alfresco on an AWS instance. We also learned how to create a simple site and upload documents. But customizing Alfresco can greatly widen your administration and accessibility options, and take you way beyond simple document sharing.

In this post, we will discover how to perform an unattended installation, how to integrate Amazon S3 content storage, and how to access Alfresco-based content using mobile apps and desktop clients.

Unattended Installations

Alfresco Community and Enterprise editions can be installed using Bitrock technology. This helps automate the installation process, allowing for scripted deployments. As a part of the unattended installation procedure, we can either pass command line arguments directly to the Alfresco installer or create an options file with all our requirements. The options file is, in turn, passed along to the installer, allowing us to enable or disable components or specify DB names, users or passwords.

Any setting which is available through your GUI or command line interfaces is also available through an option file. To fetch a list of all available options, pass the –help argument to the installer:

# sudo ./alfresco-community-5.0.c-installer-linux-x64.bin --help

Here’s a sample option file:

mode=unattended
components=javaalfresco,alfrescosharepoint,alfrescowcmqs,libreofficecomponent
disable-components=postgres
# Use JDBC settings for an existing database
jdbc_url=jdbc:postgresql://localhost/alfresco
jdbc_driver=org.postgresql.Driver
jdbc_database=alfresco
jdbc_username=alfresco
jdbc_password=alfresco
# Install location
prefix=/opt/alfresco
# Set Alfresco Administrator Password
alfresco_admin_password=admin123
# Install init scripts
baseunixservice_install_as_service=1

This option file can be saved with any name – say, “option_file” – and can be passed as a command line argument to Alfresco installer.

# sudo ./alfresco-community-5.0.c-installer-linux-x64.bin --optionfile option_file

Customizing Alfresco with Amazon S3 Connector

Alfresco offers multiple modules to help us integrate with other services. Alfresco’s Amazon S3 Connector module, for instance, allows us to store all uploaded documents in an Amazon S3 bucket, providing storage that’s highly durable and far less expensive than using an Amazon EBS volume. It also helps us to decouple storage from our Alfresco share, simplifying horizontal scaling.

According to Alfresco’s documentation:

”Using an Alfresco Module Package, the connector supplies a new content store which replaces the default file system-based implementation for the standard and deleted content stores. The content store implementation is responsible for reading and writing content streams using the S3 API, however, in order to improve performance a local Caching Content Store is used which uses the local disk to cache recently-used content items.”

To install the Amazon S3 Connector, you’ll need to download the module from their Documentation page. Once downloaded, follow these configuration steps:

Step 1: Move the downloaded AMP (Alfresco Module Package) file to the /opt/alfresco/amps folder.

# cp alfresco-s3-connector.amp /opt/alfresco/amps/

Step 2: Go to the /opt/alfresco/bin folder and locate the file apply_amps.sh.
Step 3: Execute apply_amps.sh (you might need to set the file as executable first: chmod +x apply_amps.sh):

# ./apply_amps.sh

This will install the S3 connector module.
Step 4: Once this is done, we’ll need to verify that the module was successfully installed:

# java -jar alfresco-mmt.jar list /opt/alfresco/tomcat/webapps/alfresco.war

Step 5: Now, add the following three lines of integration details to the alfresco-global.properties file (/opt/alfresco/tomcat/shared/classes/alfresco-global.properties)

### S3 Connector Details ###
s3.accessKey=<your-access-key>
s3.secretKey=<your-secret-access-key>
s3.bucketName=<S3-Bucket-Name>

Note: configuration might require single you to enclose your keys in either single or double quotes.
That’s it. Amazon S3 Connector for Alfresco is now configured and ready for use. Once we upload content to our Alfresco share, all content will be saved into our S3 Bucket.

Customizing Alfresco: Mobile Apps and Addons

Alfresco offers iOS and Android mobile apps for accessing our Alfresco share. These apps are very helpful when we want to quickly review a document and pass along feedback.

Apart from Alfresco mobile apps, Alfresco also offers addons, a place to find customizations, extensions and related projects for your Alfresco installations. Alfresco Desktop sync is a desktop client that allows us to sync all our Alfresco documents directly to our local system. Think of this as similar to Dropbox or Google Drive desktop clients. Alfresco Desktop Clients are supported on Windows and OS X operating systems.

Windows Easy Sync – Desktop Synchronization for Alfresco is another addon that acts as an embedded Alfresco Explorer for browsing the repository contents. Users can view, download, create, edit, move, or delete Alfresco documents or spaces directly on the server. The “Edit with WebDav” feature allows online editing of Alfresco contents with local client editors.

The possible options for customizing Alfresco through available integrations/add-ons/modules make for a very powerful enterprise content management system, allowing us to easily collaborate with a higher degree of control. In future blog posts, we will learn more about Alfresco’s internal workings.

Written by

Sanket Dangi

Head of Managed Services at REAN Cloud. Before joining REAN Cloud, I was CEO and Founder of StraightArc Solutions which was later acquired by REAN Cloud.I started my career working on cloud computing. Loves to talk about DevOps, System Administration, Scalability, High Availability, Disaster Recovery and Cloud Security. Apart from work, I love to meet people, travel and watch sports.

Related Posts

Joe Nemer
Joe Nemer
— April 1, 2019

AWS EC2 Instance Types Explained

Amazon Web Services’ resource offerings are constantly changing, and staying on top of their evolution can be a challenge. Elastic Cloud Compute (EC2) instances are one of their core resource offerings, and they form the backbone of most cloud deployments. EC2 instances provide you with...

Read more
  • AWS
  • EC2
Sanket Dangi
— February 11, 2019

WaitCondition Controls the Pace of AWS CloudFormation Templates

AWS's WaitCondition can be used with CloudFormation templates to ensure required resources are running.As you may already be aware, AWS CloudFormation is used for infrastructure automation by allowing you to write JSON templates to automatically install, configure, and bootstrap your ...

Read more
  • AWS
  • formation
Andrew Larkin
— January 24, 2019

The 9 AWS Certifications: Which is Right for You and Your Team?

As companies increasingly shift workloads to the public cloud, cloud computing has moved from a nice-to-have to a core competency in the enterprise. This shift requires a new set of skills to design, deploy, and manage applications in cloud computing.As the market leader and most ma...

Read more
  • AWS
  • AWS certifications
Andrew Larkin
— November 28, 2018

Two New EC2 Instance Types Announced at AWS re:Invent 2018 – Monday Night Live

The announcements at re:Invent just keep on coming! Let’s look at what benefits these two new EC2 instance types offer and how these two new instances could be of benefit to you. If you're not too familiar with Amazon EC2, you might want to familiarize yourself by creating your first Am...

Read more
  • AWS
  • EC2
  • re:Invent 2018
Guy Hummel
— November 21, 2018

Google Cloud Certification: Preparation and Prerequisites

Google Cloud Platform (GCP) has evolved from being a niche player to a serious competitor to Amazon Web Services and Microsoft Azure. In 2018, research firm Gartner placed Google in the Leaders quadrant in its Magic Quadrant for Cloud Infrastructure as a Service for the first time. In t...

Read more
  • AWS
  • Azure
  • Google Cloud
Khash Nakhostin
Khash Nakhostin
— November 13, 2018

Understanding AWS VPC Egress Filtering Methods

In order to understand AWS VPC egress filtering methods, you first need to understand that security on AWS is governed by a shared responsibility model where both vendor and subscriber have various operational responsibilities. AWS assumes responsibility for the underlying infrastructur...

Read more
  • Aviatrix
  • AWS
  • VPC
Jeremy Cook
— November 10, 2018

S3 FTP: Build a Reliable and Inexpensive FTP Server Using Amazon’s S3

Is it possible to create an S3 FTP file backup/transfer solution, minimizing associated file storage and capacity planning administration headache?FTP (File Transfer Protocol) is a fast and convenient way to transfer large files over the Internet. You might, at some point, have conf...

Read more
  • Amazon S3
  • AWS
Guy Hummel
— October 18, 2018

Microservices Architecture: Advantages and Drawbacks

Microservices are a way of breaking large software projects into loosely coupled modules, which communicate with each other through simple Application Programming Interfaces (APIs).Microservices have become increasingly popular over the past few years. The modular architectural style,...

Read more
  • AWS
  • Microservices
Stuart Scott
— October 2, 2018

What Are Best Practices for Tagging AWS Resources?

There are many use cases for tags, but what are the best practices for tagging AWS resources? In order for your organization to effectively manage resources (and your monthly AWS bill), you need to implement and adopt a thoughtful tagging strategy that makes sense for your business. The...

Read more
  • AWS
  • cost optimization
Stuart Scott
— September 26, 2018

How to Optimize Amazon S3 Performance

Amazon S3 is the most common storage options for many organizations, being object storage it is used for a wide variety of data types, from the smallest objects to huge datasets. All in all, Amazon S3 is a great service to store a wide scope of data types in a highly available and resil...

Read more
  • Amazon S3
  • AWS
Cloud Academy Team
— September 18, 2018

How to Optimize Cloud Costs with Spot Instances: New on Cloud Academy

One of the main promises of cloud computing is access to nearly endless capacity. However, it doesn’t come cheap. With the introduction of Spot Instances for Amazon Web Services’ Elastic Compute Cloud (AWS EC2) in 2009, spot instances have been a way for major cloud providers to sell sp...

Read more
  • AWS
  • Azure
  • Google Cloud
  • SpotInst
Guy Hummel and Jeremy Cook
— August 23, 2018

What are the Benefits of Machine Learning in the Cloud?

A Comparison of Machine Learning Services on AWS, Azure, and Google CloudArtificial intelligence and machine learning are steadily making their way into enterprise applications in areas such as customer support, fraud detection, and business intelligence. There is every reason to beli...

Read more
  • AWS
  • Azure
  • Google Cloud
  • Machine Learning