Confluence Docs 3.0 : Confluence Setup Guide This page last changed on Jan 22, 2009 by ggaskell. Before running the Confluence Setup Wizard described below, please follow the instructions on installing Confluence. When you access Confluence in your web browser for the first time, you will see the Confluence Setup Wizard. This is a series of screens which will prompt you to supply some default values for your Confluence site. It will also offer some more advanced options for setting up data connections and restoring data from a previous installation. On this page: 1. Start the Setup Wizard 2. Enter your License Key 3. Choose your Installation Type 4. Custom Installation: Database Configuration 5. Custom Installation: External Database 6. Custom Installation: Load Content 7. Custom Installation: Restore Data from Backup 8. Enter Details of your Confluence System Administrator 9. Setup is Complete # 1. Start the Setup Wizard If Confluence is not already running, i.e. if you did not configure it to start automatically during installation, you need to start it now: If you are running Confluence Standalone on Windows, click 'Start'..., 'Programs'..., 'Atlassian Confluence'..., 'Start in Console'. If you are running Confluence Standalone on a MAC, click 'Applications'..., 'Atlassian Confluence'. Or run the start-up script found in the `bin` folder of your Installation directory: `startup.bat` for Windows. `startup.sh` for Unix-based systems. Mac OS X users will be prompted to choose an application. Choose the Terminal application in the Utilities folder. Go to the following web address in your web browser: http://localhost:8080 The above web address uses port '8080'. If you chose a different port during installation, change '8080' to the number you chose. You should see the Licensing screen described below. If an error message appears, first check that you're using the port which you specified during installation. Then check the Installation FAQ. # 2. Enter your License Key Screenshot: Licensing and Installation Type
| Hint: The above image and all the images on this page are screenshots. Clicking an image will not configure Confluence.
Find your Confluence license key: If you don't have your license key handy, you can retrieve your existing key. If you do not already have a Confluence license, you can obtain one now: Copy your 'Server ID' from the Setup Wizard's Licensing screen, shown on the screenshot above. Obtain a trial, free or commercial licence. Type or paste your license key into the 'License Key' field, shown on the screenshot above. # 3. Choose your Installation Type Refer to the screenshot above. In this step, you will choose whether you want a standard or a custom installation. Option 1: Standard Installation — Set up Confluence with the embedded HSQLDB database and default settings. This option will also install a 'Demonstration Space' with some example content to get you working with Confluence as quickly and easily as possible. You may upgrade to another type of database later on.
| Hint: Who should choose this option? Choose the standard installation if you are evaluating Confluence or if you are new to Confluence. This option is not recommended for production instances of Confluence.
| For production use, we strongly recommend that you connect to an external database rather than using the embedded database. The standard installation is therefore not suitable for production installations.
Next, you will be asked for details of your system administrator. Go to step 8 below. Yes, you really can skip all the steps between Option 2: Custom Installation — Customise your Confluence instance to use your own database and your own data.
| Hint: What options does the custom installation offer? Connect Confluence to an external database. Recommended for production instances of Confluence. Restore data from an existing Confluence database. Install Confluence without the demonstration content.
# 4. Custom Installation: Database Configuration Screenshot: Database Configuration The above screen appears if you have chosen a custom installation of Confluence. You can choose to use the embedded database supplied with your Confluence installation, or to connect to an external database. Option 1: Embedded Database — If you select this option, Confluence will use an embedded HSQLDB database. You should only select this option if you are evaluating Confluence, or for demonstration purposes. You can migrate to another database later on, if you wish.
| The embedded database is not recommended for production use.
Option 2: External Database — If you wish Confluence to use an external database, select your database type from the database dropdown list and then click the 'External Database' button. Read more information about supported databases.
| For production deployments of Confluence, we recommend that you use an external database to ensure your data is kept safe and consistent.
# 5. Custom Installation: External Database
| Before you Start Character encoding: We strongly recommend that character encoding is consistent across your database, application server and web application, and that you use UTF-8 encoding. Before setting up your database, please read about configuring character encoding. Database name: When creating a new external database, give it the name 'confluence'.
You can choose to configure your database via a standard JDBC connection or via a server-managed datasource connection. Choose one of the two options below. Option 1: Standard Database Connection — This uses a standard JDBC database connection. Connection pooling is handled within Confluence. Screenshot: Standard (JDBC) Connection Supply the following information: Driver Class Name — The Java class name for the appropriate database driver. This will depend on the JDBC driver, and will be found in the documentation for your database. You will also need to put the appropriate database driver 'jar' file in the server's classpath. For the standalone version, this means copying the jar file into the `<confluence-install>/lib` directory. Database URL — The JDBC URL for the database you will be connecting to. This will depend on the JDBC driver, and will be found in the documentation for your database. User Name — A valid username which Confluence will use to access your database. Password — The password corresponding to the above username. You will also need to know: The size of the connection pool Confluence should maintain. If in doubt, just go with the default provided. What kind of database you're connecting to, so you can tell Confluence which dialect it needs to use. Option 2: Datasource Connection — This asks the Java application server for a database connection. You will need to have configured a datasource into your application server. Screenshot: Datasource Connection Supply the following information: Datasource Name — The JNDI name of the datasource, as configured in the application server. Note: Some servers will have JNDI names like `jdbc/datasourcename`; others will be of the form `java:comp/env/jdbc/datasourcename`. Consult your application-server documentation. You will also need to know: What kind of database you're connecting to, so you can tell Confluence which dialect it needs to use. # 6. Custom Installation: Load Content Screenshot: Load Content Select one of the following options: Example Site — This option will load Confluence's 'Demonstration Space'. Select this if you are using Confluence for the first time, or if you want the Demonstration Space for your other Confluence users. The Demonstration Space helps to familiarise you with Confluence and what it can do for you. You can then continue using your Confluence deployment as normal — there's no need to reinstall later. Empty Site — Select this option if you are already familiar with Confluence. You will need to create at least one space before you can start adding content to the site. Restore from Backup — Select this option if you want to use Confluence data from a previous installation. # 7. Custom Installation: Restore Data from Backup Screenshot : Restoring Data This option allows you to reload your data from an existing Confluence installation into your new Confluence site during the initial setup procedure. You can choose to upload data from a zipped backup file, or to restore from a backup file on your file system. Option 1: Upload a zipped backup to Confluence — This option will load the data from a zipped backup file. To create a backup file from your existing version of Confluence, go to the 'Backup & Restore' section of your Administration Console. To restore from a zipped backup: Browse for the relevant daily backup file or a file you have created via a manual backup. Check 'Build Index' to build the data index, used for the search. Click the 'Upload and Restore' button. Option 2: Restore a backup from the filesystem — This option is recommended if you have a very large daily backup file (greater than 100MB), or a daily backup file that is already on the server and doesn't require uploading. Copy the backup file into the `restore` directory inside your confluence Home directory and then refresh the page. You should now see your backup file appear on the 'Restore Data' screen (pictured above), in the box beneath the heading 'Restore a backup from the filesystem'. Check 'Build Index' to build the data index, used for the search. Click the 'Restore' button. When the restore process has finished, you are ready to log in to Confluence. The system administrator account and all other information has been transferred from your previous Confluence installation. # 8. Enter Details of your Confluence System Administrator Screenshot: System Administrator The system administrator has full administrative power over your Confluence instance. This person will be able to add more users, create spaces, and set further Confluence options. Please refer to the overview of global permissions for more information.
| Hint: If you are evaluating Confluence, set yourself up as the administrator.
Enter the following information to set up your system administrator's user account: Username — The username under which the system administrator will log in to Confluence, e.g. 'jsmith'. Password — The password which the system administrator will use to log in. Confirm — Enter the same password again. Name — The system administrator's full name, e.g. 'John Smith'. Email — The system administrator's email address, e.g. 'jsmith@example.com'. Click 'Next'. # 9. Setup is Complete Screenshot: Setup Complete Congratulations! You have installed and set up Confluence. Click the 'Start using Confluence now' link to open the 'Demonstration Space' in your Confluence wiki. This space contains some sample content and ideas, to help you get started quickly. ##### RELATED TOPICS Using the Confluence Dashboard Starting Confluence Automatically on System Startup Documentation Home

Document generated by Confluence on Nov 05, 2009 23:34