| 1 |
========================================= |
| 2 |
Overview of Cyrus development environment |
| 3 |
========================================= |
| 4 |
|
| 5 |
The pre-requisites |
| 6 |
================== |
| 7 |
|
| 8 |
While Cyrus itself can be run under many operating systems, we recommend the following operating systems for development, because the dependencies and libraries are known. If you get a development environment working under a different operating system, we'd love to :ref:`hear about it <support>`. |
| 9 |
* Debian / Ubuntu |
| 10 |
* Fedora / Redhat |
| 11 |
|
| 12 |
The components |
| 13 |
============== |
| 14 |
|
| 15 |
Source |
| 16 |
------ |
| 17 |
|
| 18 |
Cyrus IMAPd |
| 19 |
Can't do anything without this! |
| 20 |
|
| 21 |
Follow the :ref:`Cyrus IMAP installation guide <setup>`. |
| 22 |
|
| 23 |
Cyrus SASL |
| 24 |
Used for providing user authentication to the mail server. |
| 25 |
|
| 26 |
When developing against Cyrus, however, we assume that Cyrus SASL is a third party pre-built component. There is a separate section on compiling from source if you're interested in :ref:`contributing to Cyrus SASL <sasldevinstallguide>`. |
| 27 |
|
| 28 |
Testing tools |
| 29 |
------------- |
| 30 |
|
| 31 |
Cassandane |
| 32 |
System test suite for Cyrus IMAPd. |
| 33 |
|
| 34 |
The :ref:`Cyrus testing guide <developer-testing>` has instructions for :ref:`installing Cassandane <install_cassandane>`. |
| 35 |
|
| 36 |
Caldav Tester |
| 37 |
Testing tool for CalDAV and CardDAV. |
| 38 |
|
| 39 |
Installation information: http://calendarserver.org/wiki/CalDAVTester |
| 40 |
|
| 41 |
IMAPTest |
| 42 |
Compliance and stress test tool for IMAP servers. |
| 43 |
|
| 44 |
Installation information: http://www.imapwiki.org/ImapTest |
| 45 |
|
| 46 |
Development hub |
| 47 |
--------------- |
| 48 |
|
| 49 |
GitHub |
| 50 |
We use GitHub for our collaboration and change tracking. |
| 51 |
|
| 52 |
Check out our :ref:`development process <devprocess>` for a guide on how to contribute your changes to the community. |