Updating developer install guide docs

Simon Amor simon at leaky.org
Thu May 28 08:54:51 EDT 2015

Hi Nicola,

On 28 May 2015, at 06:01, Nicola Nye <nicolan at fastmail.com> wrote:
> Hi Conrad (and anyone else with a development install),
> With Ellie away, you're now my expert (!) on getting a developer
> environment up and running. I'm looking at freshening the docs on our
> official docs.cyrus.foundation site.
> I know you have followed Ellie's install notes which have been
> summarised at
> https://git.cyrus.foundation/w/setup_a_cyrus_development_environment/
> and had great success.
> While I am tempted to just overwrite the original install guide with
> Ellie's new instructions, could you just give it a glance through and
> let me know if there's any detail in there that's worth retaining?
> https://docs.cyrus.foundation/imap/installation/diy.html
> I noted that the dependencies were described in greater detail along
> with where to get them from (and the list seemed a little different)
> The original also talks about a configure step which Ellie's guide
> doesn't have. Should it still be referenced for completeness?

These two sets of instructions are for different things.  https://docs.cyrus.foundation/imap/installation/diy.html is for building your own version of Cyrus to install on a server. The docs that Ellie did are more for when you want to add features, fix bugs etc within Cyrus.

You don't need cassandane etc when installing it on a server in a production environment, but as Conrad mentioned, you do need to configure an SMTP server and method for accepting emails and passing them to Cyrus.

This is also probably why the dependencies are different between the two docs. I think the two sets of instructions should be kept separate.


More information about the Cyrus-devel mailing list