README.md

Alfresco SDK

This is the home of the Alfresco SDK. The Alfresco SDK is used by developers to build extensions for the Alfresco content management system. 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. If you are an Enterprise customer check the Support section.

News

• 2015-05-20: SDK 2.1.0 released to Maven Central. Docs for Community, Enterprise, Release notes
• 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 2.1 (latest) visit the offical Alfresco Documentation for:

• Alfresco Community 5.0.d and above
• Alfresco Enterprise 5.0.1 and above

Previous versions Documentation

• Documentation for Alfresco SDK 2.0 (compatible with Alfresco 5.0.d Community and 5.0.0 Enterprise)
• Documentation for Alfresco SDK 1.1.1 (compatible with Alfresco 4.2)

Samples

Sample extension projects that use the SDK, maintained by @ohej in the Alfresco SDK Samples project.

Want to get up to speed quickly in Eclipse? Check out this video!

Reporting Issues and Community Support

Report issues (and contribute!) here. You can also join the Alfresco list on Google Groups 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 and the Compatibily Matrix for the SDK / Alfresco compatibility. If your version is in Limited or Full Support, you can raise issues via the Support Portal.

Maven repositories

• As of version 2.0-beta-1, The Alfresco SDK is released in Maven Central. Previous versions are available in the Alfresco Artifacts Repository.
• Alfresco (Community and Enterprise) artifacts are hosted in the Alfresco Artifacts Repository.
• Alfresco Community artifacts (JARs, WARs, AMPs, poms) and SDK artifacts are publicly available.

NOTE: For Enterprise and Premiere licensed software access you need to get credential via the Alfresco Enterprise Support. See Maven Alfresco Enterprise setup.

Alfresco Artifacts Repository

Alfresco Releases

You can use the following snippet in your pom.xml to access releases on 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>

For Developers that want to contribute to the SDK

See the Developers Wiki page.