Getting Started

1. Download

Download the package that best suits you:

 

Zanata Server: Easiest way to get Zanata up and running. Extract the contents of this file. The following steps will refer to this location as <ZANATA DIR>.

 

Zanata Web Archive: For more experienced users. You will need to provide a JBoss installation, configure it, and deploy Zanata manually.

2. Setup the Zanata Database

Zanata has been thoroughly tested against MySQL 5 so it's recommended that you install and use it with Zanata. You can download a copy Here.

 

Once you have installed the Database server, create a database schema for Zanata (make sure the default collation is UTF-8).

 

Now you only need to tell Zanata where to find this database. To do this, open the file:

 

<ZANATA DIR>/server/zanata/deploy/zanata-ds.xml

 

This file contains the database settings for Zanata. Modify the values for the following properties according to the database instance you have created for zanata. (If you are using MySQL as recommended, you will only need to change these):

 

connection-url This is the database location. By default it is configured to localhost, port 3306 and a schema named 'zanata'.

user-name Database user name. This user name should have full table creation permissions on the database instance.

password Database password.

3. Configure Zanata

From version 2.0.x onwards, Zanata will no longer create an admin user by default. Instead, edit the file located at

 

<ZANATA DIR>/server/zanata/conf/zanata.properties

 

by adding (or uncommenting) the following line:

 

zanata.security.admin.users = admin

 

Now register a user under the name "admin", and it will automatically have administrator privileges. Any number of users may be added to this list in a comma-separated format.

 

In the same file, configure other properties to your particular setup. The following properties should be configured in order for Zanata to run properly:

zanata.email.default.from


This is the default email address that will appear as sender on Zanata emails.

The following properties relate to the SMTP email server that Zanata uses to send emails. It defaults to a locally installed server using port 25. If a particular property does not apply to the email server being used, it may be commented out by placing a '#' character at the beginning of the property name.

zanata.smtp.host
zanata.smtp.port
zanata.smtp.username
zanata.smtp.password
zanata.smtp.tls
zanata.smtp.ssl

 

4. Start Zanata

Starting zanata is as easy as running the 'start-zanata' executable found at

 

<ZANATA DIR>/bin/start-zanata.sh

 

... or for Windows users

 

<ZANATA DIR>/bin/start-zanata.bat

5. Start Using it!

Zanata should be available at

 

http://localhost:8080/zanata

 

For more information, check out our documentation section.

 

A few things to note:
JBoss AS 5 doesn't like being placed on a path with spaces.
Zanata requires an email (SMTP) server to perform certain notifications.
Make sure you are using JDK version 6 or higher.