Skip to content


Subversion checkout URL

You can clone with
Download ZIP
Mirror of Apache Jackrabbit Oak
Java Other
Failed to load latest commit information.
oak-auth-external [maven-release-plugin] prepare for next development iteration
oak-auth-ldap [maven-release-plugin] prepare for next development iteration
oak-authorization-cug [maven-release-plugin] prepare for next development iteration
oak-blob-cloud [maven-release-plugin] prepare for next development iteration
oak-blob [maven-release-plugin] prepare for next development iteration
oak-commons no need for toString() on a String
oak-core simplify, remove dead code
oak-doc OAK-3173 - Release Oak 1.3.4
oak-examples [maven-release-plugin] prepare for next development iteration
oak-exercise [maven-release-plugin] prepare for next development iteration
oak-http remove dead allocation
oak-it-osgi OAK-3050: Move oak-it-osgi to top level
oak-jcr OAK-3153 Make it possible to disable recording of stack trace in Sess…
oak-js OAK-103: JavaScript bindings for Oak
oak-lucene OAK-3230 Query engine should support virtual index rows
oak-parent [maven-release-plugin] prepare for next development iteration
oak-pojosr OAK-2714 - Test failures on Jenkins
oak-remote [maven-release-plugin] prepare for next development iteration
oak-run OAK-3296 Oak Explorer support for live read-only store
oak-solr-core OAK-3230 Query engine should support virtual index rows
oak-solr-osgi [maven-release-plugin] prepare for next development iteration
oak-tarmk-standby OAK-3273 ColdStandby make sync start and end timestamp updates atomic
oak-upgrade OAK-3301 AbstractRepositoryUpgrade leaks Repository instances
.gitignore Ignore IntelliJ project and workspace files
.travis.yml Also build oak-lucene, which has MongoDB based tests
LICENSE.txt OAK-1: Setup basic build structure
NOTICE.txt Update trunk version to 1.1-SNAPSHOT OAK-3008 : Training material for Oak security (WIP: first bunch of ex…
RELEASE-NOTES.txt OAK-3173 - Release Oak 1.3.4 OAK-641: Improved benchmark tooling
assembly.xml OAK-42: Prepare for first release OAK-2965 - Provide script for downloading staging artifacts
pom.xml OAK-3050: Move oak-it-osgi to top level

Jackrabbit Oak - the next generation content repository

Jackrabbit Oak is a scalable, high-performance hierarchical content repository designed for use as the foundation of modern world-class web sites and other demanding content applications.

The Oak effort is a part of the Apache Jackrabbit project. Apache Jackrabbit is a project of the Apache Software Foundation.

Getting Started

To get started with Oak, build the latest sources with Maven 3 and Java 6 (or higher) like this:

mvn clean install

To enable all integration tests, including the JCR TCK, use:

mvn clean install -PintegrationTesting

Before committing changes or submitting a patch, please make sure that the above integration testing build passes without errors. If you like, you can enable integration tests by default by setting the OAK_INTEGRATION_TESTING environment variable.

MongoDB integration

Parts of the Oak build expects a MongoDB instance to be available for testing. By default a MongoDB instance running on localhost is expected, and the relevant tests are simply skipped if such an instance is not found. You can also configure the build to use custom MongoDB settings with the following properties (shown with their default values):

Note that the configured test databases will be dropped by the test cases.


The build consists of the following main components:

  • oak-parent - parent POM
  • oak-doc - Oak documentation
  • oak-commons - shared utility code
  • oak-core - Oak repository API and implementation
  • oak-jcr - JCR binding for the Oak repository
  • oak-sling - integration with Apache Sling
  • oak-solr-core - Apache Solr indexing and search
  • oak-solr-embedded - Apache Solr on an embedded Solr instance
  • oak-solr-remote - Apache Solr on an remote (HTTP) Solr instance
  • oak-http - HTTP binding for Oak
  • oak-lucene - Lucene-based query index
  • oak-run - runnable jar packaging
  • oak-pojosr - integration with PojoSR
  • oak-upgrade - tooling for upgrading Jackrabbit repositories to Oak
  • oak-it - integration tests
    • oak-it/osgi - integration tests for OSGi
  • oak-exercise - Oak training material


The following components have been moved to the Jackrabbit Attic:

  • oak-mk-api - MicroKernel API (deprecated, see OAK-2701)
  • oak-mk - MicroKernel implementation (see OAK-2702)
  • oak-mk-remote - MicroKernel remoting (see OAK-2693)
  • oak-it/mk - integration tests for MicroKernel


(see LICENSE.txt for full license details)

Collective work: Copyright 2014 The Apache Software Foundation.

Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to You under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Something went wrong with that request. Please try again.