Skip to content

Commit

Permalink
documentation updated
Browse files Browse the repository at this point in the history
  • Loading branch information
OpenPj committed Feb 9, 2022
1 parent a8906db commit 2405445
Show file tree
Hide file tree
Showing 9 changed files with 19 additions and 18 deletions.
21 changes: 11 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Alfresco Process Services SDK Project 2.0.5
# Alfresco Process Services SDK Project 2.0.6

The project consists of the following Maven submodules:

Expand All @@ -7,16 +7,17 @@ The project consists of the following Maven submodules:
* Activiti App Swagger Client (`activiti-app-swagger-client`): generate the APS Java Swagger client
* Activiti App Overlay Docker (`activiti-app-overlay-docker`): put your overlayed WAR into the APS Docker container
* Activiti App Integration Tests (`activiti-app-integration-tests`): integration tests based on the Java Swagger client
* Full support of Arm64 CPUs (Apple Silicon M1) with native Docker containers and a transparent Maven profile

Running Docker will also create volumes for each storage component (contentstore, db and ElasticSearch) for making the development approach in APS consistent and reliable.

## Capabilities
* Full support of Arm64 CPUs (Apple Silicon M1) with native Docker containers and a transparent Maven profile
* Running Docker will also create persistent volumes for each storage component (contentstore, db and ElasticSearch) for making the development approach in APS consistent and reliable

# Prerequisites
* OpenJDK 11.0.5
* OpenJDK 11
* Apache Maven 3.8.4
* Docker (optional)
* A valid APS license installed in your development environment `<USER_HOME>/.activiti/enterprise-license` (for development purpose)
* A valid Aspose license installed in your development environment `<USER_HOME>/.activiti/enterprise-license` (for development purpose)
* For running unit tests: valid _activiti.lic_ and _Aspose.Total.Java.lic_ in `<USER_HOME>/.activiti/enterprise-license`
* For integration tests and building containers: valid _activiti.lic_ and _Aspose.Total.Java.lic_ in `activiti-app-overlay-docker/src/main/docker/license`
* Access to the Alfresco Nexus Repositories (credentials provided by Alfresco)
* Configure your Maven servers settings.xml with credentials for these repositories:

Expand Down Expand Up @@ -160,9 +161,9 @@ After the integration tests execution stop all the APS containers with:
`mvn docker:stop`

# Building your Docker container (optional)
* Put a valid APS and Aspose license in `/activiti-app-overlay-docker/src/main/docker/license`
* Put your logback.xml in `/activiti-app-overlay-war/src/main/webapp/WEB-INF/classes`
* Put your activiti-app.properties in `/activiti-app-overlay-docker/src/main/docker/properties`
* Put a valid _activiti.lic_ and _Aspose.Total.Java.lic_ in `/activiti-app-overlay-docker/src/main/docker/license`
* Update if you need _logback.xml_ in `/activiti-app-overlay-war/src/main/webapp/WEB-INF/classes`
* Update if you need your _activiti-app.properties_ in `/activiti-app-overlay-docker/src/main/docker/properties`

# Few things to notice

Expand Down
2 changes: 1 addition & 1 deletion activiti-app-integration-tests/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<parent>
<groupId>org.alfresco.activiti</groupId>
<artifactId>aps-project</artifactId>
<version>2.0.5</version>
<version>2.0.6</version>
</parent>

<properties>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ public class FourEyesAppIT {
protected static final String BASE_PATH_HOSTNAME = "localhost";
protected static final int BASE_PATH_PORT = 8080;

protected static final String appZipFile = "aps-extensions-jar-2.0.5-App.zip";
protected static final String appZipFile = "aps-extensions-jar-2.0.6-App.zip";

protected static final String ACTIVITI_APP_BASE_PATH = BASE_PATH_PROTOCOL + "://" + BASE_PATH_HOSTNAME + ":"
+ BASE_PATH_PORT;
Expand Down
2 changes: 1 addition & 1 deletion activiti-app-overlay-docker/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<parent>
<groupId>org.alfresco.activiti</groupId>
<artifactId>aps-project</artifactId>
<version>2.0.5</version>
<version>2.0.6</version>
</parent>

<properties>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# License

Put here your APS and Aspose license files (activiti.lic and transform.lic)
Put here your APS license file ( _activiti.lic_ ) and the Aspose license file ( _Aspose.Total.Java.lic_ )
2 changes: 1 addition & 1 deletion activiti-app-overlay-war/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<parent>
<groupId>org.alfresco.activiti</groupId>
<artifactId>aps-project</artifactId>
<version>2.0.5</version>
<version>2.0.6</version>
</parent>

<dependencies>
Expand Down
2 changes: 1 addition & 1 deletion activiti-app-swagger-client/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<parent>
<groupId>org.alfresco.activiti</groupId>
<artifactId>aps-project</artifactId>
<version>2.0.5</version>
<version>2.0.6</version>
</parent>

<properties>
Expand Down
2 changes: 1 addition & 1 deletion aps-extensions-jar/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<parent>
<groupId>org.alfresco.activiti</groupId>
<artifactId>aps-project</artifactId>
<version>2.0.5</version>
<version>2.0.6</version>
</parent>

<dependencyManagement>
Expand Down
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
<modelVersion>4.0.0</modelVersion>
<groupId>org.alfresco.activiti</groupId>
<artifactId>aps-project</artifactId>
<version>2.0.5</version>
<version>2.0.6</version>
<packaging>pom</packaging>
<name>APS - SDK Project</name>

Expand Down

0 comments on commit 2405445

Please sign in to comment.