|Status||LEGACY. This tutorial applies to Confluence versions that have reached end of life.|
This guide describes building a 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.
Download Confluence source code.
Install restricted third party () libraries to your local Maven repository.
|Libraries||Maven groupId and artifactId||version||Download URL|
|javax.mail:mail||1.3.2||JavaMail API Release 1.3.2|
Unzip the 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:
./mvn333.sh install:install-file -DgroupId=javax.mail -DartifactId=mail -Dversion=1.x.x -Dpackaging=jar -Dfile=Path/To/mail.jar -s "settings.xml" -Dmaven.repo.local="`pwd`/localrepo"
Note: the filename of may differ depending on your version of Maven.
From the root of your extracted source code directory, run the following command, where Path/To/oracle-jdbc15.jar is the absolute path to the oracle-jdbc15 file:
./mvn333.sh install:install-file -DgroupId=com.oracle -DartifactId=oracle-jdbc15 -Dversion=22.214.171.124.0 -Dpackaging=jar -Dfile=Path/To/oracle-jdbc15.jar -s "settings.xml" -Dmaven.repo.local="`pwd`/localrepo"
This is the simplest option. From IDEA, go to File >> Open Project. Browse to the file of the individual project. If you are wanting to compile the Confluence project (as opposed to one of the libraries, say Atlassian User), use the file from the confluence-project file.
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:
Change M2_HOME to point to the parent directory, as so:
Run your build script.
If the build is run successfully you should have a confluence.war file created in confluence-project/confluence-core/confluence-webapp/target
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.
From the server tab, you might set some memory settings like:
Run the application. Have fun!
If you'd like to create a patch:
This will leave a compiled class file in the <confluence-source distribution>/confluence-project/confluence/target/classes/<path-to-class> where the path to class is the package of the class you've compiled.
In Eclipse creating a server defines creating a pointer to an existing installation of an application server.
To create a server:
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:
Eclipse view after adding Tomcat
If you get a class not found error, you may need to replace a jar file in your maven repository. Try Atlassian Answers.
Atlassian encourages our community to make use of our source code. Please be aware that upgrades may require additional modifications.