Skip to content

Commit 8e3a40e

Browse files
AFaustAFaust
committed
Documentation update
1 parent ad28078 commit 8e3a40e

File tree

3 files changed

+54
-98
lines changed

3 files changed

+54
-98
lines changed

‎README.md‎

Lines changed: 20 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -13,52 +13,37 @@ Installation
1313
------------
1414

1515
The component has been developed to install on top of an existing Alfresco
16-
3.4 or 4.0 installation. There are two different version in this archive within
17-
a specific folder for each of the Alfresco versions 3.4.x or 4.0.x.
16+
4.0, 4.1 or 4.2 installation. The javascript-console-repo-<version>.amp or
17+
javascript-console-share-<version>.amp needs to be installed into the Alfresco
18+
Repository / Share webapp using the Alfresco Module Management Tool:
1819

19-
When you have chosen the correct folder (3.4.x or 4.0.x) for your Alfresco version
20-
you'll find two jar files within that folder. The javascript-console-repo.jar needs
21-
to be copied into the Alfresco repository:
22-
23-
tomcat/webapps/alfresco/WEB-INF/lib/
24-
25-
The other file javascript-console-share.jar needs to be copied to the
26-
corresponding folder in the Share webapp:
27-
28-
tomcat/webapps/share/WEB-INF/lib/
20+
java -jar alfresco-mmt.jar install javascript-console-repo-<version>.amp /path/to/alfresco.war
21+
java -jar alfresco-mmt.jar install javascript-console-share-<version>.amp /path/to/share.war
2922

30-
If you prefer the AMP deployment method you also find amp files in the respective
31-
folder that you can install with the apply_amps.sh or apply_amps.bat utilities. Be
32-
aware that you need to install both amps files: the repo-amp and the share-amp.
33-
34-
The deployment location has changed recently (with Javascript Console 0.5)
35-
because the Javascript Console now uses Java classes that have to be deployed
36-
to these locations and can NOT reside in tomcat/shared/lib anymore.
23+
You can also use the Alfresco Maven SDK to install or overlay the AMP during the build of a
24+
Repository / Share WAR project. See https://artifacts.alfresco.com/nexus/content/repositories/alfresco-docs/alfresco-lifecycle-aggregator/latest/plugins/alfresco-maven-plugin/advanced-usage.html
25+
for details.
3726

3827

3928
Building
4029
--------
4130

42-
To build the individual JAR files, run the following command from the base
43-
project directory.
44-
45-
ant -Dalfresco.sdk.dir=c:\dev\sdks\alfresco-enterprise-sdk-4.0.0 clean dist-jar
31+
To build the module and its AMP / JAR files, run the following command from the base
32+
project directory:
4633

47-
The command should build a JAR file named javascript-console-repo.jar or
48-
javascript-console-share.jar in the 'dist' directory within your project.
34+
mvn install
4935

50-
There also is the javascript-console-dist project which builds both jar files
51-
and creates a patched version for Alfresco 3.4.x which does not support all the
52-
features of the version for 4.0.x. This project creates the AMP files as well.
36+
The command builds two JAR files named javascript-console-repo-<version>.jar /
37+
javascript-console-share-<version>.jar and javascript-console-repo-<version>-sources.jar /
38+
javascript-console-share-<version>-sources.jar as well as javascript-console-repo-<version>.amp /
39+
javascript-console-share-<version>.amp in the 'target' directory within your project.
5340

54-
To deploy the extension files into a local Tomcat instance for testing, you can
55-
use the hotcopy-tomcat-jar task. You will need to set the tomcat.home
56-
property in Ant.
41+
If you want to build the module so it can be installed and run in an Alfresco 4.0 / 4.1 server
42+
running on Java 6 you need to have a Java 6 JDK available. Either make sure that your JDK 6 is set
43+
as the default Java environment (PATH / JAVA_HOME environment variable) or run the build with the
44+
following command from the base project directory:
5745

58-
ant -Dtomcat.home=C:/Alfresco/tomcat clean hotcopy-tomcat-jar
59-
60-
Once you have run this you will need to restart Tomcat so that the classpath
61-
resources in the JAR file are picked up.
46+
mvn install -P Java6-crossCompile -Djdk6.executable=/path/to/javac
6247

6348

6449
Using the component

‎javascript-console-repo/README.md‎

Lines changed: 17 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -12,48 +12,34 @@ Installation
1212
------------
1313

1414
The component has been developed to install on top of an existing Alfresco
15-
3.4 or 4.0 installation. There are two different version in this archive with
16-
a specific folder for each of the Alfresco version.
15+
4.0, 4.1 or 4.2 installation. The javascript-console-repo-<version>.amp needs
16+
to be installed into the Alfresco Repository webapp using the Alfresco Module Management Tool:
1717

18-
When you have chosen the correct folder (3.4.x or 4.0.x) for your Alfresco version
19-
you'll find two jar files within that folder. The javascript-console-repo.jar needs
20-
to be copied into the Alfresco repository:
21-
22-
tomcat/webapps/alfresco/WEB-INF/lib/
23-
24-
The other file javascript-console-share.jar needs to be copied to the
25-
corresponding folder in the Share webapp:
26-
27-
tomcat/webapps/share/WEB-INF/lib/
18+
java -jar alfresco-mmt.jar install javascript-console-repo-<version>.amp /path/to/alfresco.war
2819

29-
The deployment location has changed recently (with Javascript Console 0.5)
30-
because the Javascript Console now uses Java classes that have to be deployed
31-
to these locations and can NOT reside in tomcat/shared/lib anymore.
20+
You can also use the Alfresco Maven SDK to install or overlay the AMP during the build of a
21+
Repository WAR project. See https://artifacts.alfresco.com/nexus/content/repositories/alfresco-docs/alfresco-lifecycle-aggregator/latest/plugins/alfresco-maven-plugin/advanced-usage.html
22+
for details.
3223

3324

3425
Building
3526
--------
3627

37-
To build the individual JAR files, run the following command from the base
38-
project directory.
39-
40-
ant -Dalfresco.sdk.dir=c:\dev\sdks\alfresco-enterprise-sdk-4.0.0 clean dist-jar
28+
To build the module and its AMP / JAR files, run the following command from the base
29+
project directory:
4130

42-
The command should build a JAR file named javascript-console-repo.jar or
43-
javascript-console-share.jar in the 'dist' directory within your project.
31+
mvn install
4432

45-
There also is the javascript-console-dist which builds both jar files and
46-
creates a patched version for Alfresco 3.4.x which does not support all the
47-
features of the version for 4.0.x
33+
The command builds two JAR files named javascript-console-repo-<version>.jar and
34+
javascript-console-repo-<version>-sources.jar as well as javascript-console-repo-<version>.amp
35+
in the 'target' directory within your project.
4836

49-
To deploy the extension files into a local Tomcat instance for testing, you can
50-
use the hotcopy-tomcat-jar task. You will need to set the tomcat.home
51-
property in Ant.
37+
If you want to build the module so it can be installed and run in an Alfresco 4.0 / 4.1 server
38+
running on Java 6 you need to have a Java 6 JDK available. Either make sure that your JDK 6 is set
39+
as the default Java environment (PATH / JAVA_HOME environment variable) or run the build with the
40+
following command from the base project directory:
5241

53-
ant -Dtomcat.home=C:/Alfresco/tomcat clean hotcopy-tomcat-jar
54-
55-
Once you have run this you will need to restart Tomcat so that the classpath
56-
resources in the JAR file are picked up.
42+
mvn install -P Java6-crossCompile -Djdk6.executable=/path/to/javac
5743

5844

5945
Using the component

‎javascript-console-share/README.md‎

Lines changed: 17 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -12,48 +12,33 @@ Installation
1212
------------
1313

1414
The component has been developed to install on top of an existing Alfresco
15-
3.4 or 4.0 installation. There are two different version in this archive with
16-
a specific folder for each of the Alfresco version.
15+
4.0, 4.1 or 4.2 installation. The javascript-console-share-<version>.amp needs
16+
to be installed into the Alfresco Share webapp using the Alfresco Module Management Tool:
1717

18-
When you have chosen the correct folder (3.4.x or 4.0.x) for your Alfresco version
19-
you'll find two jar files within that folder. The javascript-console-repo.jar needs
20-
to be copied into the Alfresco repository:
21-
22-
tomcat/webapps/alfresco/WEB-INF/lib/
23-
24-
The other file javascript-console-share.jar needs to be copied to the
25-
corresponding folder in the Share webapp:
26-
27-
tomcat/webapps/share/WEB-INF/lib/
18+
java -jar alfresco-mmt.jar install javascript-console-share-<version>.amp /path/to/share.war
2819

29-
The deployment location has changed recently (with Javascript Console 0.5)
30-
because the Javascript Console now uses Java classes that have to be deployed
31-
to these locations and can NOT reside in tomcat/shared/lib anymore.
32-
20+
You can also use the Alfresco Maven SDK to install or overlay the AMP during the build of a
21+
Share WAR project. See https://artifacts.alfresco.com/nexus/content/repositories/alfresco-docs/alfresco-lifecycle-aggregator/latest/plugins/alfresco-maven-plugin/advanced-usage.html
22+
for details.
3323

3424
Building
3525
--------
3626

37-
To build the individual JAR files, run the following command from the base
38-
project directory.
39-
40-
ant -Dalfresco.sdk.dir=c:\dev\sdks\alfresco-enterprise-sdk-4.0.0 clean dist-jar
27+
To build the module and its AMP / JAR files, run the following command from the base
28+
project directory:
4129

42-
The command should build a JAR file named javascript-console-repo.jar or
43-
javascript-console-share.jar in the 'dist' directory within your project.
30+
mvn install
4431

45-
There also is the javascript-console-dist which builds both jar files and
46-
creates a patched version for Alfresco 3.4.x which does not support all the
47-
features of the version for 4.0.x
32+
The command builds two JAR files named javascript-console-share-<version>.jar and
33+
javascript-console-share-<version>-sources.jar as well as javascript-console-share-<version>.amp
34+
in the 'target' directory within your project.
4835

49-
To deploy the extension files into a local Tomcat instance for testing, you can
50-
use the hotcopy-tomcat-jar task. You will need to set the tomcat.home
51-
property in Ant.
36+
If you want to build the module so it can be installed and run in an Alfresco 4.0 / 4.1 server
37+
running on Java 6 you need to have a Java 6 JDK available. Either make sure that your JDK 6 is set
38+
as the default Java environment (PATH / JAVA_HOME environment variable) or run the build with the
39+
following command from the base project directory:
5240

53-
ant -Dtomcat.home=C:/Alfresco/tomcat clean hotcopy-tomcat-jar
54-
55-
Once you have run this you will need to restart Tomcat so that the classpath
56-
resources in the JAR file are picked up.
41+
mvn install -P Java6-crossCompile -Djdk6.executable=/path/to/javac
5742

5843

5944
Using the component

0 commit comments

Comments
 (0)