Skip to content

Commit

Permalink
Update README + include image for wiki
Browse files Browse the repository at this point in the history
  • Loading branch information
@AFaust
AFaust committed Aug 19, 2019
1 parent 27da1ac commit ea4df48
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 86 deletions.
110 changes: 24 additions & 86 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
[![Build Status](https://travis-ci.org/OrderOfTheBee/ootbee-support-tools.svg?branch=master)](https://travis-ci.org/OrderOfTheBee/ootbee-support-tools)

# OOTBee Support Tools

This addon aims to enhance the scope and functionality available to Alfresco administrators via the Repository-tier Admin Console or Share-tier Admin Tools. It contains most of the tools provided with the [Alfresco Support Tools](https://github.com/Alfresco/alfresco-support-tools) addon (by Antonio Soler) without requiring to be run on any specific Alfresco edition as well as about half a dozen custom tools.

The project started as a project at the [2016 Global Virtual Hack-a-thon](https://community.alfresco.com/docs/DOC-6364-projects-and-teams-global-virtual-hackathon-2016) and has since been transferred to the Order of the Bee in order to make it a fully community-owned and -maintained project.
Expand All @@ -13,7 +14,7 @@ Though it can technically be installed in Alfresco Enterprise 5.0 it will not wo

# Maven usage

This addon is being build using Alfresco SDK 2.2.0. This means we produce an AMP artifact that can be added to an Alfresco all-in-one / WAR build with the as a dependency:
This addon is being build using Alfresco SDK 4. This means we primarily produce a JAR artifact that can be added to an Alfresco installation, though care must be taken to also include all of the third party dependencies required by the OOTBee Support Tools. For users who want a hassle free installation using Alfresco Module Packages (AMPs) we also still produce an AMP for both Repository and Share as we have done in version 1.0.0.0.

## Using SNAPSHOT builds

Expand All @@ -33,107 +34,42 @@ In order to use a pre-built SNAPSHOT artifact published to the Open Source Sonat

## Repository-tier

Including the AMP artifact into an All-in-One project created from the archetype provided by Alfresco SDK 4, the following dependency must be added to the ``*-platform-docker`` sub-module of the generated project:

```xml
<dependency>
<groupId>org.orderofthebee.support-tools</groupId>
<artifactId>support-tools-repo</artifactId>
<version>1.0.0.0</version>
<version>1.1.0.0</version>
<type>amp</type>

This comment has been minimized.

Sign in to view

Copy link
@abhinavmishra14

abhinavmishra14 Aug 19, 2019 •
edited
Loading

Failed to retrieve the amp file after making the changes. Artifact name or version seems to be different as compared to the pom config. https://repo1.maven.org/maven2/org/orderofthebee/support-tools/support-tools-repo/1.1.0.0/support-tools-repo-1.1.0.0-amp.amp

Jar approach works fine:
<dependency> <groupId>org.orderofthebee.support-tools</groupId> <artifactId>support-tools-repo</artifactId> <version>1.1.0.0</version> <type>jar</type> </dependency>
<exclusions>
<exclusion>
<groupId>*</groupId>
<artifactId>*</artifactId>
</exclusion>
</exclusions>
</dependency>
```

In an all-in-one project you also need to add the AMP as an <overlay> to the maven-war-plugin configuration (usage for custom WAR builds may differ):

```xml
<plugin>
<artifactId>maven-war-plugin</artifactId>
<configuration>
<overlays>
<overlay />
<overlay>
<groupId>${alfresco.groupId}</groupId>
<artifactId>${alfresco.repo.artifactId}</artifactId>
<type>war</type>
<excludes />
</overlay>
<!-- other AMPs -->
<overlay>
<groupId>org.orderofthebee.support-tools</groupId>
<artifactId>support-tools-repo</artifactId>
<type>amp</type>
</overlay>
</overlays>
</configuration>
</plugin>
```

For Alfresco SDK 3 beta users:

```xml
<platformModules>
<moduleDependency>
<groupId>org.orderofthebee.support-tools</groupId>
<artifactId>support-tools-repo</artifactId>
<version>1.0.0.0</version>
<type>amp</type>
</moduleDependency>
</platformModules>
```

## Share-tier

The Admin Tools added to the Share user interface are built on Aikau. We recommend that one of the most recent releases of Aikau is used to run the tools for optimal performance, but technically we are compatible and have verified releases as far back as 1.0.67.

Including the AMP artifact into an All-in-One project created from the archetype provided by Alfresco SDK 4, the following dependency must be added to the ``*-share-docker`` sub-module of the generated project:

```xml
<dependency>
<groupId>org.orderofthebee.support-tools</groupId>
<artifactId>support-tools-share</artifactId>
<version>1.0.0.0</version>
<version>1.1.0.0</version>

This comment has been minimized.

Sign in to view

Copy link
@abhinavmishra14

abhinavmishra14 Aug 19, 2019

Same issue as repo amp, but able to retrieve jar file
<type>amp</type>
<exclusions>
<exclusion>
<groupId>*</groupId>
<artifactId>*</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.alfresco</groupId>
<artifactId>aikau</artifactId>
<version>1.0.101</version>
</dependency>
```

In an all-in-one project you also need to add the AMP as an <overlay> to the maven-war-plugin configuration (usage for custom WAR builds may differ):

```xml
<plugin>
<artifactId>maven-war-plugin</artifactId>
<configuration>
<overlays>
<overlay />
<overlay>
<groupId>${alfresco.groupId}</groupId>
<artifactId>${alfresco.share.artifactId}</artifactId>
<type>war</type>
<excludes />
</overlay>
<!-- other AMPs -->
<overlay>
<groupId>org.orderofthebee.support-tools</groupId>
<artifactId>support-tools-share</artifactId>
<type>amp</type>
</overlay>
</overlays>
</configuration>
</plugin>
```

For Alfresco SDK 3 beta users:

```xml
<shareModules>
<moduleDependency>
<groupId>org.orderofthebee.support-tools</groupId>
<artifactId>support-tools-share</artifactId>
<version>1.0.0.0</version>
<type>amp</type>
</moduleDependency>
</shareModules>
```

## Artifact Repository and Building
Expand All @@ -143,10 +79,13 @@ Currently this addon is not yet published to an artifact repository, so before y
```
mvn install
```

# Contributing

We hope to have lots of collaborators on this project. As such, we have outlined our contribution policies and proceedures in the [CONTRIBUTING.md](./CONTRIBUTING.md) document.

# Code of conduct

It is a key goal of our project to foster active participation and collaboration with the greater Alfresco community. To that end we expect folks to conform to our [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md).

# License
Expand All @@ -164,6 +103,5 @@ Original authors:
Maintainers:

- [Axel Faust](https://github.com/AFaust), Acosix / Order of the Bee
- [Ahmed Owian](https://github.com/ahmedowian)
- [Mittal Patolyia](https://github.com/mits2013)
- [Bindu Wavell](https://github.com/binduwavell), Zia / Order of the Bee
- [Younes Regaieg](https://github.com/yregaieg), Order of the Bee
Binary file added images/command_console.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit ea4df48

Please sign in to comment.