These instructions apply to:
- Confluence distributed as an archive file. The distribution includes Apache Tomcat as the application server.
- Linux or Solaris systems. If you are installing Confluence on a different system, please refer to Installing Confluence.
Also, please check the version of Confluence which you are installing. Refer to the documentation home page to verify the latest Confluence version and to find documentation for older versions.
Hint: If you are evaluating Confluence on Solaris or you are unsure which version to install, this is the one to use.
On this page:
1. Before you Start
Please check the following points:
- Ensure that your system meets the minimum requirements to run Confluence. For more information, please read the detailed System Requirements.
- Have your Confluence license key ready. You can obtain a trial, free or commercial license, or retrieve your existing license key at my.atlassian.com.
- You must be able to use a command prompt and install Java to continue. If not, please contact your system administrator to assist you or consider the Confluence Hosted evaluation option.
- Make sure that you use a Gnu version of zip application - Solaris and AIX are known to have problems with zip, because they use their own (old) versions instead of the Gnu version.
2. Install Java
- If you are not sure whether you have Java installed correctly, please confirm by doing the following:
- Open a shell console.
echo $JAVA_HOMEin the shell console and then press Enter
- View the result:
- If a line is displayed such as
/usr/lib/jvm/java-6-sun, then Java is installed and properly configured.
- If nothing is displayed, then you either need to install Java or set the
$JAVA_HOMEenvironment variable. You can set this environment variable in your user account's 'profile' file. Alternatively, you can set this after installing Confluence (in step 4 below) by defining this path in your Confluence installation's
setenv.shfile, usually located in the Confluence
- If you have installed Sun JSSE package. and you want to use SSL then you need to install the
- If a line is displayed such as
- If you need to install Java, follow these instructions:
- Go to the Java download page.
- Download the latest JRE or JDK that is listed on the Confluence Supported Platforms page. (Confluence works with either the JDK or the JRE.)
- When the download has finished, run the Java installer. Detailed installation instructions are provided on Oracle's website.
Note: you will be asked to choose an installation directory. Make a note of this directory for use later.
3. Download and Extract the Confluence Installation File
- If you have not downloaded Confluence already, download the TAR.GZ file.
Use your unzip program to unzip the installation file to a directory such as
Most Linux/Solaris users can use any unzip program (such as GNU Tar) to extract the Confluence installer. However, Solaris users should not use the Solaris Tar program due to a known issue associated with its use in extracting Confluence. Use another application such as GNU Tar instead.
For example, change directory to your home directory in Linux and enter the following commands in the shell console:
tar -xf confluence-<version>-std.tar
<version>refers to the Confluence version you downloaded.)
As usual on Linux/Solaris-based operating systems, avoid using spaces in your directory path. The directory into which you unzipped the Confluence installation is called the Confluence Installation directory. Next you will define the Confluence Home directory.
4. Define your Confluence Home Directory
Now you need to define the Confluence Home directory. This is where Confluence will store its configuration information, indexes and attachments.
Tip: Another term for 'Home directory' would be 'data directory'.
We suggest using different paths for your installation and home directories. This will facilitate upgrades. Examples of Installation and Home Directories:
- Installation directory:
If you wish to install or maintain multiple versions of Confluence, you can add a version number to the Confluence installation directory name like
/usr/local/confluence-3.1-std/and optionally, create the symbolic link
/usr/local/confluence/that points to
- Home directory:
- Open your Confluence Installation directory (created when you unzipped Confluence — see above).
- Under the Installation directory, find this file:
- Open the
confluence-init.propertiesfile in a text editor.
Scroll to the bottom and find this line:
- Remove the '#' and the space at the beginning of this line, so that Confluence no longer regards the line as a comment. The line should now begin with
If you decide to change the Confluence Home directory from the default, use an absolute path rather than a symbolic link to specify the path and file name. For example:
5. Check the Ports
If you have another application running on your machine which is using the same ports that Confluence uses by default, you may need to change the port which Confluence will use. For example, if you have a installation of JIRA running on this machine, JIRA might be already using the port which Confluence requests by default.
By default, Confluence listens on port '8090'. If this port is already in use in your installation, follow these instructions to change the ports:
- To change the ports for Confluence, open the file
conf/server.xmlunder your Confluence Installation directory. The first four lines of the file look like this:
You need to modify both the server port (default is 8000) and the connector port (default is 8090) to ports that are free on your machine. The server port is required by Tomcat but is not user facing in any way. The connector port is what your users will use to access Confluence, eg in the snippet above, the URL would be http://example.com:8090.
Hint: You can use netstat to identify free ports on your machine. See more information on using netstat on Windows or on Linux.
For example, here are the first four lines of a modified
server.xmlfile, using ports '8020' and '8099':
To access Confluence in this configuration, point your web browser to http://localhost:8099/.
If this is the URL your users will use to access Confluence, update your Base URL to point to the new URL.
- You should also ensure at this point that if you are using a firewall, it is configured to allow http/https traffic over the port you have chosen.
You will find more information on this page.
6. Select an External Database
This step is optional for users evaluating Confluence. However, if you are installing Confluence for production purposes, this step is mandatory. Please refer to the database requirements listed on our System Requirements topic for help in choosing an external database.
External databases are those listed on our Supported Platforms topic, excluding HSQLDB, which is bundled with Confluence and should not be used in production.
When you have chosen your external database, follow the appropriate database setup guide to set up your database to work with Confluence.
You can learn more about migration from an existing installation or use of the evaluation database here. You will continue to use the Database Setup Guide during the Confluence Setup Wizard. (See step 8 below.)
7. Start Confluence
- Go to your Confluence Installation directory (created when you unzipped Confluence — see above).
- Under your Confluence Installation directory, open the
bindirectory and run the startup script:
- Once Confluence is running, open a web browser and visit http://localhost:8090/.
Hint: If you changed the port earlier, use the port you specified in step 6 above.
8. Confluence Setup Wizard
The Confluence Setup Wizard should appear in your web browser, prompting you to enter your license key. Follow the instructions on the screens, and read more guidelines on the Confluence Setup Wizard.