Skip to content

The Alfresco In-Process SDK is based on Apache Maven, includes support for rapid and standard development, testing, packaging, versioning and release of your Alfresco integration and extension projects

License

Alfresco/alfresco-sdk

master
Switch branches/tags
Code

Latest commit

* ACS-3556 Add maven profile for Java 17

* ACS-3556 Add range up to java 17 for java 11 profile.
4a56544

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Alfresco SDK logo Alfresco SDK

Build Status pre-commit GitHub

This is the home of the Alfresco SDK. The Alfresco SDK is used by developers to build extensions for the Alfresco Digital Business Platform. It is based on Apache Maven, compatible with major IDEs and enables Rapid Application Development (RAD) and Test Driven Development (TDD).

License

This project is released under the Apache License, Version 2.0 license. If you are an Enterprise customer check the Support section.

News

  • 2022-03: Alfresco SDK 4.4.0 released
  • 2021-10: Alfresco SDK 4.3.0 released
  • 2021-02: Alfresco SDK 4.2.0 released
  • 2019-10: Alfresco SDK 4.1.0 released
  • 2019-03: Alfresco SDK 4.0.0 released
  • 2019-03: Alfresco SDK 3.1.0 released
  • 2017-06-23: Alfresco SDK 3.0.1 released, containing a critical bugfix
  • 2017-04-01: Alfresco SDK 3.0.0 released
  • 2017-03-27: After years of hard work, countless iterations and gathering feedback, SDK 3.0 has finally been merged into the master branch, ready for release in the coming days
  • 2016-02-20: SDK 2.2.0 released to Maven Central. Docs for Community, Enterprise, Release notes
  • 2015-10-19: SDK 2.1.1 released to Maven Central. Docs for Community, Enterprise
  • 2015-05-20: SDK 2.1.0 released to Maven Central. Docs for Community, Enterprise
  • 2014-12-23: SDK 2.0.0 release to Maven Central. Docs, Release Notes
  • 2014-08-22: First SNAPSHOT of SDK 2.0.0 in the OSS Sonatype Repository!
  • 2014-07: Project fully migrated from Google Code.

User Getting Started

Important Notice about ACS 7.2

Please refer to #635 to fix the Search Services 403 problem.

Important Notice about ACS 7.1

Share Version Number

Since ACS 7.1, Share build pipeline has been refactored, and you now have to specify the internal Share version number, in addition to the version of the image, because they are not the same anymore.

This number can be located in the main pom.xml of the project used to build Share, hence:

So, if for example you want to use the community version of 7.1.0.1, you can go on acs-community-packaging, open the 7.1.0.1 release tag, browse its files, open the pom.xml in the root, then copy the value of <alfresco-community-share.version>.

You'll then need to paste this value inside the SDK property <alfresco.share.version>.

Alternate Docker User

  • ACS 6 used to run everything as root.
  • ACS 7 introduced an alfresco user, that should've been used after the root user completed its configurations in the Dockerfile.

Due to a bug, this wasn't working in earlier SDKs, and has been fixed in SDK 4.3.

In order to be retro-compatible with ACS 6, however, the user is specified in the SDK property <alfresco.platform.docker.user>.

Hence, its values (already in place) are root for ACS 6, and alfresco for ACS 7+.

Log file location

To prevent writing permission problems when logging with the non-root user, the alfresco.log file has also been moved to a more appropriate location (Tomcat logs instead of Tomcat root).

Important Notice about Version Numbers

In Q4 2020, Alfresco Platform has undergone a major structural refactoring.

Depending on the Platform version desired, you might need to use SDK 4.1 or SDK 4.3 instead of SDK 4.4.

  • For Enterprise and Community versions of 7.x, SDK 4.4 must be used
  • For Enterprise versions of 6.0.x, 6.1.x, 6.2.x newer than November 2020, SDK 4.3 must be used
  • For Enterprise and Community versions of 6.0.x, 6.1.x, 6.2.x older than November 2020, SDK 4.1 must be used

It's also important to remember that:

Latest Documentation

To get started with Alfresco SDK 4.4.x (latest) visit the Alfresco Documentation.

Documentation about Previous Versions

SDK Version Alfresco Enterprise Version Alfresco Community Version Documentation
SDK 4.4 Alfresco 7.0.x / 7.1.x / 7.2.x Alfresco 7.0.x / 7.1.x / 7.2.x https://github.com/Alfresco/alfresco-sdk/tree/master/docs/README.md
SDK 4.3 Alfresco 6.0.x / 6.1.x / 6.2.x / 7.0.x / 7.1.x Alfresco 7.0.x / 7.1.x https://github.com/Alfresco/alfresco-sdk/tree/master/docs/README.md
SDK 4.2 Alfresco 6.0.x / 6.1.x / 6.2.x / 7.0.x Alfresco 7.0.x https://github.com/Alfresco/alfresco-sdk/tree/master/docs/README.md
SDK 4.1 Alfresco 6.0.x / 6.1.x / 6.2.x Alfresco 6.0.x / 6.1.x / 6.2.x https://github.com/Alfresco/alfresco-sdk/blob/sdk-4.1/docs/README.md
SDK 4.0 Alfresco 6.0.x / 6.1.x Alfresco 6.0.x / 6.1.x https://github.com/Alfresco/alfresco-sdk/blob/sdk-4.0/docs/README.md
SDK 3.1 Alfresco 5.2.x Alfresco 5.2.x http://docs.alfresco.com/5.2/concepts/sdk-intro.html
SDK 3.0 Alfresco 5.2.x Alfresco 5.2.x http://docs.alfresco.com/5.2/concepts/sdk-intro.html
SDK 2.2 Alfresco 5.1.x Alfresco 5.1.x https://docs.alfresco.com/5.1/concepts/alfresco-sdk-intro.html
SDK 2.1 Alfresco 5.0.1 Alfresco 5.0.d https://docs.alfresco.com/sdk2.1/concepts/alfresco-sdk-intro.html
SDK 2.0 Alfresco 5.0.0 Alfresco 5.0.c https://docs.alfresco.com/sdk2.0/concepts/alfresco-sdk-intro.html
SDK 1.1.1 Alfresco 4.2.x Alfresco 4.2.x https://docs.alfresco.com/4.2/concepts/dev-extensions-maven-sdk-intro.html

Reporting Issues and Community Support

Report issues (and contribute!) here or join us on the IRC Channel.

Alfresco Enterprise Customers and Partners Support

If you are an Alfresco Customer please check the SDK Support status for the version you are using. If your version is in Limited or Full Support and you need help, visit the Support Portal.

Maven repositories

NOTE: By default the Alfresco SDK will use Community Edition releases but it can be configured to use Enterprise Edition releases. Enterprise and Premier customers can use the SDK with Enterprise Edition releases by following the process described in Working with Enterprise.

Alfresco Artifacts Repository

Alfresco Releases

You can use the following snippet in your pom.xml to access releases from the Alfresco Artifact repository:

<repository>
    <id>alfresco-public</id>
    <url>https://artifacts.alfresco.com/nexus/content/groups/public</url>
</repository>

SDK Snapshots

To test new unreleased (unsupported) features, you can use the following snippet in your pom.xml to access SDK nightlies (SNAPSHOTS) from the OSS Sonatype repository:

<repository>
    <id>oss-sonatype-snapshots</id>
    <url>https://oss.sonatype.org/content/repositories/snapshots/</url>
</repository>

Docker registries

For Developers that want to contribute to the SDK

See the Developers Wiki page.

About

The Alfresco In-Process SDK is based on Apache Maven, includes support for rapid and standard development, testing, packaging, versioning and release of your Alfresco integration and extension projects

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published