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.
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
To get started with Alfresco SDK 2.1 (latest) visit the offical Alfresco Documentation for:
Previous versions
- Documentation for Alfresco SDK 2.0
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 getting 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 (Compabitily Matrix)[http://docs.alfresco.com/community/concepts/alfresco-sdk-compatibility.html] for the SDK / Alfresco compatibility. If your version is in Limited or Full Support, you can raise issues via the Support Portal.
Maven repositories
The Alfresco SDK is released in Maven Central as of version 2.0-beta-1. 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.
For Enterprise and Premiere licensed software access you need to get credential via the Alfresco Enterprise Support. See docs for Enterprise.
For Developers that want to contribute to the SDK
The following section descibes how to build the SDK from source and how to generate projects based on the local build.
Prerequisites
Make sure you have setup and configured Spring Loaded, Maven, JDK, etc, see Alfresco Documentation.
Building from Source
Get the SDK source:
$ git clone https://github.com/Alfresco/alfresco-sdk.git
Step into the parent SDK project:
$ cd alfresco-sdk
Build the SDK and skip tests (skipping tests is useful if you don't have access to Enterprise artifacts):
alfresco-sdk$ mvn clean install -Dmaven.test.skip=true
Generating an extension project from the local build
$ mvn archetype:generate -DarchetypeCatalog=local
This project is released under the Apache License, Version 2.0. It's a community driven project which is supported for Alfresco Development (please refere to the official Alfresco Documentation for supported features.