Documentation for Confluence 5.4.
Documentation for Confluence OnDemand and earlier versions of Confluence is available too.

Skip to end of metadata
Go to start of metadata

These instructions apply to:

Icon
  • Confluence distributed as an archive file. This distribution includes Apache Tomcat as the application server. 
  • Windows systems. For other operating systems please refer to the Confluence Installation Guide.
  • Manual installation and configuration using a zipped download file. For a simpler installation process, please use the  Confluence Installer instead.

Also, please check that the version of Confluence which you are installing coincides with the version that this documentation is written for.

On this page:

1. Before you Start

Please check the following points:

  1. Ensure that your system meets the minimum requirements to run Confluence. For more information, please refer to our Supported Platforms topic and for further details, our System Requirements topic.
  2. Have your Confluence license key ready. You can obtain a trial, free or commercial license now, or retrieve your existing license key.

2. Install Java

Please refer to Installing Java for Confluence. If you are certain that this has already been installed and that the JAVA_HOME environment variable has been correctly configured, then proceed to the next step.

3. Download the Confluence Installation File

  1. If you have not downloaded Confluence already, download the zip file.
  2. Please check your unzip program before extracting the downloaded zip file. You should use a third-party unzip program like 7Zip or Winzip. If you do not have one, please download and install one of these before continuing:
    • 7Zip (recommended). If in doubt, download the '32-bit.exe' version.
    • Winzip.
  3. Use your unzip program to unzip the installation file to a directory such as c:\confluence.
    • Do not use spaces in your directory path.

(info) 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.
(tick) Tip: Another term for 'home directory' would be 'data directory'.

We suggest using different paths for your installation and home directories. This will facilitate easier upgrades.

Examples of Installation and Home Directories

Icon

Installation directory: c:\confluence\confluence-vX.X
Home directory: c:\confluence\data

  1. Open your Confluence Installation directory (created when you unzipped Confluence — see above).
  2. Under the Installation directory, open this file: confluence\WEB-INF\classes\confluence-init.properties in a text editor such as Notepad.
  3. Scroll to the bottom of the text and find this line:

  4. 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 confluence.home
  5. If you decide to change the Confluence Home directory from the default, please note the following:
    • Avoid spaces in the directory path or file name.
    • Use forward slashes '/' to define the path.

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 an 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.xml under your Confluence Installation directory. The first four lines of the file look like this:
    Default conf/server.xml

    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.


    (tick) 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.xml file, using ports '8020' and '8099':

    Modified conf/server.xml using ports 8020 and 8099

    To access Confluence in this configuration, point your web browser to http://localhost:8099/.

    Icon

    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.

    Once this is working, if this is the URL your users will use, remember to update your Base URL to point to the new URL.

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.

(info) 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 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

  1. Go to your Confluence Installation directory (created when you unzipped Confluence — see above).
  2. Under your Confluence Installation directory, open the bin directory and run the startup script: startup.bat. A command prompt window should appear.
    (warning)Please do not close this command prompt window. If you do so, Confluence will stop running.

    Troubleshooting

    Icon

    If the window closes immediately when started, this means that an error is preventing Confluence from starting. To view this error:

    1. Open a command prompt: Click on your 'Start' menu, then click 'Run'. In the Run box, type cmd and click 'OK'.
    2. From the command prompt, go to your Confluence Installation directory.
    3. Go into the bin subdirectory.
    4. Run catalina.bat run.
      (warning) You should not run startup.bat at this point, because that would still produce a popup window that would close straight away.
    5. Read the error message.
    6. Find the solution to that error in the Installation Troubleshooting section of the Confluence Knowledge Base.
  3. Once Confluence is running, open a web browser and visit http://localhost:8090/.
    (tick) If you changed the port earlier, use the port you specified in step 5 above.
    (info) If your web browser window shows an error, try waiting for 30 seconds or so and then refresh the browser page.

8. Next Step is the 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.

9. Start Confluence automatically on Windows as a Service

Confluence should be run as a service.

Related Topics

Change listen port for Confluence
Running Confluence Over SSL or HTTPS
Confluence Setup Guide
Configuring Confluence
Confluence Documentation Home

  • No labels

25 Comments

  1. Anonymous

    I have an existing TOMCAT server running, and altered the ports accordingly but still had to do one more thing to make it work.

    The catalina.bat reads your system wide CATALINA_HOME and CATALINA_OPTS , and thus it will still try to start your default instance unless you specifically tell it not to.

    I changed setenv.bat.

    Add:

    SET CATALINA_HOME=./..

    and run that before starting the server.

  2. Anonymous

    At which point would you suggest installing Apache Tomcat?

    1. Hi,
      If you are using the Confluence edition, you don't have to install Apache Tomcat since Confluence includes Apache Tomcat as the application server. If you are referring to other edition please refer Confluence Installation Guide for more details.

      Cheers,
      Komathi

      1. Anonymous

        Thanks for your response!  I was under the impression that the standalone application contains everything necessary for evaluation purposes.  I do not wish to evaluate the product, I want to launch it for production use immediatly.  I see on the System Requirements page that Tomcat is included, but is this ok for production use or evaluation purposes? I thought Apache Tomcat, MySQL and the JDK had to all be installed prior to the installation of Confluence.  I'm finding documentation is confusing, and would appreciate some clarification.

        Do I need to install Apache Tomcat, MySQL and the JDK prior to the installation of Confluence?
        This page states the database should be installed prior to Confluence, yet the documentation on setting up said database instructs you to stop the confluence process and talks about migrating information.

        What would you suggest as the best process of steps for installing Confluence standalone on a blank windows server?

        Right now I have:

        1. Install JDK
        2. Set the JAVA_HOME variable
        3. Download and Unzip Confluence Installation files
        4. Define the Home Directory
        5. Check the Ports
        6. Install MySQL?
        7. Create a Database for Confluence?
        8. Start Confluence? Initiate Wizard?

        If Tomcat comes complete for production use, then please advise on action concerning the Database.  Thanks for your help.

        1. Hello there,

          The Confluence Standalone edition (which includes Apache Tomcat) is fine for production use.

          To summarise the Confluence setup, Apache Tomcat is the Application Server that runs Confluence. Additionally, since Apache Tomcat is essentially a Java application, it requires a Java Development Kit (JDK) to run.

          Hence, the order of steps you have suggested for setting up Confluence is correct for the Confluence Standalone edition!

          Assuming you're installing Confluence Standalone, your step 3 (above) will install both Confluence and Apache Tomcat together (i.e. taking the form of Confluence application files embedded within a Tomcat installation).

          Once you have installed the JDK and Confluence Standalone (and have implemented the required configurations for your Confluence Home Directory), you should then install and configure your database (MySQL). This should be done before you actually start Confluence, because Confluence's setup wizard executes upon its first run, one step of which involves establishing a connection to your database.

          If your database connection is successful, your Confluence-specific database is automatically created by Confluence. Hence, there will be no need for you to perform step 7 (above) manually.

          Please take note of the following additional points, which may influence how you set up your Confluence installation:

          • You can also install and use a PostgreSQL database with Confluence, which is one of the database applications that we recommend.
          • You may also need to add the appropriate JDBC driver for your database to your Confluence installation. This is usually done by copying the appropriate jar file (downloadable from the Internet) to your Confluence's ../WEB-INF/lib folder. This allows Confluence to connect to your database.

          I hope this information helps. However, please feel free to ask any further questions if you have any further uncertainties.

          Best regards,

          Giles Gaskell
          Technical Writer
          ggaskell@atlassian.com
          ATLASSIAN - http://www.atlassian.com

  3. Anonymous

    Hello!

    I think there is a minor bug in the description how to start the Confluence Setup Wizard (7. Start Confluence).

    If the default server.xml for confluence is used (nothing is changed), the path would be http://localhost:8080/confluence (if you take the link http://localhost:8080/ you just get the tomcat manager).

    Here is the entry in the server.xml of confluence:

  4. Anonymous

    Hello.

    Can Confluence 3.1 and Jira 4.0.1 run on the same server?

    Cheers,

    Johan

    1. Hi Johan,

      Can Confluence 3.1 and Jira 4.0.1 run on the same server?

      As far as I know you can run Confluence 3.1 and Jira 4.0.1 run on the same server.

      Hope that helps
      Best rgds,
      Zed

  5. Anonymous

    I am installing the evaluation copy on shared hosting.  How do i run catalina.bat under those circumstances (FTP access only)?  Is there a work around?

    1. I'm afraid that FTP access in insufficient. You need a shell access (telnet, ssh, etc.) in order to run the startup script. Please also ensure that the hosting server is not just for file hosting, but for JAVA hosting, too.

  6. Anonymous

    Hello,

    if you are using windows 7 (64 bits) does confluence standalone zip contains a compatible tomcat ?

    1. Hi,

      It is known that installing Confluence standalone into Windows 7 64 bits will have issue in running Confluence as services.

      Unfortunately there are no Confluence bundled with a compatible Tomcat available at the moment.

      However, you may refer the documentation here for the workaround.

      Regards,
      HengHwa

  7. Anonymous

    Thanks for the answer. What about if you run the tomcat of the standalone distribution directly ?

    1. The Tomcat shipped in the standalone edition is 32-bit. In case you are using 64-bits OS and that you like to run it as a service, the KB article still applies.

  8. The Confluence doco says

    'If you are certain that this has already been installed and that the JAVA_HOME environment variable has been correctly configured, then proceed to the next step."

    I'd just like to note that this is not necessarily the show-stopper it appears to be. After spending many hours trying to get the JAVA_HOME variable to be recognised on a Windows 7 64 bit Professional machine, I decided to just go ahead and install Confluence anyhow, and I'm happy to say that it runs fine, even though the %JAVA_HOME% command returns the following error message:

    1. Anonymous

      You probably didn't enter the console command correctly. It should be echo %JAVA_HOME% 

  9. Hi. I'm trying to install Confluence on to a stand-alone PC using Windows Vista Business edition. I've successfully installed Java as per his instructions and the JAVA HOME environment. I unzipped the Confluence 3.4.3-std.zip file using 7Zip ( downloaded specially for the purpose) but 7Zip said "cannot open the output file" for 344 of the 1898 files in the zipped folder.

    How should I proceed, please?

    1. Hi Andrew,

      This might not be a timely response. But what you encountered is normally caused by a corrupted download file. You might want to re-download again. In case you are still having problem, the valid MD5 sum for confluence-3.4-std.zip is:

      d7d2d1ff293d619092108475f7a8749e
      

      If none helps, please raise a support ticket here and we'll be glad to help! (smile)

      Cheers,
      Husein

  10. In:

    2. Under the Installation directory, find this file:\confluence\WEB-INF\classes\confluence-init.properties

    This path is better written without a preceding \, i.e.: confluence\WEB-INF\classes\confluence-init.properties

    As this is a relative not absolute path.

    1. Done. Thanks for pointing that out, Martin! (smile)

      Cheers,
      Husein

  11. Anonymous

    I have an existing install for which I want to go to the Setup Wizard to modify the database URL. However, when I start the confluence using the .bat file and go to the URL http://localhost:8080, it takes directly to the Confluence login page. How do I go to the set wizard page shown above in an existing installation.

  12. Anonymous

    There appears to be a file missing in the install package.  In the installation step 7, it states: Under your Confluence Installation directory, open the bin directory and run the startup script: startup.bat.

    However, I do not have startup.bat.  The closest is startup.sh (which is a *nix script).  I downloaded confluence-3.5.5-std.zip from the Windows tab.

    Where can I get the startup.bat file?

    1. Anonymous

      Me again .. scratch that.

      Something weird went on with unzipping the file - I unzipped it from a network folder instead of a local copy.  Some of the files weren't extracted (whereas it was fine with the local zip file).  Go figure!!?

  13. Under 7. Troubleshooting, I entered the following in a command prompt, but it's not working (see message below).  I installed Confluence 3.2 on my Windows 7 64-bit for a standalone installation.  (I installed a previous version of Confluence since I had uninstalled it, and I'm trying to restore my backup file.) 

    Please let me know what I'm doing wrong.

    Thanks.

    C:\Users\gwadley>C:\confluence\confluence-3.2-std{color}
    'C:\confluence\confluence-3.2-std\' is not recognized as an internal or external

     command,
    operable program or batch file.

  14. Anonymous

    I have installed confluence in my system.  When I open confluence in a browser then it asks for user name and password.  How do I know my username and password?