mirror of
https://github.com/Alfresco/alfresco-sdk.git
synced 2025-10-08 14:51:55 +00:00
Documentation - Update documentation to SDK 4.1
- Update SDK and ACS versions - New article how to setup ATS in alfresco community - New troubleshooting section about configuring ATS
This commit is contained in:
Jose Luis Osorno
@@ -1,9 +1,9 @@
|
||||
---
|
||||
Title: Advanced topics
|
||||
Added: v3.0.0
|
||||
Last reviewed: 2019-01-17
|
||||
Last reviewed: 2019-10-18
|
||||
---
|
||||
# Advanced topics
|
||||
|
||||
This information provides more advanced topics that you might come in contact with when you have been working with an SDK project for a while. We will have a
|
||||
look at how you can work with AMPs, remote debugging, hot reloading, and more.
|
||||
look at how you can work with AMPs, remote debugging, hot reloading, enable transformations and more.
|
||||
|
||||
96
docs/advanced-topics/alfresco-transform-service.md
Normal file
96
docs/advanced-topics/alfresco-transform-service.md
Normal file
@@ -0,0 +1,96 @@
|
||||
---
|
||||
Title: How to set up Alfresco Transform Service (Community)
|
||||
Added: v4.0.0
|
||||
Last reviewed: 2019-10-18
|
||||
---
|
||||
# How to set up Alfresco Transform Service (Community)
|
||||
|
||||
By default, the _Alfresco Transform Service_ (from now ATS) is not included in the basic configuration of the projects generated making use of the Alfresco
|
||||
SDK archetypes.
|
||||
|
||||
ATS is now supported in ACS Community and it is distributed as a composition of Docker containers. The docker images required for ATS are available in the
|
||||
Alfresco account at [Docker Hub](https://hub.docker.com/u/alfresco/).
|
||||
|
||||
In order to properly configure ATS in a project generated using the Alfresco SDK archetypes it is required to execute 2 steps:
|
||||
1. Add the containers that conform ATS to the Docker compose file.
|
||||
2. Configure the properties that are required to properly set up ATS.
|
||||
|
||||
## Adding the new containers
|
||||
|
||||
* Locate the Docker compose file (usually at `PROJECT_ROOT_PATH/docker/docker-compose.yml`) and add the containers that conform ATS (`alfresco-pdf-renderer`,
|
||||
`imagemagick`, `libreoffice`, `tika`, `transform-misc` and `activemq`):
|
||||
|
||||
```
|
||||
services:
|
||||
...
|
||||
alfresco-pdf-renderer:
|
||||
image: alfresco/alfresco-pdf-renderer:2.1.0-RC3
|
||||
environment:
|
||||
JAVA_OPTS: " -Xms256m -Xmx512m"
|
||||
ports:
|
||||
- 8090:8090
|
||||
imagemagick:
|
||||
image: alfresco/alfresco-imagemagick:2.1.0-RC3
|
||||
environment:
|
||||
JAVA_OPTS: " -Xms256m -Xmx512m"
|
||||
ports:
|
||||
- 8091:8090
|
||||
libreoffice:
|
||||
image: alfresco/alfresco-libreoffice:2.1.0-RC3
|
||||
environment:
|
||||
JAVA_OPTS: " -Xms256m -Xmx512m"
|
||||
ports:
|
||||
- 8092:8090
|
||||
tika:
|
||||
image: alfresco/alfresco-tika:2.1.0-RC3
|
||||
environment:
|
||||
JAVA_OPTS: " -Xms256m -Xmx512m"
|
||||
ports:
|
||||
- 8093:8090
|
||||
transform-misc:
|
||||
image: alfresco/alfresco-transform-misc:2.1.0-RC3
|
||||
environment:
|
||||
JAVA_OPTS: " -Xms256m -Xmx512m"
|
||||
ports:
|
||||
- 8094:8090
|
||||
activemq:
|
||||
image: alfresco/alfresco-activemq:5.15.8
|
||||
ports:
|
||||
- 8161:8161 # Web Console
|
||||
- 5672:5672 # AMQP
|
||||
- 61616:61616 # OpenWire
|
||||
- 61613:61613 # STOMP
|
||||
...
|
||||
```
|
||||
|
||||
* Check that you haven't any port conflict with other services in the Docker compose file.
|
||||
|
||||
## Adding the required configuration
|
||||
|
||||
* Locate the _Alfresco global properties_ file for docker (usually at `PROJECT_ROOT_PATH/PROJECT_ARTIFACT_ID-platform-docker/src/main/docker/alfresco-global.properties`)
|
||||
and add the ATS configuration properties:
|
||||
|
||||
```
|
||||
# Alfresco Transform Service
|
||||
local.transform.service.enabled=true
|
||||
localTransform.pdfrenderer.url=http://alfresco-pdf-renderer:8090/
|
||||
localTransform.imagemagick.url=http://imagemagick:8090/
|
||||
localTransform.libreoffice.url=http://libreoffice:8090/
|
||||
localTransform.tika.url=http://tika:8090/
|
||||
localTransform.misc.url=http://transform-misc:8090/
|
||||
|
||||
legacy.transform.service.enabled=true
|
||||
alfresco-pdf-renderer.url=http://alfresco-pdf-renderer:8090/
|
||||
jodconverter.url=http://libreoffice:8090/
|
||||
img.url=http://imagemagick:8090/
|
||||
tika.url=http://tika:8090/
|
||||
transform.misc.url=http://transform-misc:8090/
|
||||
|
||||
messaging.broker.url=failover:(nio://activemq:61616)?timeout=3000&jms.useCompression=true
|
||||
```
|
||||
|
||||
* Remove the old value of the properties: `messaging.broker.url`, `transform.service.enabled`, `local.transform.service.enabled` and
|
||||
`legacy.transform.service.enabled` in the same `alfresco-global.properties` file.
|
||||
|
||||
Once these 2 modifications are done, rebuild and restart all the services (`run.sh/run.bat build_start`) and ACS will use ATS to execute remote transformations
|
||||
asynchronously whenever possible.
|
||||
@@ -1,11 +1,11 @@
|
||||
---
|
||||
Title: Working with AMPs
|
||||
Added: v3.0.0
|
||||
Last reviewed: 2019-01-14
|
||||
Last reviewed: 2019-10-18
|
||||
---
|
||||
# Working with AMPs
|
||||
|
||||
Since the early days of the Alfresco SDK, the Alfresco Module Packages (AMP) have been the way customizations were packaged. In Alfresco SDK 4.0 everything
|
||||
Since the early days of the Alfresco SDK, the Alfresco Module Packages (AMP) have been the way customizations were packaged. In Alfresco SDK 4.1 everything
|
||||
is packaged as a JAR by default, while the AMPs are still available as an optional assembly. This gives you much more control over packaging, and simple
|
||||
modules can easily be deployed as JARs.
|
||||
|
||||
@@ -55,7 +55,7 @@ to your needs.
|
||||
|
||||
## Installing AMPs with the SDK
|
||||
|
||||
The projects created from the Alfresco SDK 4.0 archetypes are configured to deploy either JARs or AMPs to the ACS / Share docker container. The only thing to
|
||||
The projects created from the Alfresco SDK 4.1 archetypes are configured to deploy either JARs or AMPs to the ACS / Share docker container. The only thing to
|
||||
do is modify the `pom.xml` file of the corresponding docker module / project in order to properly configure the dependencies and the Maven dependency plugin.
|
||||
|
||||
### All-In-One project
|
||||
@@ -172,7 +172,7 @@ Here is an example of how to install Florian Maul's Javascript Console.
|
||||
## Controlling the order AMPs are applied
|
||||
|
||||
Under some specific circumstances it is necessary to apply different AMPs in a development project in a precise order. The default configuration of the
|
||||
projects generated using the Alfresco SDK 4.0 archetypes doesn't specify any concrete order applying the AMPs to the ACS/Share installation.
|
||||
projects generated using the Alfresco SDK 4.1 archetypes doesn't specify any concrete order applying the AMPs to the ACS/Share installation.
|
||||
|
||||
Anyway, that order can be controlled modifying slightly the configuration of the custom Docker images in the project. For instance, let's say we have three
|
||||
third party AMPs that we want to apply in the next order `third-party-amp-01.amp -> third-party-amp-02.amp -> third-party-amp-03.amp`. In this example, we're
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
Title: Debugging
|
||||
Added: v3.0.0
|
||||
Last reviewed: 2019-01-17
|
||||
Last reviewed: 2019-10-18
|
||||
---
|
||||
# Debugging
|
||||
|
||||
@@ -10,4 +10,4 @@ application server. This section outlines the steps needed to configure Alfresco
|
||||
and to troubleshoot issues by stepping through the code line by line.
|
||||
|
||||
Here we assume you have already generated an Alfresco project using the Alfresco SDK. If you don't have a project already, follow the steps in
|
||||
[Getting started with Alfresco SDK 4.0](../../getting-started.md) to learn how to generate it in a few easy steps.
|
||||
[Getting started with Alfresco SDK 4.1](../../getting-started.md) to learn how to generate it in a few easy steps.
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
---
|
||||
Title: Remote debugging using Eclipse
|
||||
Added: v3.0.0
|
||||
Last reviewed: 2019-01-14
|
||||
Last reviewed: 2019-10-18
|
||||
---
|
||||
# Remote debugging using Eclipse
|
||||
|
||||
All the projects generated using the Alfresco SDK 4.0 are pre-configured to listen for remote debug connections. Depending on the selected archetypes you'll
|
||||
All the projects generated using the Alfresco SDK 4.1 are pre-configured to listen for remote debug connections. Depending on the selected archetypes you'll
|
||||
have a port for remotely debugging ACS, share or both of them.
|
||||
|
||||
By default, the remote debug port for ACS is **8888** and for share is **9898**. This configuration can be changed through the maven properties `acs.debug.port`
|
||||
@@ -79,7 +79,7 @@ application. In our case, we are going to test the behaviour of debugging by run
|
||||
|
||||
8. Open your browser and type `http://localhost:8080/alfresco/s/sample/helloworld`.
|
||||
|
||||
This is a sample webscript generated in every project created using SDK 4.0 and the platform artifact.
|
||||
This is a sample webscript generated in every project created using SDK 4.1 and the platform artifact.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
---
|
||||
Title: Remote debugging using IntelliJ
|
||||
Added: v3.0.0
|
||||
Last reviewed: 2019-01-14
|
||||
Last reviewed: 2019-10-18
|
||||
---
|
||||
# Remote debugging using IntelliJ
|
||||
|
||||
All the projects generated using the Alfresco SDK 4.0 are pre-configured to listen for remote debug connections. Depending on the selected archetypes you'll
|
||||
All the projects generated using the Alfresco SDK 4.1 are pre-configured to listen for remote debug connections. Depending on the selected archetypes you'll
|
||||
have a port for remotely debugging ACS, share or both of them.
|
||||
|
||||
By default, the remote debug port for ACS is **8888** and for share is **9898**. This configuration can be changed through the maven properties `acs.debug.port`
|
||||
@@ -77,7 +77,7 @@ application. In our case, we are going to test the behaviour of debugging by run
|
||||
|
||||
7. Open your browser and type `http://localhost:8080/alfresco/s/sample/helloworld`.
|
||||
|
||||
This is a sample webscript generated in every project created using SDK 4.0 and the platform artifact.
|
||||
This is a sample webscript generated in every project created using SDK 4.1 and the platform artifact.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
Title: Hot reloading
|
||||
Added: v3.0.0
|
||||
Last reviewed: 2019-01-17
|
||||
Last reviewed: 2019-10-18
|
||||
---
|
||||
# Hot reloading
|
||||
|
||||
|
||||
@@ -1,19 +1,19 @@
|
||||
---
|
||||
Title: How to configure and use Hotswap Agent
|
||||
Added: v3.0.0
|
||||
Last reviewed: 2019-01-14
|
||||
Last reviewed: 2019-10-18
|
||||
---
|
||||
# How to configure and use Hotswap Agent
|
||||
|
||||
[HotSwapAgent](http://hotswapagent.org/index.html) is the agent that enables you to do hot reloading. This allows you to modify the application code, and
|
||||
view the changes without having to restart Alfresco Tomcat (or the ACS Docker container).
|
||||
|
||||
A prerequisite for this tutorial is to have a project created with the Alfresco SDK 4.0, using the All-In-One archetype or the Platform JAR archetype. It's
|
||||
A prerequisite for this tutorial is to have a project created with the Alfresco SDK 4.1, using the All-In-One archetype or the Platform JAR archetype. It's
|
||||
worth noting that hot reloading is only supported on the platform, and not in Alfresco Share.
|
||||
|
||||
As an alternative to the HotSwapAgent you can also try out JRebel. It has more features but isn't free.
|
||||
|
||||
The way to configure HotSwapAgent in case of using Java 8 or Java 11 is pretty different. By default, ACS 6.0 uses Java 8 and ACS 6.1 uses Java 11.
|
||||
The way to configure HotSwapAgent in case of using Java 8 or Java 11 is pretty different. By default, ACS 6.0 uses Java 8 and ACS 6.1+ uses Java 11.
|
||||
|
||||
## Issue with Docker Toolbox
|
||||
|
||||
@@ -112,7 +112,7 @@ For more information about HotSwapAgent configuration for Java 8, please check t
|
||||
Using Java 11 and HotSwapAgent, it isn't necessary to configure the java agent and the alternative JVM as in previous versions. Instead, it is required
|
||||
to use an alternative pre-built JDK distribution. That JDK is based on OpenJDK and includes all the required modifications to run the HotSwapAgent properly.
|
||||
|
||||
In the context of the Alfresco SDK 4.0, this change is an issue because the JDK installation is inherited from the [Alfresco java docker image](https://github.com/Alfresco/alfresco-docker-base-java).
|
||||
In the context of the Alfresco SDK 4.1, this change is an issue because the JDK installation is inherited from the [Alfresco java docker image](https://github.com/Alfresco/alfresco-docker-base-java).
|
||||
It is necessary to modify the project ACS docker image to change the default java installation of the container's OS to the one provided by HotSwapAgent.
|
||||
|
||||
A way to implement the required modifications would be:
|
||||
@@ -250,7 +250,7 @@ You'll recognize HotSwapAgent is working when you see similar log messages:
|
||||
|
||||
2. Before making any changes, let's run the sample webscript by opening your browser and typing `http://localhost:8080/alfresco/s/sample/helloworld`.
|
||||
|
||||
This is a sample webscript generated in every project created using SDK 4.0 and the platform artifact.
|
||||
This is a sample webscript generated in every project created using SDK 4.1 and the platform artifact.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,14 +1,14 @@
|
||||
---
|
||||
Title: How to configure and use JRebel
|
||||
Added: v3.0.0
|
||||
Last reviewed: 2019-01-14
|
||||
Last reviewed: 2019-10-18
|
||||
---
|
||||
# How to configure and use JRebel
|
||||
|
||||
[JRebel](https://zeroturnaround.com/software/jrebel/) is the agent that enables you to do hot reloading. This allows you to modify the application code,
|
||||
and view the changes without having to restart Alfresco Tomcat (or the ACS Docker container).
|
||||
|
||||
A prerequisite to this tutorial is having an Alfresco project created with Alfresco SDK 4.0, using the All-In-One archetype, or the Platform JAR archetype.
|
||||
A prerequisite to this tutorial is having an Alfresco project created with Alfresco SDK 4.1, using the All-In-One archetype, or the Platform JAR archetype.
|
||||
It's worth noting that hot reloading is only supported on the platform, and not in Alfresco Share.
|
||||
|
||||
An open source and free of charge alternative to JRebel is HotSwapAgent. For more details, see the [HotSwapAgent website](http://hotswapagent.org/index.html).
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
Title: Integration testing
|
||||
Added: v3.0.0
|
||||
Last reviewed: 2019-01-16
|
||||
Last reviewed: 2019-10-18
|
||||
---
|
||||
# Integration testing
|
||||
|
||||
@@ -11,11 +11,11 @@ in an integration test plan to those aggregates, and delivers as its output the
|
||||
|
||||
Even if the definition of integration testing is a general description, the concept is also valid for Alfresco projects.
|
||||
|
||||
The Alfresco SDK 4.0 keeps the same general idea of integration testing provided by SDK 3.0, but this new version reshapes it slightly to leverage on a
|
||||
The Alfresco SDK 4.1 keeps the same general idea of integration testing provided by SDK 3.0, but this new version reshapes it slightly to leverage on a
|
||||
Docker-oriented environment.
|
||||
|
||||
Here are the basics to understanding and using integration testing in the context of projects created with the SDK, from a technical perspective:
|
||||
* SDK 4.0 develops integration tests for the platform only. Currently, the integration tests that the SDK is able to manage by default is related to
|
||||
* SDK 4.1 develops integration tests for the platform only. Currently, the integration tests that the SDK is able to manage by default is related to
|
||||
Alfresco Content Services (ACS) only.
|
||||
* Integration tests require an ACS instance to be up and running. You will see that all the scripts and commands are designed to easily manage this
|
||||
requirement, but the prerequisite for the SDK is that an ACS instance is available.
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
---
|
||||
Title: How to run SDK's integration tests
|
||||
Added: v3.0.0
|
||||
Last reviewed: 2019-01-16
|
||||
Last reviewed: 2019-10-18
|
||||
---
|
||||
# How to run SDK's integration tests
|
||||
|
||||
Running the integration tests of a project generated from the Alfresco SDK 4.0 archetypes is pretty easy. Let's distinguish different cases of executing the
|
||||
Running the integration tests of a project generated from the Alfresco SDK 4.1 archetypes is pretty easy. Let's distinguish different cases of executing the
|
||||
integration tests.
|
||||
|
||||
## Command line
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
Title: How SDK's integration tests work
|
||||
Added: v3.0.0
|
||||
Last reviewed: 2019-01-16
|
||||
Last reviewed: 2019-10-18
|
||||
---
|
||||
# How SDK's integration tests work
|
||||
|
||||
@@ -36,7 +36,7 @@ or set the Java system property `acs.endpoint.path`.
|
||||
|
||||
## Integration tests configuration in the All-In-One project
|
||||
|
||||
So, taking into account the previous section, let's see how the integration tests are configured in a project generated from the SDK 4.0 All-In-One archetype.
|
||||
So, taking into account the previous section, let's see how the integration tests are configured in a project generated from the SDK 4.1 All-In-One archetype.
|
||||
|
||||
* The maven dependencies required to execute the integration tests are deployed to the ACS Docker image in the `PROJECT_ARTEFACTID-platform-docker` maven
|
||||
module using the `maven-dependency-plugin`. The configuration is done in the file `PROJECT_ARTEFACTID-platform-docker/pom.xml`:
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
Title: Switching Alfresco Content Services database
|
||||
Added: v4.0.0
|
||||
Last reviewed: 2019-01-29
|
||||
Last reviewed: 2019-10-18
|
||||
---
|
||||
# Switching Alfresco Content Services database
|
||||
|
||||
|
||||
@@ -1,14 +1,14 @@
|
||||
---
|
||||
Title: Switching Alfresco Content Services and Share versions
|
||||
Added: v3.0.0
|
||||
Last reviewed: 2019-01-16
|
||||
Last reviewed: 2019-10-18
|
||||
---
|
||||
# Switching Alfresco Content Services and Share versions
|
||||
|
||||
The latest version of the Alfresco SDK supports different versions for Alfresco Content Services and Alfresco Share. Since each product is no longer
|
||||
released under one common version number, ACS (i.e. alfresco.war) and the Share UI (share.war) are now released with individual version numbers.
|
||||
|
||||
By default, SDK 4.0 is configured to generate projects using the most recent version of ACS and Share. You can easily change one (or both) versions by
|
||||
By default, SDK 4 is configured to generate projects using the most recent version of ACS and Share. You can easily change one (or both) versions by
|
||||
simply updating the `pom.xml` file in your project. The compatibility of these versions is up to you, however you should check in advance the right versions
|
||||
to use.
|
||||
|
||||
@@ -28,7 +28,7 @@ The supported versions are explained in the next sections of this article.
|
||||
|
||||
## Switch to Alfresco version 6.0.x
|
||||
|
||||
Starting from a newly created Alfresco SDK 4.0 project (All-In-One, Platform JAR, or Share JAR), let’s replace the two properties with the following ones.
|
||||
Starting from a newly created Alfresco SDK 4.1 project (All-In-One, Platform JAR, or Share JAR), let’s replace the two properties with the following ones.
|
||||
|
||||
1. Open the pom.xml in your generated project.
|
||||
|
||||
@@ -54,6 +54,34 @@ $ ./run.sh purge
|
||||
$ ./run.sh build_start
|
||||
```
|
||||
|
||||
**IMPORTANT:** Alfresco 6.1 is ready to work with JDK 11, but Alfresco 6.0 needs to be compiled and run using JDK 8, so please take this into account when you
|
||||
switch from version 6.1.x to 6.0.x. If you compile Alfresco 6.0.x with JDK 11 you'll experience the issue described in the [Troubleshooting page](../troubleshooting.md)
|
||||
**IMPORTANT:** Alfresco 6.1+ is ready to work with JDK 11, but Alfresco 6.0 needs to be compiled and run using JDK 8, so please take this into account when you
|
||||
switch from version 6.1+ to 6.0.x. If you compile Alfresco 6.0.x with JDK 11 you'll experience the issue described in the [Troubleshooting page](../troubleshooting.md)
|
||||
about wrong JDK versions.
|
||||
|
||||
## Switch to Alfresco version 6.1.x
|
||||
|
||||
Starting from a newly created Alfresco SDK 4.1 project (All-In-One, Platform JAR, or Share JAR), let’s replace the two properties with the following ones.
|
||||
|
||||
1. Open the pom.xml in your generated project.
|
||||
|
||||
2. Replace the properties with the following:
|
||||
|
||||
```
|
||||
<alfresco.platform.version>6.1.2-ga</alfresco.platform.version>
|
||||
<alfresco.share.version>6.1.0-RC3</alfresco.share.version>
|
||||
```
|
||||
|
||||
In this example we have shown the switch to version 6.1.2-ga. Feel free to use the correct version for your project, paying attention to the compatible versions
|
||||
of Alfresco Content Services and Alfresco Share.
|
||||
|
||||
3. After changing the versions, delete all the previous data of your development Docker environment:
|
||||
|
||||
```
|
||||
$ ./run.sh purge
|
||||
```
|
||||
|
||||
4. Rebuild and restart the project:
|
||||
|
||||
```
|
||||
$ ./run.sh build_start
|
||||
```
|
||||
|
||||
@@ -3,15 +3,15 @@ Title: Upgrading
|
||||
Added: v4.0.0
|
||||
Last reviewed: 2019-01-29
|
||||
---
|
||||
# Upgrading an SDK 3.0 project to SDK 4.0
|
||||
# Upgrading an SDK 3.0 project to SDK 4.1
|
||||
|
||||
In these instructions, "base" refers to a freshly instantiated SDK 4.0 and "target" refers to the SDK 3.0.1 project that is being upgraded.
|
||||
In these instructions, "base" refers to a freshly instantiated SDK 4.1 and "target" refers to the SDK 3.0.1 project that is being upgraded.
|
||||
|
||||
## Download a base
|
||||
|
||||
Download or instantiate an SDK 4.0 project to use as a base for copying files.
|
||||
Download or instantiate an SDK 4.1 project to use as a base for copying files.
|
||||
|
||||
For example, you might create a new project called "test-aio-400" to use as a base from which to copy files into the target project that is to be upgraded.
|
||||
For example, you might create a new project called `test-aio-400` to use as a base from which to copy files into the target project that is to be upgraded.
|
||||
|
||||
## Remove unnecessary files
|
||||
|
||||
@@ -65,7 +65,7 @@ Similar to previous step, the directory should follow the same pattern as the ex
|
||||
|
||||
Need to smartly do this merge so that target project maintains its dependencies, name, version, description, etc.
|
||||
|
||||
1. Copy the entire `<properties>` element from the base 4.0 pom.xml into the target 3.0 pom.xml, replacing the existing one completely.
|
||||
1. Copy the entire `<properties>` element from the base 4.1 pom.xml into the target 3.0 pom.xml, replacing the existing one completely.
|
||||
|
||||
2. Change the `acs.host` property to match the target project name.
|
||||
|
||||
@@ -220,7 +220,7 @@ Then that would need to be moved into the share docker module's pom.xml file in
|
||||
|
||||
## Changes to the integration-tests module
|
||||
|
||||
1. Completely replace the pom.xml file with the pom.xml file from the 4.0 pom.xml file under integration-tests.
|
||||
1. Completely replace the pom.xml file with the pom.xml file from the 4.1 pom.xml file under integration-tests.
|
||||
|
||||
2. Edit the integration-tests pom.xml to replace references to the base project name with references to the target project name.
|
||||
|
||||
@@ -230,7 +230,7 @@ Then that would need to be moved into the share docker module's pom.xml file in
|
||||
|
||||
## Changes to the platform-jar module
|
||||
|
||||
Smartly merge the pom.xml file from the 4.0 platform-jar module into the existing platform-jar module pom.xml file.
|
||||
Smartly merge the pom.xml file from the 4.1 platform-jar module into the existing platform-jar module pom.xml file.
|
||||
|
||||
Maintain the dependencies from the 3.0 platform-jar module pom.xml.
|
||||
|
||||
@@ -238,13 +238,13 @@ Any old "platformModule" dependencies, which are typically AMPs or JARs that nee
|
||||
|
||||
## Changes to the share-jar module
|
||||
|
||||
Smartly merge the pom.xml file from the 4.0 share-jar module into the existing share-jar module pom.xml file.
|
||||
Smartly merge the pom.xml file from the 4.1 share-jar module into the existing share-jar module pom.xml file.
|
||||
|
||||
Maintain the dependencies from the 3.0 share-jar module pom.xml.
|
||||
|
||||
Any old "shareModule" dependencies, which are typically AMPs or JARs that need to be installed in the Share tier need to be copied into this pom.xml's depdencies.
|
||||
|
||||
Remove the spring-surf-api dependency from the 4.0 share-jar module. Remove:
|
||||
Remove the spring-surf-api dependency from the 4.1 share-jar module. Remove:
|
||||
|
||||
```
|
||||
<dependency>
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
Title: Working with Enterprise
|
||||
Added: v3.0.0
|
||||
Last reviewed: 2019-01-15
|
||||
Last reviewed: 2019-10-18
|
||||
---
|
||||
# Working with Enterprise
|
||||
|
||||
@@ -54,11 +54,11 @@ The configuration of the Enterprise version is straightforward when using the `p
|
||||
You'll need to update the following settings in the `pom.xml` file:
|
||||
|
||||
```
|
||||
<alfresco.platform.version>6.1.0</alfresco.platform.version>
|
||||
<alfresco.share.version>6.1.0</alfresco.share.version>
|
||||
<alfresco.platform.version>6.2.0</alfresco.platform.version>
|
||||
<alfresco.share.version>6.2.0</alfresco.share.version>
|
||||
```
|
||||
|
||||
Making use of the Alfresco SDK 4.0 it is no longer required the configuration of the Alfresco Surf versions. The inclusion of the BOM and the custom Docker
|
||||
Making use of the Alfresco SDK 4 it is no longer required the configuration of the Alfresco Surf versions. The inclusion of the BOM and the custom Docker
|
||||
images will take care of that task automatically for you.
|
||||
|
||||
## Purging the project data and running the project
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
---
|
||||
Title: How to set up Alfresco Transform Service
|
||||
Title: How to set up Alfresco Transform Service (Enterprise)
|
||||
Added: v4.0.0
|
||||
Last reviewed: 2019-01-14
|
||||
Last reviewed: 2019-10-18
|
||||
---
|
||||
# How to set up Alfresco Transform Service
|
||||
# How to set up Alfresco Transform Service (Enterprise)
|
||||
|
||||
By default, the _Alfresco Transform Service_ (from now ATS) is not included in the basic configuration of the projects generated making use of the Alfresco
|
||||
SDK archetypes.
|
||||
@@ -18,53 +18,78 @@ In order to properly configure ATS in a project generated using the Alfresco SDK
|
||||
## Adding the new containers
|
||||
|
||||
* Locate the Docker compose file (usually at `PROJECT_ROOT_PATH/docker/docker-compose.yml`) and add the containers that conform ATS (`transform-router`,
|
||||
`alfresco-pdf-renderer`, `imagemagick`, `libreoffice`, `tika`, `shared-file-store` and `activemq`):
|
||||
`alfresco-pdf-renderer`, `imagemagick`, `libreoffice`, `tika`, `transform-misc`, `shared-file-store` and `activemq`):
|
||||
|
||||
```
|
||||
services:
|
||||
...
|
||||
transform-router:
|
||||
image: quay.io/alfresco/alfresco-transform-router:0.5.0
|
||||
image: quay.io/alfresco/alfresco-transform-router:1.1.0-RC3
|
||||
environment:
|
||||
JAVA_OPTS: " -Xms256m -Xmx512m"
|
||||
ACTIVEMQ_URL: "nio://activemq:61616"
|
||||
IMAGEMAGICK_URL: "http://imagemagick:8090"
|
||||
PDF_RENDERER_URL: "http://alfresco-pdf-renderer:8090"
|
||||
LIBREOFFICE_URL: "http://libreoffice:8090"
|
||||
TIKA_URL: "http://tika:8090"
|
||||
PDF_RENDERER_URL : "http://alfresco-pdf-renderer:8090"
|
||||
LIBREOFFICE_URL : "http://libreoffice:8090"
|
||||
TIKA_URL : "http://tika:8090"
|
||||
TRANSFORM_MISC_URL : "http://transform-misc:8090"
|
||||
FILE_STORE_URL: "http://shared-file-store:8099/alfresco/api/-default-/private/sfs/versions/1/file"
|
||||
ports:
|
||||
- 8095:8095
|
||||
links:
|
||||
- activemq
|
||||
alfresco-pdf-renderer:
|
||||
image: quay.io/alfresco/alfresco-pdf-renderer:2.0.8
|
||||
image: alfresco/alfresco-pdf-renderer:2.1.0-RC2
|
||||
environment:
|
||||
JAVA_OPTS: " -Xms256m -Xmx512m"
|
||||
ACTIVEMQ_URL: "nio://activemq:61616"
|
||||
FILE_STORE_URL: "http://shared-file-store:8099/alfresco/api/-default-/private/sfs/versions/1/file"
|
||||
ports:
|
||||
- 8090:8090
|
||||
links:
|
||||
- activemq
|
||||
imagemagick:
|
||||
image: quay.io/alfresco/alfresco-imagemagick:2.0.8
|
||||
image: alfresco/alfresco-imagemagick:2.1.0-RC2
|
||||
environment:
|
||||
JAVA_OPTS: " -Xms256m -Xmx512m"
|
||||
ACTIVEMQ_URL: "nio://activemq:61616"
|
||||
FILE_STORE_URL: "http://shared-file-store:8099/alfresco/api/-default-/private/sfs/versions/1/file"
|
||||
ports:
|
||||
- 8091:8090
|
||||
links:
|
||||
- activemq
|
||||
libreoffice:
|
||||
image: quay.io/alfresco/alfresco-libreoffice:2.0.8
|
||||
image: alfresco/alfresco-libreoffice:2.1.0-RC2
|
||||
environment:
|
||||
JAVA_OPTS: " -Xms256m -Xmx512m"
|
||||
ACTIVEMQ_URL: "nio://activemq:61616"
|
||||
FILE_STORE_URL: "http://shared-file-store:8099/alfresco/api/-default-/private/sfs/versions/1/file"
|
||||
ports:
|
||||
- 8092:8090
|
||||
links:
|
||||
- activemq
|
||||
tika:
|
||||
image: quay.io/alfresco/alfresco-tika:2.0.8
|
||||
image: alfresco/alfresco-tika:2.1.0-RC2
|
||||
environment:
|
||||
JAVA_OPTS: " -Xms256m -Xmx512m"
|
||||
ACTIVEMQ_URL: "nio://activemq:61616"
|
||||
FILE_STORE_URL: "http://shared-file-store:8099/alfresco/api/-default-/private/sfs/versions/1/file"
|
||||
ports:
|
||||
- 8093:8090
|
||||
links:
|
||||
- activemq
|
||||
transform-misc:
|
||||
image: alfresco/alfresco-transform-misc:2.1.0-RC2
|
||||
environment:
|
||||
JAVA_OPTS: " -Xms256m -Xmx512m"
|
||||
ACTIVEMQ_URL: "nio://activemq:61616"
|
||||
FILE_STORE_URL: "http://shared-file-store:8099/alfresco/api/-default-/private/sfs/versions/1/file"
|
||||
ports:
|
||||
- 8094:8090
|
||||
links:
|
||||
- activemq
|
||||
shared-file-store:
|
||||
image: alfresco/alfresco-shared-file-store:0.5.1
|
||||
image: alfresco/alfresco-shared-file-store:0.5.3
|
||||
environment:
|
||||
JAVA_OPTS: " -Xms256m -Xmx512m"
|
||||
scheduler.content.age.millis: 86400000
|
||||
@@ -74,7 +99,7 @@ services:
|
||||
volumes:
|
||||
- shared-file-store-volume:/tmp/Alfresco/sfs
|
||||
activemq:
|
||||
image: alfresco/alfresco-activemq:5.15.6
|
||||
image: alfresco/alfresco-activemq:5.15.8
|
||||
ports:
|
||||
- 8161:8161 # Web Console
|
||||
- 5672:5672 # AMQP
|
||||
@@ -102,13 +127,24 @@ and add the ATS configuration properties:
|
||||
|
||||
```
|
||||
# Alfresco Transform Service
|
||||
transform.service.enabled=true
|
||||
transform.service.url=http://transform-router:8095
|
||||
sfs.url=http://shared-file-store:8099/
|
||||
|
||||
local.transform.service.enabled=true
|
||||
localTransform.pdfrenderer.url=http://alfresco-pdf-renderer:8090/
|
||||
localTransform.imagemagick.url=http://imagemagick:8090/
|
||||
localTransform.libreoffice.url=http://libreoffice:8090/
|
||||
localTransform.tika.url=http://tika:8090/
|
||||
localTransform.misc.url=http://transform-misc:8090/
|
||||
|
||||
legacy.transform.service.enabled=true
|
||||
alfresco-pdf-renderer.url=http://alfresco-pdf-renderer:8090/
|
||||
jodconverter.url=http://libreoffice:8090/
|
||||
img.url=http://imagemagick:8090/
|
||||
tika.url=http://tika:8090/
|
||||
sfs.url=http://shared-file-store:8099/
|
||||
local.transform.service.enabled=true
|
||||
transform.service.enabled=true
|
||||
transform.misc.url=http://transform-misc:8090/
|
||||
|
||||
messaging.broker.url=failover:(nio://activemq:61616)?timeout=3000&jms.useCompression=true
|
||||
```
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
Title: How to configure private Alfresco Docker registry
|
||||
Added: v3.0.0
|
||||
Last reviewed: 2019-01-15
|
||||
Last reviewed: 2019-10-18
|
||||
---
|
||||
# How to configure private Alfresco Docker registry
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
Title: How to configure private Alfresco Nexus repository
|
||||
Added: v3.0.0
|
||||
Last reviewed: 2019-01-15
|
||||
Last reviewed: 2019-10-18
|
||||
---
|
||||
# How to configure private Alfresco Nexus repository
|
||||
|
||||
|
||||
Reference in New Issue
Block a user