Chapter 1. Getting started

Welcome to Hibernate Search! The following chapter will guide you through the initial steps required to integrate Hibernate Search into an existing Hibernate enabled application. In case you are a Hibernate new timer we recommend you start here.

1.1. System Requirements

Table 1.1. System requirements

Java Runtime A JDK or JRE version 5 or greater. You can download a Java Runtime for Windows/Linux/Solaris here.
Hibernate Search hibernate-search.jar and all runtime dependencies from the lib directory of the Hibernate Search distribution. Please refer to README.txt in the lib directory to understand which dependencies are required.
Hibernate Core This instructions have been tested against Hibernate 3.3.x. You will need hibernate-core.jar and its transitive dependencies from the lib directory of the distribution. Refer to README.txt in the lib directory of the distribution to determine the minimum runtime requirements.
Hibernate Annotations Even though Hibernate Search can be used without Hibernate Annotations the following instructions will use them for basic entity configuration (@Entity, @Id, @OneToMany,...). This part of the configuration could also be expressed in xml or code. However, Hibernate Search itself has its own set of annotations (@Indexed, @DocumentId, @Field,...) for which there exists so far no alternative configuration. The tutorial is tested against version 3.4.x of Hibernate Annotations.

You can download all dependencies from the Hibernate download site. You can also verify the dependency versions against the Hibernate Compatibility Matrix.