modoboa-installer icon indicating copy to clipboard operation
modoboa-installer copied to clipboard

Docs : installation options

Open almereyda opened this issue 8 years ago • 2 comments

As it appears modoboa-installer will be the main entry point for future users, it is advisable to update its documentation with more granular detail about its internal workings.

A first step could be to actually explain the installer.cfg file instead of referring to its inline comments. The devmode is, for example, not immediately understandable. Is it maybe even equal to appending the --debug switch? This needs to be cleared out.

Additionally a sanity check of the file before continuing with the setup may help in saving some people from headaches in the future? At least I am interested in requirements for the different keys available.

almereyda avatar May 10 '16 19:05 almereyda

Yes, it's a good idea. What would be a good place for this documentation ?

tonioo avatar May 11 '16 09:05 tonioo

As I have always felt the modoboa documentation at http://modoboa.readthedocs.io a little confusing, I can imagine to contribute to a documentation community initiative. For this to be successful, I would regard two steps mandatory for distribution of responsability:

  • Fork tonioo/modoboa to modoboa/modoboa(-core?) and
  • Extract the doc subfolder into its own repository.

Then the commit trees of both projects would be separated and could be maintained independently. Next up could then be a rewrite of the Getting Started section to increase separation of the different deployment modes:

  • manually
  • via the installer
  • elsewhat - didn't modoboa even start out as a set of Ansible roles?).

almereyda avatar May 12 '16 21:05 almereyda