tutorial and documentation to start dev

Have a great idea for extending Zimbra? Share ideas, ask questions, contribute, and get feedback.
Posts: 2
Joined: Mon Feb 11, 2019 8:04 am

tutorial and documentation to start dev

Postby fj34 » Mon Feb 11, 2019 8:09 am

I'm newby in zimbra with a project that is starting.
So I'm looking for dev oriented documentation :
- architecture documentation
- how to build a dev environnement (documentation I found seems-to be obsolete)
- documentation about database schema, apis, etc.

Can you tell me where I will be able to find usefull documentation ?

The goal of the project will be to implement zimlets I suppose without contributing on the core platform.

Thank you.


User avatar
Zimbra Employee
Zimbra Employee
Posts: 33
Joined: Tue Mar 29, 2016 1:36 pm

Re: tutorial and documentation to start dev

Postby jeastman » Thu Feb 21, 2019 5:16 pm

As a getting started point, I would recommend looking at the administrator's guide (https://zimbra.github.io/adminguide/latest/index.html). There is an architectural overview section there (https://zimbra.github.io/adminguide/lat ... l_overview).

The best means of a development environment is now the development Docker container (see https://github.com/Zimbra/docker-zcs-dev-machine). The setup described in that project couples very well with the Zimbra build (https://github.com/Zimbra/zm-build). Check the zm-build project documentation on how to set things up.

Once you have the environment, you do your development and then simply restart the services in the container to work with your updated code.

Engineering-level documentation is still available in the zm-mailbox repository (see https://github.com/Zimbra/zm-mailbox/tr ... store/docs), but most of the docs there are pretty low-level and probably not a good entry point.

Hope that helps.
John Eastman

Return to “Developers”

Who is online

Users browsing this forum: No registered users and 3 guests