Skip to content

Commit fbb09e2

Browse files
committed
Update README to reflect new submodule structure
1 parent 02a28f2 commit fbb09e2

File tree

1 file changed

+14
-16
lines changed

1 file changed

+14
-16
lines changed

README.md

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -3,27 +3,25 @@ OAuth Support for Alfresco Share
33

44
Author: Will Abson
55

6-
This add-on provides custom Spring Surf connectors and client-side helper class, allowing easy OAuth-based access to external resources. It is a prerequisite for the Twitter, Yammer and LinkedIn dashlets provided by Share Extras.
7-
8-
Installation
9-
------------
10-
11-
The extension is packaged as a single JAR file for easy installation into Alfresco Share.
12-
13-
To install the component, drop the `share-oauth-<version>.jar` file into the following two directories within your Alfresco installation, and restart the application server.
6+
This add-on provides custom Spring Surf connectors and client-side helper class, allowing easy OAuth-based access to external resources. It is a prerequisite for the Twitter, Yammer, LinkedIn and GitHub dashlets provided by Share Extras, and the Chatter Dashlet built by Alfresco's Integrations team.
147

15-
* `tomcat/webapps/alfresco/WEB-INF/lib`
16-
* `tomcat/webapps/share/WEB-INF/lib`
17-
188
Building from Source
199
--------------------
2010

21-
An Maven POM is provided to build a JAR file containing the custom files, which can then be installed into your Alfresco installation.
11+
An Maven POM is provided to build the extension, which can then be installed into your Alfresco installation.
2212

23-
To build the JAR file, run Maven from the base project directory.
13+
To build the project, run Maven from the base project directory.
2414

25-
mvn clean package
15+
mvn clean package
2616

27-
The command should build a JAR file named `share-oauth-<version>.jar` in the `target` directory within your project, which you install by copying it into the `WEB-INF/lib` folder of the `alfresco` and `share` webapps.
17+
This will give you two JAR files which you can install as follows.
2818

29-
Once you have run this you will need to restart Tomcat so that the resources in the JAR file are picked up.
19+
Installation
20+
------------
21+
22+
The extension is packaged as a two JAR files, one for the repository and one for Share.
23+
24+
To install the component, copy the two files into your Alfresco installation, and restart the application server.
25+
26+
* Copy `share-oauth/target/share-oauth.jar` into `tomcat/webapps/share/WEB-INF/lib`
27+
* Copy `share-oauth-repo/target/share-oauth-repo.jar` into `tomcat/webapps/alfresco/WEB-INF/lib`

0 commit comments

Comments
 (0)