Skip to content
The Alfresco SDK based on Apache Maven, includes support for rapid and standard development, testing, packaging, versioning and release of your Alfresco integration and extension projects
Java Batchfile Shell JavaScript Dockerfile FreeMarker Other
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

Alfresco SDK logo Alfresco SDK

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

  • 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

Latest Documentation

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

Documentation about Previous Versions

SDK Version Alfresco Enterprise Version Alfresco Community Version Documentation
SDK 4.0 Alfresco 6.0.x / 6.1.x Alfresco 6.0.x / 6.1.x https://github.com/Alfresco/alfresco-sdk/tree/master/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.

You can’t perform that action at this time.