File: overview.txt

package info (click to toggle)
cyrus-imapd 3.0.8-6%2Bdeb10u6
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 61,500 kB
  • sloc: ansic: 189,141; perl: 10,435; javascript: 9,404; sh: 6,159; yacc: 2,199; makefile: 1,971; cpp: 926; python: 361; lex: 320; awk: 303; asm: 262; xml: 1
file content (52 lines) | stat: -rw-r--r-- 1,675 bytes parent folder | download | duplicates (20)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
=========================================
Overview of Cyrus development environment
=========================================

The pre-requisites
==================

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>`.
    * Debian / Ubuntu
    * Fedora / Redhat

The components
==============

Source
------

Cyrus IMAPd
    Can't do anything without this!

    Follow the :ref:`Cyrus IMAP installation guide <setup>`.

Cyrus SASL
    Used for providing user authentication to the mail server.

    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>`.

Testing tools
-------------

Cassandane
    System test suite for Cyrus IMAPd.

    The :ref:`Cyrus testing guide <developer-testing>` has instructions for :ref:`installing Cassandane <install_cassandane>`.

Caldav Tester
    Testing tool for CalDAV and CardDAV.

    Installation information: http://calendarserver.org/wiki/CalDAVTester

IMAPTest
    Compliance and stress test tool for IMAP servers.

    Installation information: http://www.imapwiki.org/ImapTest

Development hub
---------------

GitHub
    We use GitHub for our collaboration and change tracking.

    Check out our :ref:`development process <devprocess>` for a guide on how to contribute your changes to the community.