Configuration

We've prepared the following sections to guide you through the installation:

• Requirements
• Installing Mailsync
• Configuring
• How to check Mailsync status?

Requirements

To run Mailsync you will need 20-30MB RAM. It was developed, tested and works on Debian (6.0), Ubuntu (10.04+), CentOS (6.0), Fedora (11+) and Amazon Linux AMI servers running Python 2.6/2.7.

Installing Mailsync

At this point you should have downloaded the archive - either zip or tar.gz from http://mailsync.github.io . There are few steps in order to install Mailsync

1. Extract the archive
2. Run the install script ./install.sh.
3. To ensure proper installation have in mind that a number of operations are executed with sudo privileges.
4. To start Mailsync just use mailsync start.
5. Stop with mailsync stop.

Configuring

Mailsync has only one configuration file and you can find it at /etc/mailsync.conf. The configuration file is in JSON, so after editing it, you can easily check if the syntax is valid at: http://jsonlint.com/. Example configuration file with all the parameters can be found here.

The configuration file has the following parameters:

web_app: Configuration options for the web interface

host: The host where the web application is running. Default value: 127.0.0.1

port: The port where the web application is running. Default value: 4321

timezone: Timezone settings. Default Value: Europe/London. Mailsync is using UTC and this option helps you display the right time in your local timezone. You can always check your timezone and learn more here.

How to check Mailsync status?

Mailsync is a web application. For convinience it is controlled by a system daemon. The daemon is located in /etc/init.d/mailsync. The daemon accepts the following commands:

status: returns the current status of the web app. This command should return something like Mailsync ... version ... is running as PID. The web interface is running on http://127.0.0.1:4321

restart: restarts the web application

stop: stops the web application or use mailsync stop

start: starts the web application and displays The web interface is running on http://127.0.0.1:4321. For quick start: mailsync start.

You can control both the port and the host from the configuration file. If the web app doesn’t start, you can always check /usr/local/mailsync/mailsync.log for detailed information about the problem.