Installing Confluence on Windows from Zip File

Installing Confluence on Windows

On this page

Related content

Still need help?

The Atlassian Community is here for you.

Ask the community

In this guide we'll run you through installing Confluence in a production environment, with an external database, manually using a zip file.

This method gives you the most control of the installation process.

 

 

Other ways to install Confluence: 

  • Evaluation - get your free trial up and running in no time.
  • Installer – install Confluence using the Windows installer. 
  • Linux – install Confluence on a Linux operating system.

Before you begin

Before you install Confluence, there's a few questions you need to answer. 

 

Are you using a supported operating system and Java version?
Tell me more about this...

Check the Supported Platforms page for the version of Confluence you are installing. This will give you info on supported operating systems, databases and browsers.

Good to know:

  • We don't support installing Confluence on OSX.
  • We don't support OpenJDK. You'll need to install the Oracle Java JRE or JDK.
  • You can use either the JDK (Java Development Kit) or JRE (Java Runtime Environment).
  • We only support the version of Apache Tomcat that is bundled with Confluence.
Do you want to run Confluence as a Windows Service?
Tell me more about this...

Running Confluence as a service in Windows means that Confluence will automatically start up when Windows is started.

You should use the Windows installer if you want to run Confluence as a Service.

If you choose not to run Confluence as a service:

  • You will start and stop Confluence by running the start-confluence.bat file in your Confluence installation directory.
  • Confluence will be run as the Windows user account that was used to install Confluence, or you can choose to run as a dedicated user (this user must have full read and write access to the installation directory and home directory).
  • Confluence will need to be restarted manually if your server is restarted.
What database do you plan to use? 
Tell me more about this...

To run Confluence in production you'll need an external database. Check the Supported Platforms page for the version you're installing for the list of databases we currently support. If you don't already have a database, PostgreSQL is free and easy to set up.

Good to know:

  • Set up your database before you begin. Step-by-step guides are available for PostgreSQL, Oracle, MySQL, and SQL Server.
  • Use UTF-8 character encoding. See Configuring Character Encoding for more info.
  • If you're using Oracle or MySQL you'll need to download the driver for your database.
  • The embedded H2 database can be used for evaluating Confluence, but you'll need to migrate to another database before running in production. You may find it easier to use external database from the start.

Do you have a Confluence license?

Tell me more about this...

You'll need a valid Confluence Server license to use Confluence.

Good to know:

  • If you have not yet purchased a Confluence license you'll be able to create an evaluation license during setup.
  • If you already have a license key you'll be prompted to log in to my.atlassian.com to retrieve it, or you can enter the key manually during setup.
  • If you're migrating from Confluence Cloud, you'll need a new license.

Is your JAVA_HOME variable set correctly?
Tell me more about this...

Before you install Confluence, check that you're running a supported Java version and that the JAVA_HOME environment variable is set correctly.

To check the JAVA_HOME variable:

Open a command prompt and type echo %JAVA_HOME% and hit Enter. 

  • If you see a path to your Java installation directory, the JAVA_Home environment variable has been set correctly.
  • If nothing is displayed, or only %JAVA_HOME% is returned, you'll need to set the JAVA_HOME environment variable manually. See Setting the JAVA_HOME Variable in Windows for a step by step guide.

 

Install Confluence

1. Download Confluence

Download the zip file for your operating system – https://www.atlassian.com/software/confluence/download. 

2. Create the installation directory

  1. Create your installation directory (with full control permission) – this is where Confluence will be installed. Avoid using spaces or special characters in the path. We'll refer to this directory as your <installation-directory>. 

  2. Extract the Confluence zip file to your <installation-directory>. We recommend using 7zip or Winzip.

3. Create the home directory

  1. Create your home directory (with full control permission) – this is where Confluence data like logs, search indexes and files will be stored. This should be seperate to your installation directory. We'll refer to this directory as your <home-directory>. 
  2. Edit <installation-directory>\confluence\WEB-INF\classes\confluence-init.properties.

  3. At the bottom of the file, enter the path to your <home directory>.

    Show me how to do this...

    You can edit the confluence-init.properties file in Notepad or any other text editor.

    1. Scroll to the bottom of the text and find this line:

      # confluence.home=c:/confluence/data

    2. Remove the '#' and the space at the beginning of this line (so Confluence doesn't regard the line as a comment)

      confluence.home=c:/data/confluence-home
    3. If you decide to use a different directory as the home directory you should:
      • Avoid spaces in the directory path or file name.

      • Use forward slashes '/' to define the path in this file.

4. Check the ports

By default Confluence listens on port 8090. If you have another application running on your server that uses the same ports, you'll need to tell Confluence to use a different port. 

Show me how to do this...

To change the ports:

  1. Edit <installation-directory>\conf\server.xml

  2. Change the Server port (8000) and the Connector port (8090) to free ports on your server.

    In the example below we've changed the Server port to 5000 and the Connector port to 5050.

    Server port="5000" shutdown="SHUTDOWN" debug="0">
  <Service name="Tomcat-Standalone">
    <Connector port="5050" connectionTimeout="20000" redirectPort="8443"
        maxThreads="48" minSpareThreads="10"
        enableLookups="false" acceptCount="10" debug="0" URIEncoding="UTF-8"
        protocol="org.apache.coyote.http11.Http11NioProtocol" />

 

5. Start Confluence

  1. Run <installation-directory>/startup.bat to start the install process.  
     
    A command prompt will open. Closing this window will stop Confluence.
     
  2. Go to http://localhost:8090 to launch Confluence in your browser (change the port if you've updated the Connector port).
      
Trouble starting Confluence?

 

Set up Confluence

6. Choose installation type

  1. Choose Production installation. 
      
  2. Choose any add-ons you'd also like to install.

7. Enter your license

Follow the prompts to log in to my.atlassian.com to retrieve your license, or enter a license key. 

8. Connect to your database

  1. If you've not already done so, it's time to create your database. See the 'Before you begin' section of this page for details. 
     
  2. Select your database from the dropdown menu and choose External Database.
     

  3. Choose how you want to connect to your database:
     

    Direct JDBC connection...

    This option uses a standard JDBC database connection. Connection pooling is handled within Confluence.

    If you're using Oracle or MySQL there's an extra step: 

    • Download and and extract the appropriate Database JDBC Drivers.
    • Drop the JAR file into your <confluence-installation>/confluence/WEB-INF/lib folder before continuing with the setup wizard.

    In the setup wizard:

    • Driver Class Name – the Java class name for your database driver. If you're not sure, check the documentation for your database.
    • Database URL – the JDBC URL for your database. If you're not sure, check the documentation for your database.
    • Username and Password – A valid username and password that Confluence can use to access your database.
    Datasource...

    This option asks the application server (Apache Tomcat) for a database connection. You'll need to manually add the datasource to the server.xml file before you can continue.

    To set up a datasource follow our guide for your database:

    In the setup wizard:

    • Datasource Name – this is JNDI name of the datasource, as configured in the server.xml file.
      Some servers will have JNDI names like jdbc/datasourcename; others will be like java:comp/env/jdbc/datasourcename.

9. Populate your new site with content

Choose whether you'd like Confluence to populate your site with content:
 
Demonstration space...

 This option will create a space that you and your users can use to get to know Confluence. You can delete this space at any time.

Import data from an existing site...

Use this option if you have a full site export of an existing Confluence site. This is useful when you’re migrating to another database or setting up a test site.  

Good to know:

  • You can only import sites from the same or earlier Confluence version.
  • The system administrator account and all other user data and content will be imported from your previous installation.

In the setup wizard:

  • Upload a backup file – use this option if your site export file is small (25mb or less).

  • Restore a backup file from the file system – use this option if your backup file is large. Drop the file into your <confluence-home>/restore directory then follow the prompts to restore the backup.

  • Build Index – we’ll need to build an index before your imported content is searchable. This can take a long time for large sites, so deselect this option if you would rather build the index later. Your content won't be searchable until the index is built.

10. Choose where to manage users

Choose to manage Confluence's users and groups inside Confluence or in a JIRA application, such as JIRA Software or JIRA Service Desk:
 
Manage users and groups in Confluence...

Choose this option if you're happy to manage users in Confluence, or don't have a JIRA application installed.

Good to know:

  • If you do plan to manage users in a JIRA application, but have not yet installed it, we recommend installing JIRA first, and then returning to the Confluence setup.
  • You can add external user management (for example LDAP, Crowd or JIRA) later if you choose.
Connect to JIRA...

 Choose this option if you have a JIRA application installed and want to manage users across both applications.

Good to know:

  • This is a quick way of setting up your JIRA integration with the most common options. 
  • It will configure a JIRA user directory for Confluence, and set up application links between JIRA and Confluence for easy sharing of data.
  • You'll be able to specify exactly which groups in your JIRA app should also be allowed to log in to Confluence. Your license tiers do not need to be the same for each application. 
  • You'll need either JIRA 4.3 or later, JIRA Core 7.0 or later, JIRA Software 7.0 or later, or JIRA Service Desk 3.0 or later.

In the setup wizard:

  • JIRA Base URL – the address of your JIRA server, such as http://www.example.com:8080/jira/ or http://jira.example.com/

  • JIRA Administrator Login – this is the username and password of a user account that has the JIRA System Administrator global permission in your JIRA application. Confluence will also use this username and password to create a local administrator account which will let you access Confluence if JIRA is unavailable. Note that this single account is stored in Confluence's internal user directory, so if you change the password in JIRA, it will not automatically update in Confluence.
  • Confluence Base URL – this is the URL JIRA will use to access your Confluence server. The URL you give here overrides the base URL specified in Confluence, for the purposes of connecting to the JIRA application.
  • User Groups – these are the JIRA groups whose members should be allowed to use Confluence. Members of these groups will get the 'Can use' permission for Confluence, and will be counted in your Confluence license. The default user group name differs depending on your JIRA version:
    • JIRA 6.4 and earlier: jira-users. 
    • JIRA Software 7.x and later: jira-software-users
    • JIRA Core 7.x and later: jira-core-users
    • JIRA Service Desk 3.x and later: jira-servicedesk-users
  • Admin Groups – provide one or more JIRA groups whose members should have administrative access to Confluence. The default group is jira-administrators. These groups will get the system administrator and Confluence administrator global permissions in Confluence.

11. Create your administrator account

Enter details for the administrator account.  

Skip this step if you chose to manage users in a JIRA application or you imported data from an existing site. 

12. Start using Confluence

That's it! Your Confluence site is accessible from a URL like this: http://<computer_name_or_IP_address>:<port>

Here's a few things that will help you get your team up and running:

Troubleshooting

Running into problems installing Confluence?
  • If your web browser window shows an error the first time you try to access Confluence, wait for 30 seconds or so and then refresh the page.
  • If the command prompt window closes immediately, your JAVA_HOME variable may not be set correctly. See Setting the JAVA_HOME Variable in Windows. 

 Head to Installation Troubleshooting in our Knowledge Base for more help.  

Last modified on Sep 5, 2016

Was this helpful?

Yes
No
Provide feedback about this article

Related content

Powered by Confluence and Scroll Viewport.