Building Confluence From Source Code

This guide describes building a confluence.war distribution or an IDE project from the Confluence source code. Plugin developers who wish to use source code as an aid in building plugins should refer to the plugin documentation. This process should be simple and quick, so please let us know if you get stuck.

Building a war distribution

Download Confluence source code.

Source code access is available for commercial license holders. If you do not have access to the source code download site, log in to my.atlassian.com as your billing contact or contact our sales department.

Confluence is built using Maven. Maven is bundled with the source distribution and therefore does not need to be installed separately. When you build Confluence, Maven will download dependencies and store them in a local repository. One of these dependencies requires manual installation for legal distribution reasons. If you do not already have it in your private repository, download JavaMail from Sun's website.

Sun will not allow Maven to redistribute its binaries. You must install all Sun binaries manually by downloading them from Sun's website and running the mvn install command. Maven has provided documentation for both 3rd party jars in general and Sun jars in particular.

Unzip the mail.jar file from the javamail-1_x_x.zip file. From the root of your extracted source code directory, run the following command, where Path/To/mail.jar is the absolute path to the extracted mail.jar file.:

.\maven\bin\mvn install:install-file -DgroupId=javax.mail -DartifactId=mail -Dversion=1.x.x -Dpackaging=jar -Dfile=Path/To/mail.jar

Run your build script.

If the build is run successfully you should have a confluence.war file created in ../confluence-project/conf-webapp/target/.

Building Individual Libraries Using Maven

Each Confluence Library is bundled with its own Maven pom file. To build one of the sub-projects, you need not build the entire source. To use the bundled maven distribution:

Copy build.sh or build.bat to the appropriate sub-directory.
Change M2_HOME to point to the parent directory, as so:
build.sh:
```
export M2_HOME="$PWD/../maven"
```
build.bat:
```
set M2_HOME=..\maven
```

Building an Intellij Idea or an Eclipse project

To build a project for an IDE, you can use the instructions above, but modify the build.sh or build.bat mvn command. Replace:
```
exec mvn clean package -Dmaven.test.skip $* with:
```
```
exec mvn idea:idea or exec mvn eclipse:eclipse
```
This should leave a project file in the root of your source directory. It should have all the confluence modules.
Download Intellij IDEA.
Install Tomcat and get it running.
In your Confluence source tree, edit confluence-project/conf-webapp/src/main/resources/confluence-init.properties. Set your home directory.
From Preferences > Application Servers add Tomcat
From Run > Edit Configurations, add a Tomcat Configuration. Select to deploy the confluence-webapp module to the appserver:
Click Configure and configure how to deploy. Choose to Create web module exploded directory and exclude from module content:
From the server tab, you might set some memory settings like:
```
-XX:MaxPermSize=256M -Xmx512m
```
Run the application. Have fun!

Creating a Server for Eclipse

In Eclipse creating a server defines creating a pointer to an existing installation of an application server.
To create a server:
Window->Show View->Servers
Right Click and select New->Server
In the menu bar click File->New->Other and expand the server folder and select the version of the serer you have installed on your system.
Click Next and the New Server wizard opens. This wizard defines a new server, that contains information required to point to a specific runtime environment for local or remote testing, or for publishing to an application server. By default, this field is pre-filled with the default address: localhost

Supported Servers in Eclipse: