[go: up one dir, main page]

0% found this document useful (0 votes)
184 views46 pages

Alfresco 5.2 Step-By-Step Installation Guide

The installation guide for the Konecranes Alfresco Archiving Platform outlines the steps necessary for setting up the system, including various installation topologies such as trial, departmental, standard cluster, and enterprise cluster. It provides a high-level overview of the installation process, prerequisites, and detailed instructions for installing components like Alfresco, Solr, and Apache web server. Additionally, the guide addresses configuration for load balancing, installed modules, and troubleshooting common issues.

Uploaded by

rajeshjha9_8
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
184 views46 pages

Alfresco 5.2 Step-By-Step Installation Guide

The installation guide for the Konecranes Alfresco Archiving Platform outlines the steps necessary for setting up the system, including various installation topologies such as trial, departmental, standard cluster, and enterprise cluster. It provides a high-level overview of the installation process, prerequisites, and detailed instructions for installing components like Alfresco, Solr, and Apache web server. Additionally, the guide addresses configuration for load balancing, installed modules, and troubleshooting common issues.

Uploaded by

rajeshjha9_8
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
You are on page 1/ 46

Installation Guide

1.0
Enterprise Content Management Confidential
2018-03-02

Konecranes Alfresco Archiving


Platform

_______________ page 1/46

© Tieto Corporation Konecranes Alfresco Archiving Platform


Installation Guide

1.0
Enterprise Content Management Confidential
2018-03-02

Table of contents
1 Installation Topologies...................................................................................5
1.1 Trial............................................................................................................. 5
1.2 Departmental...............................................................................................6
1.3 Standard cluster..........................................................................................6
1.4 Enterprise cluster........................................................................................7

2 High Level Installation Overview...................................................................8


2.1 Flowchart.....................................................................................................8
2.2 Automate installation process.....................................................................9

3 Prerequisites................................................................................................. 10
3.1 Validate architecture.................................................................................10
3.2 Separate JDK............................................................................................10
3.3 Setup environment variables.....................................................................11
3.4 Fix missing libraries...................................................................................11
3.4.1 LibreOffice libraries...........................................................................11
3.4.2 Solr6 libraries....................................................................................11
3.4.3 Other libraries...................................................................................11
3.5 Fix rights for mounted drives.....................................................................12

4 Platform, Share, Solr6 All-in-One (DEV)......................................................13


4.1 Install Alfresco in text mode......................................................................13
4.2 Install Solr6............................................................................................... 18
4.3 Adjust alfresco-global.properties...............................................................19
4.4 Create symlink for current version.............................................................20
4.5 Install Alfresco Governance Services........................................................20
4.6 Logs under /var/log................................................................................... 21
4.7 Install Httpd (Apache web server).............................................................21
4.8 Configure Httpd (Apache web server).......................................................22
4.9 Configure JMX.......................................................................................... 22
4.10 Java options for Alfresco and Solr...........................................................23
4.11 Document Transformation Engine (ECM only)........................................23

5 Deploy Templates (QA, PROD)....................................................................25


5.1 Alfresco template...................................................................................... 25
5.2 Alfresco tracking template.........................................................................25
5.3 Solr template.............................................................................................26

6 Configuration for loadbalancer....................................................................28


6.1 Apache httpd configuration........................................................................28
6.2 CMIS URL override in alfresco-global.properties......................................28
6.3 AOS URL override in alfresco-global.properties.......................................28
6.4 CSRF configuration for Alfresco................................................................28

_______________ page 2/46

© Tieto Corporation Konecranes Alfresco Archiving Platform


Installation Guide

1.0
Enterprise Content Management Confidential
2018-03-02

6.5 CSRF configuration for Share...................................................................28

7 Installed Modules and Connectors..............................................................30


7.1 JavaScript console....................................................................................30
7.2 Alfresco MetaDBConnector (MDBC).........................................................30
7.3 Connexas..................................................................................................30
7.4 Document transformation server...............................................................31

8 Create Alfresco and Solr Services...............................................................32


8.1 Alfresco service.........................................................................................32
8.2 Solr service............................................................................................... 32
8.3 Httpd service.............................................................................................32

9 Clustering...................................................................................................... 34
9.1 Alfresco clustering.....................................................................................34
9.2 Share clustering........................................................................................34

10 Install Content Store...................................................................................35


10.1 Configuration...........................................................................................35
10.2 Mounted drives visibility..........................................................................35

11 Install Alfresco License..............................................................................36


11.1 Upload license to ALFRESCO_HOME....................................................36
11.2 JMX using Alfresco Admin console.........................................................36

12 Start/Stop Alfresco and Solr......................................................................37


12.1 Start Alfresco...........................................................................................37
12.2 Stop Alfresco...........................................................................................37
12.3 Start Solr................................................................................................. 37
12.4 Stop Solr................................................................................................. 37

13 Know issues................................................................................................38
13.1 AOS - Issue with protected view (Office 2016 for Windows)...................38

14 Additional Information................................................................................39
14.1 Installers..................................................................................................39
14.2 Environment HOME................................................................................39
14.3 Alfresco service code..............................................................................39
14.4 Solr service code.....................................................................................40

15 Change History............................................................................................42

_______________ page 3/46

© Tieto Corporation Konecranes Alfresco Archiving Platform


Installation Guide

1.0
Enterprise Content Management Confidential
2018-03-02

_______________ page 4/46

© Tieto Corporation Konecranes Alfresco Archiving Platform


Installation Guide

1.0
Enterprise Content Management Confidential
2018-03-02

Copyright notice
You may not reproduce the content of this document or any portion thereof
outside your organization without prior written consent from Tieto. All rights
related to this service description and service shall belong to Tieto or a third
party. This document and the content thereof as well as the characteristics of
the service are under continuous development. Tieto may, in its sole discretion,
make changes and/or amendments to them. Any material changes shall be
subject to discussions with the Customer in accordance with an applicable
agreement.
This installation guide describes major steps on setting up
Konecranes archiving system which is based on Alfresco Digital
Business Platform version 5.2. The guide covers all environments
including DEV, QA and PRO.

1 Installation Topologies

There are several options what type of installation to choose from


topology point of view. Trial and Departmental are basic ones not
intended for production environment where more concurrent users
are accessing alfresco in the same time. For such an environment,
a cluster topology needs to be enabled.

1.1 Trial

In a trial installation, you can put everything on one server. This is


not recommended for any production install setting.

Note: This mode is not used in Konecranes archiving platform.

_______________ page 5/46

© Tieto Corporation Konecranes Alfresco Archiving Platform


Installation Guide

1.0
Enterprise Content Management Confidential
2018-03-02

1.2 Departmental

Repository, Share, Solr and analytics are installed on a single


server. Server’s local filesystem is utilized as Alfresco content store.
Database is installed in a separated server.

Note: Konecranes archiving platform DEV environment is set up


using this mode.

1.3 Standard cluster

This is standard topology for Alfresco One installation, in which


Share is used as UI accessing to Alfresco repository.
Communication between Alfresco and Share is quicker because it’s
happening on the same server instance. In case there is bigger
traffic on Alfresco because of presence of different UIs or accessing
mostly from Alfresco from 3rd party applications, then enterprise
cluster described in chapter 1.4 is better solution.

_______________ page 6/46

© Tieto Corporation Konecranes Alfresco Archiving Platform


Installation Guide

1.0
Enterprise Content Management Confidential
2018-03-02

In standard cluster installation:


 Multiple virtual servers are used in which each contains a
repository and Share pair on the same Tomcat instance
 Separate Solr virtual server
 Separate database server
 Separate filesystem content store server, mounted via NFS
(*nix) or CIFS (Windows)
 Separate transformation virtual server
 Separate analytics virtual server

Note: Konecranes archiving platform QA and PRO environments


are set up using this mode.

1.4 Enterprise cluster

In standard cluster installation:


a) Multiple virtual servers with repository only (clustered)
b) Multiple virtual servers with Share only (clustered)
c) Separate transformation virtual server
d) Separate analytics virtual server
e) Separate Solr virtual server
f) Separate database server
g) Separate content store server, in each supported flavour
(filesystem, S3)

Note: This mode is not used in Konecranes archiving platform.

_______________ page 7/46

© Tieto Corporation Konecranes Alfresco Archiving Platform


Installation Guide

1.0
Enterprise Content Management Confidential
2018-03-02

2 High Level Installation Overview

2.1 Flowchart

Picture below shows high-level flowchart of Alfresco installation. In a


clustered environment, installation is performed on one server first,
then verified and optimized. The same installation steps are
performed for the next server. Those could be added back to cluster
afterwards.

It fits for all Alfresco server types:


 Repository
 Share
 Solr (including Tracking server)

Recommended Alfresco installation steps are illustrated in the


diagram below.

_______________ page 8/46

© Tieto Corporation Konecranes Alfresco Archiving Platform


Installation Guide

1.0
Enterprise Content Management Confidential
2018-03-02

2.2 Automate installation process

To automate the installation process and customize it for your


environment, you can run the install wizard in an unattended mode
and provide an option file.

The available options can be listed by calling the installer


executable on the command line and passing it the --help flag. Full
list can be checked in chapter 12.1.

You can pass an option file called “install_opts” to the installer using
a command, for example:

For Unix:
sudo ./alfresco-content-services-installer-5.2.2-
linux-x64.bin --optionfile install_opts

_______________ page 9/46

© Tieto Corporation Konecranes Alfresco Archiving Platform


Installation Guide

1.0
Enterprise Content Management Confidential
2018-03-02

3 Prerequisites

3.1 Validate architecture

Currently, Red Hat Enterprise Linux Server release 7.4 is not


supported by Alfresco. Supported operating systems are listed
below:

3.2 Separate JDK

It is good practice to use separated JDK for Solr. In addition, you


can use JDK utilities such as jstack, jconsole or jstat:

 Download 64-bit JDK from Oracle webpage


 Create /opt/jdk and extract tar file
o tar xvzf jdk-8u192-linux-x64.tar.gz
 Change rights to 750 for /opt/jdk

_______________ page 10/46

© Tieto Corporation Konecranes Alfresco Archiving Platform


Installation Guide

1.0
Enterprise Content Management Confidential
2018-03-02

 Create symlink in order to refer to current version

_______________ page 11/46

© Tieto Corporation Konecranes Alfresco Archiving Platform


Installation Guide

1.0
Enterprise Content Management Confidential
2018-03-02

3.3 Setup environment variables

Add JAVA_HOME and java install to PATH. Use a new JDK


installed in previous chapter.

Change file /home/alfresco/.bash_profile

3.4 Fix missing libraries

There are many important libraries which should be installed. Sudo


rights are required.

Yum not working due to missing DNS server. I had to update following
file with correct DNS server.
/etc/resolv.conf

sudo useradd -m alfresco

mkdir /opt/alfresco
mkdir /opt/solr
mkdir /opt/java

chown alfresco:alfresco /opt/alfresco


chown alfresco:alfresco /opt/solr
chown alfresco:alfresco /opt/java

chmod 750 /opt/alfresco


chmod 750 /opt/solr
chmod 750 /opt/java

3.4.1 LibreOffice libraries

If you install Alfresco to default RHEL 7.4, you will receive an error
“Some or all of the libraries needed to support

_______________ page 12/46

© Tieto Corporation Konecranes Alfresco Archiving Platform


Installation Guide

1.0
Enterprise Content Management Confidential
2018-03-02

LibreOffice were not found on your system”. You need to


install the missing libraries using below command as root:

# yum install fontconfig libSM libICE libXrender


libXext libcups libGLU libcairo2 cups-libs libgl1-
mesa-glx libcairo*

3.4.2 Solr6 libraries

lsof dependency is needed for Solr6. Execute below command:

# yum install lsof

3.4.3 Other libraries

Additional libraries installed are:

# yum install unzip vim telnet

_______________ page 13/46

© Tieto Corporation Konecranes Alfresco Archiving Platform


Installation Guide

1.0
Enterprise Content Management Confidential
2018-03-02

3.5 Fix rights for mounted drives

By default, content stores are owned by the root. It has to be


changed to Alfresco user. Following users are used in archiving
platform.

Repositor Environment User Remarks


y
Archive DEV alfarcdev
QA alfarcqa
PRO alfarcprod
ECM DEV alfecmdev
QA alfecmqa
PRO alfecmprod

Before executing the comment, please check if there are any folders
under /data which should be skipped. If not, you can continue using
below commands:

# cd /data/
# chmod -R 770 ./*
# chown -R <User>:<User> ./*

Similar process should be done for Solr servers (/solr):

# cd /solr/
# chmod -R 770 ./*
# chown -R <User>:<User> ./*

_______________ page 14/46

© Tieto Corporation Konecranes Alfresco Archiving Platform


Installation Guide

1.0
Enterprise Content Management Confidential
2018-03-02

4 Platform, Share, Solr6 All-in-One (DEV)

This is the simplest installation of Alfresco. It is used in archiving


platform DEV environment. Everything is installed on one server,
thus there is no need to use separate server for database or Solr
index.

4.1 Install Alfresco in text mode

Download alfresco-content-services-installer-5.2.2-linux-x64.bin
from Alfresco portal or from installable described in chapter 12. Run
following installation steps as alfresco user.

a) Execute the downloaded file using the following commands:

$ chmod 770 alfresco-content-services-installer-5.2.2-


linux-x64.bin
$ ./alfresco-content-services-installer-5.2.2-linux-
x64.bin

b) Language selection:

Confirm default selection [1] by pressing [Enter] or choose the


desired one

c) License terms:

Press [Enter] few times to go through license agreement

_______________ page 15/46

© Tieto Corporation Konecranes Alfresco Archiving Platform


Installation Guide

1.0
Enterprise Content Management Confidential
2018-03-02

At the end accept the license by choosing yes: [y]

d) Installation type:

Advanced [2]

e) Select components:

Java [Y/n] :y
PostgreSQL [Y/n] :n (we use separate DB)
LibreOffice [Y/n] :y
Alfresco One : Y (Cannot be edited)
Solr1 [y/N] : n
Solr4 [Y/n] :n (we install Solr6 separately)
Alfresco Office Services [Y/n] :y
Web Quick Start [y/N] : n
Google Docs Integration [Y/n] :n
Is the selection above correct? [Y/n]: y

f) Installation folder:

<alfresco_home> (for example: /opt/alfresco/alfresco-5_2_2)

_______________ page 16/46

© Tieto Corporation Konecranes Alfresco Archiving Platform


Installation Guide

1.0
Enterprise Content Management Confidential
2018-03-02

g) Database Configuration

DB configuration could look like on next picture (db.host and


db.port have to be added to alfresco-global.properties).

h) Tomcat Port Configuration:

Default configuration is using next ports…

Web Server Domain: [10.102.75.xx]


Tomcat Server Port: [8080]
Tomcat Shutdown Port: [8005]
Tomcat SSL Port: [8443]
Tomcat AJP Port: [8009]

On the picture bellow is non-default configuration which can be


used when something else is running on default ports.

_______________ page 17/46

© Tieto Corporation Konecranes Alfresco Archiving Platform


Installation Guide

1.0
Enterprise Content Management Confidential
2018-03-02

i) LibreOffice Server Port:

Keep default value [8100] as you can see on next picture.

j) Remote Solr configuration

Let’s put default values for now.

k) Alfresco FTP Port:

Keep default selection [2121]

l) Alfresco RMI Port:

Keep default selection [50500]

m) Admin Password:

_______________ page 18/46

© Tieto Corporation Konecranes Alfresco Archiving Platform


Installation Guide

1.0
Enterprise Content Management Confidential
2018-03-02

Type in password for administrator account and repeat it.


Installation will continue after confirmation [Y].

Alfresco installation will start immediately and process can be


seen as on picture bellow.

n) View Readme File:

In case you are interested in Readme file then choose [Y],


otherwise [n].

o) Launch Alfresco One:

Last step is to run Alfresco service. In our case, we need to add


a few properties to alfresco-global.properties especially for DB
and Solr 6 configuration. Therefore, we choose N.

p) Upload mssql-jdbc-6.2.2.jre8.jar JDBC driver under


<ALFRESCO_HOME>/tomcat/lib

_______________ page 19/46

© Tieto Corporation Konecranes Alfresco Archiving Platform


Installation Guide

1.0
Enterprise Content Management Confidential
2018-03-02

The latest JDBC driver 6.2 can be downloaded from


https://docs.microsoft.com/en-us/sql/connect/jdbc/system-
requirements-for-the-jdbc-driver

According to Alfresco case 00943375, you can also install the


latest 6.2 version - mssql-jdbc-6.2.2.jre8.jar.

q) Fix rights for /opt/alfresco

It is good practice to allow access only to alfresco user/group:


$ chmod 750 /opt/alfresco/

4.2 Install Solr6

Unzip alfresco-search-services-1.1.0.zip under /opt/solr. Specify


SOLR_HOST and SOLR_PORT in solr.in.sh.

Enable suggestions in solrhome/conf/shared.properties

Start Solr6 for the first time in order to create alfresco and archive
cores.

$ ./solr/bin/solr start -a "-


Dcreate.alfresco.defaults=alfresco,archive"
Verify Solr admin is up and running: http://<host>:<port>/solr

After that, you can start Solr without specifying core creation
parameter.

Start Solr:
$ ./solr/bin/solr start

Stop Solr:
$ ./solr/bin/solr stop

Configure Solr cores, then review host and port:

 <SOLR_HOME>/solrhome/alfresco/conf/solrcore.properties

_______________ page 20/46

© Tieto Corporation Konecranes Alfresco Archiving Platform


Installation Guide

1.0
Enterprise Content Management Confidential
2018-03-02

 alfresco.host=10.102.7x.xx
 alfresco.port=8080
 alfresco.secureComms=none
 <SOLR_HOME>/solrhome/archive/conf/solrcore.properties
 alfresco.host=10.102.7x.xx
 alfresco.port=8080
 alfresco.secureComms=none

Create symlinks for Alfresco and archive Solr cores (Solr should be
stopped):
$ cd /opt/solr/alfresco-search-services/solrhome
$ mv alfresco/ /solr/index/
$ ln -s /solr/index/alfresco alfresco
$ mv archive/ /solr/index/
$ ln -s /solr/index/archive archive

Set java.io.tmpdir for suggestion storage:


Append “ -Djava.io.tmpdir=/solr/index/temp” to SOLR_OPTS in
<SOLR_HOME>/solr.in.sh

The last thing is to fix rights for Solr directory:


$ chmod 750 /opt/solr/

4.3 Adjust alfresco-global.properties

We need to review DB part:


 Add db.host
 Add db.port
 Review db.url

Solr6 part:
 index.subsystem.name=solr6
 solr.host=10.102.7x.xx # Same as localhost
 solr.port=8983
 solr.secureComms=none # Let’s use non-SSL connection
 solr.base.url=/solr

Solr6 backup:
 solr.backup.alfresco.cronExpression=0 0 2 * * ?

_______________ page 21/46

© Tieto Corporation Konecranes Alfresco Archiving Platform


Installation Guide

1.0
Enterprise Content Management Confidential
2018-03-02

 solr.backup.alfresco.remoteBackupLocation=/solr/backup/
alfresco
 solr.backup.alfresco.numberToKeep=3
 solr.backup.archive.cronExpression=0 0 4 * * ?
 solr.backup.archive.remoteBackupLocation=/solr/backup/archive
 solr.backup.archive.numberToKeep=3

Contentstore part:
 dir.contentstore=/data/contentstore
 dir.contentstore.deleted=/data/contentstore-deleted

Other part:
 smart.folders.enabled=true

Other environment specific properties are defined on Github page


https://github.com/kcaava/alfresco-configuration.

4.4 Create symlink for current version

It is good practice to create symlink for current version. Using this


approach, we can specify all locations using /opt/alfresco/current.

$ cd /opt/alfresco
$ ln -s alfresco-5_2_2/ current

4.5 Install Alfresco Governance Services

Alfresco Governance Services (former Records Management)


needs be installed. Alfresco Content Services 5.2.2 should be used
with Alfresco Governance Services 2.6 – see
https://docs.alfresco.com/5.2/concepts/supported-platforms-
ACS.html

Installation files are defined in chapter 12.2 Installations

You need to unzip alfresco-rm-enterprise-2.6.0.zip and then move


Platform amp under /opt/alfresco/current/amps and Share amp
under /opt/alfresco/current/amps_share.

Last part is applying amps:


 Stop Alfresco
 Apply amps using /opt/alfresco/current/bin/apply_amps.sh
 Start Alfresco

As a result you should see AGS amp in deployed modules in


Alfresco Admin console.

_______________ page 22/46

© Tieto Corporation Konecranes Alfresco Archiving Platform


Installation Guide

1.0
Enterprise Content Management Confidential
2018-03-02

4.6 Logs under /var/log

Currently, this configuration is not done. There are several options


how it could be achieved:
 Create a new folder under /var/log/alfresco
 Remove <ALFRESCO_HOME>/tomcat/logs and create
symlink which will point to /var/log/alfresco
 Change log location directly in Alfresco and Share war files
 Copy Alfresco log4j.properties under
<ALFRESCO_HOME>/tomcat/shared/classes/alfresco/exten
sion/

It is worth of noting that none of the approaches worked perfectly.


Alfresco log file can be still seen under <ALFRESCO_HOME>

4.7 Install Httpd (Apache web server)

Version of httpd in yum repository is 2.4.6-67.el7_4.6 and it can be


installed by following command by root:
# yum install httpd

httpd service can be controlled using following command


# service httpd start | stop | status | restart |
configtest

_______________ page 23/46

© Tieto Corporation Konecranes Alfresco Archiving Platform


Installation Guide

1.0
Enterprise Content Management Confidential
2018-03-02

4.8 Configure Httpd (Apache web server)

Once httpd is installed, you can create a new virtual host for
alfresco.

Create file /etc/httpd/conf.d/alfresco.conf and put following content:

<VirtualHost *:80>
ServerName <ServerName>.konecranes.com
RedirectMatch permanent ^/$
http://<ServerName>.konecranes.com/share/
ProxyPreserveHost On

RewriteEngine On

RequestHeader unset Accept-Language

ProxyPass /share http://127.0.0.1:8080/share


ProxyPassReverse /share http://127.0.0.1:8080/share
RewriteRule ^/share$ /share/ [R]

ProxyPass /alfresco http://127.0.0.1:8080/alfresco


ProxyPassReverse /alfresco http://127.0.0.1:8080/alfresco
RewriteRule ^/alfresco$ /alfresco/ [R]
</VirtualHost>

The code snippet above is used for Dev environment, adjust values
based on your environment.

Repository Environmen ServerName


t
Archive DEV fikc-alfarcd01
QA fikc-alfarcq01
fikc-alfarcq02
PRO fikc-alfarc01
fikc-alfarc02
ECM DEV fikc-alfappd01
QA fikc-alfappq01
fikc-alfappq02
PRO fikc-alfapp01
fikc-alfapp02

4.9 Configure JMX

_______________ page 24/46

© Tieto Corporation Konecranes Alfresco Archiving Platform


Installation Guide

1.0
Enterprise Content Management Confidential
2018-03-02

JMX setup is configured based on Alfresco recommendations


https://docs.alfresco.com/5.2/tasks/jmx-access.html

Currently, JMX is enabled only on Alfresco “live” nodes. It was


disabled for Alfresco tracking.

Following JMX properties are defined in alfresco-global.properties:

 ### RMI registry port for JMX ###


 alfresco.rmi.services.host=10.102.7x.xx
 alfresco.rmi.services.port=50500
 monitor.rmi.service.port=0

 ### Remote JMX (Default: disabled) ###


 alfresco.jmx.connector.enabled=true
 alfresco.jmx.dir=/opt/alfresco/current/tomcat/shared

alfresco.jmx.dir contains two files:


 alfresco-jmxrmi.access
o Contains JMX roles and their access
 alfresco-jmxrmi.password
o Contains JMX passwords for roles

JMX configuration is bundled in configuration folder stored on


Github.

4.10 Java options for Alfresco and Solr

You can specify Java opts for Alfresco in


<ALFRESCO_HOME>/tomcat/bin/setenv.sh

Solr can be configured in <SOLR_HOME>/solr.in.sh

4.11 Document Transformation Engine (ECM only)

Note: Transformation server is only used in Konecranes active ECM


platform, not in archiving platform.

ECM environment uses remote transformation server which is


deployed on separated Windows server.

At first, prerequisites have to be fixed:


 MS Windows Server 2012 R2
 MS Office Professional Plus 2013 (Word, Excel and PowerPoint)
 Windows print spooler service is running
 JDK 8 32 bit version installed

_______________ page 25/46

© Tieto Corporation Konecranes Alfresco Archiving Platform


Installation Guide

1.0
Enterprise Content Management Confidential
2018-03-02

 GhostScript version manually installed


o Download GhostScript 32bit version
https://www.ghostscript.com/download/gsdnld.html
o Install under C:\Program Files (x86)\gs\gs9.22
o D:\TransformationServer\tomcat\webapps\transformation-
server\WEB-INF\classes\default-configuration.properties
 transformer.ghostscript.executable=C:\Program
Files (x86)\gs\gs9.22\bin\gswin32c.exe
 If needed you can also install pdf2swf, but it should not be used
in Alfresco 5.x
 Transformation server itself is installed under D:\
TransformationServer

More info can be seen in Alfresco docs:


https://docs.alfresco.com/5.2/concepts/transerv-standalone.html

_______________ page 26/46

© Tieto Corporation Konecranes Alfresco Archiving Platform


Installation Guide

1.0
Enterprise Content Management Confidential
2018-03-02

5 Deploy Templates (QA, PROD)

In order to create easier deployment among environments, we


created several templates which are stored on Archive DEV server
(/opt/templates). In addition, there are configuration folder for each
server and environment (/opt/configurations/alfresco-configuration).

5.1 Alfresco template

 Create tar template in DEV


o $ cd /opt/templates/
o $ tar -cf alfresco.tar alfresco/
 Copy Alfresco template from DEV
o $ scp alfresco.tar
<User>@<ServerName>:/opt/alfresco
 Login to target server and unpack tar file
o $ tar -xf alfresco.tar
 Rename Alfresco folder and create symlink
o $ mv alfresco/ alfresco-5_2_2/
o $ ln -s alfresco-5_2_2 current
 Copy configuration from DEV
o $ scp /opt/configurations/alfresco-
configuration/Archive/qa01.tar
<User>@<ServerName>:/opt/alfresco/current/config
o config folder should be created
o Merge alfresco config files
 Start Alfresco

Repository Environmen User ServerName


t
Archive DEV alfarcdev fikc-alfarcd01
QA alfarcqa fikc-alfarcq01
fikc-alfarcq02
PRO alfarcprod fikc-alfarc01
fikc-alfarc02
ECM DEV alfecmdev fikc-alfappd01
QA alfecmqa fikc-alfappq01
fikc-alfappq02
PRO alfecmprod fikc-alfapp01
fikc-alfapp02

5.2 Alfresco tracking template

_______________ page 27/46

© Tieto Corporation Konecranes Alfresco Archiving Platform


Installation Guide

1.0
Enterprise Content Management Confidential
2018-03-02

 Create tar template in DEV


o $ cd /opt/templates/
o $ tar -cf alfresco_tracking.tar
alfresco_tracking/
 Copy Alfresco tracking template from DEV
o $ scp alfresco_tracking.tar
<User>@<ServerName>:/opt/alfresco
 Login to target server and unpack tar file
o $ tar -xf alfresco_tracking.tar
 Rename Alfresco folder and create symlink
o $ mv alfresco_tracking/ alfresco-5_2_2/
o $ ln -s alfresco-5_2_2 current
 Copy configuration from DEV
o $ scp /opt/configurations/alfresco-
configuration/Archive/qa01.tar
<User>@<ServerName>:/opt/alfresco/current/config
o config folder should be created
o Merge alfresco_tracking config files
 Start Alfresco and see it is registered but not connected to cluster
o QA example:
http://<ServerName>.konecranes.com:8080/alfresco/s/enter
prise/admin/admin-clustering

Repositor Environment User ServerName


y
Archive DEV NA NA
QA alfarcqa fikc-alfarciq01
PRO alfarcprod fikc-alfarci01
ECM DEV NA NA
QA alfecmqa fikc-alfindq01
PRO alfecmprod fikc-alfind01

Note: There is no need to use Alfresco tracking on slave nodes (for


example Solr QA02) as well as on DEV environment.

5.3 Solr template

 Create temp folder under /solr/index


o $ mkdir -p /solr/index/temp
 Create backup folders for each core
o $ mkdir -p /solr/backup/alfresco
o $ mkdir -p /solr/backup/archive
 Create tar template in DEV
o $ cd /opt/templates/

_______________ page 28/46

© Tieto Corporation Konecranes Alfresco Archiving Platform


Installation Guide

1.0
Enterprise Content Management Confidential
2018-03-02

o $ tar -cf solr.tar solr/


 Copy Solr template from DEV
o $ scp /opt/templates/solr.tar
<User>@<ServerName>:/opt/solr/alfresco-search-
services
 Login to target server and unpack tar file
o $ tar -xf solr.tar
 Start Solr
o $ ./solr/bin/solr start -a "-
Dcreate.alfresco.defaults=alfresco,archive"
o You should see “Happy searching”
o Review http://<ServerName>.konecranes.com:8983/solr
 Stop Solr
o $ ./solr/bin/solr stop
 Copy configurations from DEV
o $ scp /opt/configurations/alfresco-
configuration/Archive/qa01.tar
<User>@<ServerName>:/opt/solr/alfresco-search-
services/config
o config folder should be created
o Merge solr config files
 Especially solr.in.sh, solrcore.properties and
solrconfig.xml
 Move Solr cores under /solr/index
o $ mv
/opt/solr/alfresco-search-services/solrhome/alfre
sco/ /solr/index/
o $ mv
/opt/solr/alfresco-search-services/solrhome/archi
ve/ /solr/index/
 Create symlink for alfresco and archive Solr cores
o $ cd /opt/solr/alfresco-search-services/solrhome
o $ ln -s /solr/index/alfresco/ alfresco
o $ ln -s /solr/index/archive/ archive
 Start Solr again and test that
o $ ./solr/bin/solr start

Repository Environmen User ServerName


t
Archive DEV alfarcdev fikc-alfarcd01
QA alfarcqa fikc-alfarciq01
fikc-alfarciq02
PRO alfarcprod fikc-alfarci01
fikc-alfarci02
ECM DEV alfecmdev fikc-alfappd01

_______________ page 29/46

© Tieto Corporation Konecranes Alfresco Archiving Platform


Installation Guide

1.0
Enterprise Content Management Confidential
2018-03-02

QA alfecmqa fikc-alfindq01
fikc-alfindq02
PRO alfecmprod fikc-alfind01
fikc-alfind02

6 Configuration for loadbalancer

Following chapters cover configuration for Alfresco, Share and httpd


in case there is a loadbalancer in front of httpd.

6.1 Apache httpd configuration

Httpd configuration is defined in virtual host:


/etc/httpd/conf.d/alfresco.conf

The file contains redirecting rules as well as reset of Accept-


Language request header.

6.2 CMIS URL override in alfresco-global.properties

Following lines need to be added to alfresco-global.properties in


order to get working clients which connect using CMIS:

# OpenCMIS override for http/https


opencmis.server.override=true
opencmis.server.value=https://<LB_URL>.konecranes.com

The connection was tested using opencmis-workbench.

6.3 AOS URL override in alfresco-global.properties

In order to display correct AOS link, you need to add following lines
to alfresco-global.properties:

# URL to be used for Alfresco Office Services


aos.baseUrlOverwrite=https://<LB_URL>/alfresco/aos

6.4 CSRF configuration for Alfresco

Since http proxy is used, web-scripts-config-custom.xml needs to be


added in order to allow requests from loadbalancer URL.

The most important lines define referer and origin:

<referer>https://<LB_URL>/.*</referer>
<origin>https://<LB_URL></origin>

_______________ page 30/46

© Tieto Corporation Konecranes Alfresco Archiving Platform


Installation Guide

1.0
Enterprise Content Management Confidential
2018-03-02

6.5 CSRF configuration for Share

In previous point, we allowed loadbalancer URL for Alfresco. Similar


configuration should be put to "CSRFPolicy" section in share-config-
custom.xml:

<referer>https://<LB_URL>/.*</referer>
<origin>https://<LB_URL></origin>

Repository Environment LB_URL


Archive DEV N/A
QA alfresco-arc-qa.konecranes.com
PRO alfresco-arc.konecranes.com
ECM DEV N/A
QA alfresco-ecm-qa.konecranes.com
PRO alfresco-ecm.konecranes.com

_______________ page 31/46

© Tieto Corporation Konecranes Alfresco Archiving Platform


Installation Guide

1.0
Enterprise Content Management Confidential
2018-03-02

7 Installed Modules and Connectors

7.1 JavaScript console

Administration Console component for Alfresco Share that enables


the execution of arbitrary JavaScript code against the repository.

Source code https://github.com/share-extras/js-console

Artefacts:
 javascript-console-repo-0.7-SNAPSHOT.amp
 javascript-console-share-0.7-SNAPSHOT.amp

7.2 Alfresco MetaDBConnector (MDBC)

MetaDBConnector component enables you to link information from


your database (or any other public source) easily to the content on
your Alfresco server without any additional development efforts.

Source code https://github.com/venziait/alfresco-metadbconnector

In order to start Alfresco, you need to have proper MySQL JDBC


driver for MDBC.

 These steps are optional because MySQL driver is already


included in Alfresco template. If not, you can follow the
instructions:
o Download JDBC driver
https://dev.mysql.com/downloads/connector/j/
o Copy under /opt/alfresco/current/tomcat/lib
o Restart Alfresco

Artefacts:
 mdbc-1.0.amp
 share-mdbc-component-0.1.jar

MetaDBConnector module is not part of Alfresco template because


it will be added during deployment procedure by continuous
integration process.

7.3 Connexas

Connexas is a SAP certified integration for connecting SAP with


Alfresco. More info can be found here: http://www.connexas.eu/

_______________ page 32/46

© Tieto Corporation Konecranes Alfresco Archiving Platform


Installation Guide

1.0
Enterprise Content Management Confidential
2018-03-02

Artefacts:
 connexas-3.1.3.amp
 connexas-share-3.1.3.amp

Template of Connexas properties can be seen in 14.5.

7.4 Document transformation server

ECM environment utilizes a separated remote transformation server


which is used especially for transformations of Microsoft Office
documents.

Artefacts:
 alfresco-documenttransformationserver-repo-2.1.0.amp
 alfresco-documenttransformationserver-share-2.1.0.amp
 alfresco-documenttransformationserver-server.msi
o Installation file for transformation server

_______________ page 33/46

© Tieto Corporation Konecranes Alfresco Archiving Platform


Installation Guide

1.0
Enterprise Content Management Confidential
2018-03-02

8 Create Alfresco and Solr Services

The main reason why services are created is because of unified


management of services and possibility to startup services
automatically after server reboot.

8.1 Alfresco service

All registered services are available under /etc/init.d.

In our case, we need to create a new file named alfresco under


/etc/init.d, set relevant rights (755) and import content of script
available in 14.3.

Do not forget to change RUNAS parameter which should


correspond to Alfresco user.

Next step is to change permissions in order to run it as alfresco


user:

# chmod 755 /etc/init.d/alfresco

In case, you want to register service automatically after reboot, use


following syntax:

# /sbin/chkconfig --add alfresco


# /sbin/chkconfig alfresco on

8.2 Solr service

You can follow the previous point only the script is different. Script is
available in 14.4

Next step is to change permissions in order to run it as alfresco


user:

# chmod 755 /etc/init.d/solr

In case, you want to register service automatically after reboot, use


following syntax:

# /sbin/chkconfig --add solr


# /sbin/chkconfig solr on

8.3 Httpd service

_______________ page 34/46

© Tieto Corporation Konecranes Alfresco Archiving Platform


Installation Guide

1.0
Enterprise Content Management Confidential
2018-03-02

This service is installed automatically during the installation. In order


to start after reboot, execute this command:

# systemctl enable httpd.service

_______________ page 35/46

© Tieto Corporation Konecranes Alfresco Archiving Platform


Installation Guide

1.0
Enterprise Content Management Confidential
2018-03-02

9 Clustering

9.1 Alfresco clustering

In QA and PROD, clustered environment is used. You need to


specify nodes which belong to the cluster using following properties:

# Alfresco cluster
alfresco.cluster.enabled=true

# Interface IP needs to be from this range


alfresco.cluster.interface=10.102.xx.*

# Password used by the cluster members to access/join


the Hazelcast cluster
alfresco.hazelcast.password=XXXX

Specifying different password for each environment is really


important because if the default password (alfrescocluster) is used,
you can join cluster members from other environments.

9.2 Share clustering

Clustering is defined in custom-slingshot-application-context.xml.

Currently, TCP-IP direct method is used for cache invalidation.

More info is available in Alfresco docs:


https://docs.alfresco.com/5.2/concepts/hazelcast-cluster-share.html

It is recommended to use different Hazelcast passwords and groups


for each environment (QA, PROD). The configuration is defined in
custom-slingshot-application-context.xml:

<hz:group name="slingshot_EcmQA" password="XXXX"/>

9.3

_______________ page 36/46

© Tieto Corporation Konecranes Alfresco Archiving Platform


Installation Guide

1.0
Enterprise Content Management Confidential
2018-03-02

10 Install Content Store

10.1 Configuration
Alfresco content stores are defined using following properties in
alfresco-global.properties:
 dir.contentstore=/data/contentstore
 dir.contentstore.deleted=/data/contentstore-deleted

Be aware that dir.root is still under <ALFRESCO_HOME>/alf_data


and it contains only keystore and oouser folders:
 dir.root=/opt/alfresco/current/alf_data

10.2 Mounted drives visibility


It is important to note that also Solr servers need to have the
connection to Alfresco content stores. Otherwise, it would not be
possible to index data.

_______________ page 37/46

© Tieto Corporation Konecranes Alfresco Archiving Platform


Installation Guide

1.0
Enterprise Content Management Confidential
2018-03-02

11 Install Alfresco License

To install license directly before first start of system we need to copy


the license file for Alfresco into the appropriate directory of the
Alfresco installation.
There are actually more options how to do it:

11.1 Upload license to ALFRESCO_HOME

Check license location defined as dir.license.external in file


<ALFRESCO_HOME>\tomcat\shared\classes\alfresco-
global.properties

By default, it points to ALFRESCO_HOME. You need to copy lic file


there and restart Alfresco. After the startup, the license file will be
renamed to *.lic.installed.

11.2 JMX using Alfresco Admin console


There is an option to apply the license using Alfresco admin
console. Open
http://<server>:<port>/alfresco/s/enterprise/admin/admin-license

_______________ page 38/46

© Tieto Corporation Konecranes Alfresco Archiving Platform


Installation Guide

1.0
Enterprise Content Management Confidential
2018-03-02

12 Start/Stop Alfresco and Solr

12.1 Start Alfresco

 Start Alfresco by Alfresco script:


<ALFRESCO_HOME>/alfresco.sh start
 Start Alfresco by service: service alfresco start
o For services you need to put password for Alfresco user

12.2 Stop Alfresco


 Stop Alfresco by Alfresco script:
<ALFRESCO_HOME>/alfresco.sh stop
 Stop Alfresco by service: service alfresco stop
o For services you need to put password for Alfresco user

12.3 Start Solr

 Start Solr by Solr script: <SOLR_HOME>/solr/bin/solr start


 Start Solr by service: service solr start
o For services you need to put password for Alfresco user

12.4 Stop Solr


 Stop Solr by Solr script: <SOLR_HOME>/solr/bin/solr stop
 Stop Solr by service: service solr stop
o For services you need to put password for Alfresco user

_______________ page 39/46

© Tieto Corporation Konecranes Alfresco Archiving Platform


Installation Guide

1.0
Enterprise Content Management Confidential
2018-03-02

13 Know issues

13.1 AOS - Issue with protected view (Office 2016 for Windows)

There is a known issue with Office 2016 for Windows, when


switching from the protected view into editing mode. Microsoft Office
falsely detects file changes on the server and attempts to merge
local changes with server changes. After discarding a check out,
Office does not reload the file from the server and still displays the
version of the file that has just been discarded.

More info: https://docs.alfresco.com/aos/concepts/aos-


troubleshooting.html#aos-troubleshooting__1a

_______________ page 40/46

© Tieto Corporation Konecranes Alfresco Archiving Platform


Installation Guide

1.0
Enterprise Content Management Confidential
2018-03-02

14 Additional Information

14.1 Installers

All files needed to install Alfresco can be found on server “fikc-


alfarcd01” under folder “/home/alfarcdev/Install”.

License can be downloaded from Alfresco support portal.

14.2 Environment HOME

Service Name HOME Path


<ALFRESCO_HOME> Alfresco installation directory
/opt/alfresco/current
<SOLR_HOME> Solr installation directory /opt/solr/
alfresco-search-services

14.3 Alfresco service code

#!/bin/sh
# chkconfig: 2345 80 30
# description: Alfresco Enterprise
#
RETVAL=0

# The user name which the alfresco will be executed.


RUNAS="<User>"
# Alfresco installation directory
ALFDIR="/opt/alfresco/current"

start () {
su - $RUNAS -c "cd "$ALFDIR" ; "$ALFDIR"/alfresco.sh start $2"
RETVAL=$?
if [ -d "/var/lock/subsys" ] && [ `id -u` = 0 ] && [ $RETVAL -eq 0 ] ;
then
touch /var/lock/subsys/alfresco
fi

stop () {
su - $RUNAS -c "cd "$ALFDIR" ; "$ALFDIR"/alfresco.sh stop $2"
RETVAL=$?
}

_______________ page 41/46

© Tieto Corporation Konecranes Alfresco Archiving Platform


Installation Guide

1.0
Enterprise Content Management Confidential
2018-03-02

case "$1" in
start)
start "$@"
;;
stop)
stop "$@"
;;
restart)
stop "$@"
start "$@"
;;
*)
su - $RUNAS -c "cd "$ALFDIR" ; "$ALFDIR"/alfresco.sh $@"
RETVAL=$?
esac
exit $RETVAL

14.4 Solr service code

#!/bin/sh
# chkconfig: 2345 80 30
# description: Alfresco Enterprise#
#
RETVAL=0

# The user name which the alfresco will be executed.


RUNAS="<User>"
# Solr installation directory
SOLRDIR="/opt/solr/alfresco-search-services"

start () {
su - $RUNAS -c "cd "$SOLRDIR" ; "$SOLRDIR"/solr/bin/solr start
$2"
RETVAL=$?
if [ -d "/var/lock/subsys" ] && [ `id -u` = 0 ] && [ $RETVAL -eq 0 ] ;
then
touch /var/lock/subsys/solr
fi

stop () {
su - $RUNAS -c "cd "$SOLRDIR" ; "$SOLRDIR"/solr/bin/solr stop
$2"

_______________ page 42/46

© Tieto Corporation Konecranes Alfresco Archiving Platform


Installation Guide

1.0
Enterprise Content Management Confidential
2018-03-02

RETVAL=$?
}

case "$1" in
start)
start "$@"
;;
stop)
stop "$@"
;;
restart)
stop "$@"
start "$@"
;;
*)
su - $RUNAS -c "cd "$SOLRDIR" ; "$SOLRDIR"/solr/bin/solr
$@"
RETVAL=$?
esac
exit $RETVAL

14.5 Template for Connexas configuration

###########################################

# connexas 3 Alfresco - SAP integration #

###########################################

# connexas Settings

pernexas.configuration.jmx.user=${settings.jmxrmi.user}

pernexas.configuration.jmx.password=${settings.jmxrmi.password}

pernexas.configuration.jmx.serviceURL=service:jmx:rmi://ignored/
jndi/rmi://XX.XX.XX.XX:50500/alfresco/jmxrmi

# connexas SAP System 1

#For SAP Archivelink only

#pernexas.sap.system.1.al.archiveIds=A0

_______________ page 43/46

© Tieto Corporation Konecranes Alfresco Archiving Platform


Installation Guide

1.0
Enterprise Content Management Confidential
2018-03-02

pernexas.sap.system.1.al.documentRoot=app:company_home/
cm:SAP

pernexas.sap.system.1.al.checkSignature=true

pernexas.sap.system.1.al.checkExpiration=true

pernexas.sap.system.1.al.alfrescoUser=$
{settings.connexas.username}

pernexas.sap.system.1.al.alfrescoPassword=$
{settings.connexas.password}

pernexas.sap.system.1.enabled=false

#pernexas.sap.system.1.name=XXX

#pernexas.sap.system.1.host=XXX

#pernexas.sap.system.1.client=XXX

#pernexas.sap.system.1.systemNumber=XXX

pernexas.sap.system.1.user=${settings.sap.client.username}

pernexas.sap.system.1.password=${settings.sap.client.password}

pernexas.sap.system.1.language=EN

pernexas.sap.system.1.webClient.enabled=false

#replicate SAP Job - Execution every 5 minutes

pernexas.sap.system.1.jobs.replicateSap.enabled=false

pernexas.sap.system.1.jobs.replicateSap.cronExpression=0 0/5 *
1/1 * ? *

# connexasPlus Job - Execution every 5 minutes

pernexas.sap.system.1.jobs.connexasPlus.enabled=false

_______________ page 44/46

© Tieto Corporation Konecranes Alfresco Archiving Platform


Installation Guide

1.0
Enterprise Content Management Confidential
2018-03-02

pernexas.sap.system.1.jobs.connexasPlus.cronExpression=0 0/5 *
1/1 * ? *

# barcode Job - Execution every 5 minutes

pernexas.sap.system.1.jobs.barcode.enabled=false

pernexas.sap.system.1.jobs.barcode.cronExpression=0 0/5 * 1/1 * ?


*

_______________ page 45/46

© Tieto Corporation Konecranes Alfresco Archiving Platform


Installation Guide

1.0
Enterprise Content Management Confidential
2018-03-02

15 Change History

Version Date Author Reviewed by Approved by Change history


V1.0 2018-03-01 Filip Bruska David Honkys Draft version
Lihua Ying-Aho
V1.1 2018-05-02 Filip Bruska Added SAP, TS, LB
and clustering
chapters

_______________ page 46/46

© Tieto Corporation Konecranes Alfresco Archiving Platform

You might also like