Extend documentation

Issue #1244 closed
Alexander Adam created an issue

This is rather an issue for the website but I guess there’s no better place for these issues than here.
And it’s only important if you want to gain more users.

  1. the issue tracker doesn’t seem to have a link to the actual issue tracker: https://www.mailpiler.org/wiki/bugtracker
  2. it would be great to have an overview about all possible env variables for the docker images (also show which of them are only available in the enterprise edition)
  3. Document whether (or how) one can switch from a regular Docker installation to an enterprise edition. How is the workflow for that?
  4. SSO is only part of the Enterprise edition, right? Or should it be available on the regular version as well? The SSO page doesn’t mention anything about only being Enterprise: https://www.mailpiler.org/wiki/current:single-sign-on
  5. How can someone activate Prometheus exporter in the Enterprise edition?
  6. It would be great if the docker-compose for each variant could be linked on mainpiler.org. It’s this one: https://github.com/jsuto/piler-examples/blob/master/examples/zentyal/docker-compose.yaml and this one: https://github.com/jsuto/piler-examples/blob/master/examples/docker/docker-compose.yaml right?

PS: Maybe some “marketing advice”: I saw that people on Reddit are often looking for mail archiving solutions but they aren’t aware of proper solutions. I’m pretty sure mailpiler would suit their needs and some surely would be curious to test it.

PPS: did you ever consider migrating the piler code to GitHub as well?

Comments (4)

  1. Janos SUTO repo owner

    Thank you for your feedback.

    1. I’ve added the link to the issue tracker
    2. The docker-compose.yaml file lists those env variables. Let me know what more you need
    3. The open source and the commercial editions are not compatible with each other. So there’s no simple switch other than a full export and import
    4. The SSO feature is part of the open source edition. Newer SSO methods, eg. Azure, AWS Cognito, Keycloak are available in the enterprise edition only
    5. Set $config['ENABLE_PROMETHEUS_METRICS'] = 1; in config-site.php
    6. I’ll link those docker examples to the documentation page

    PS: What would be the benefit of migrating to github? I think I’d lost the issue tracker part for sure.

  2. Alexander Adam reporter

    Thank you so much for your response and your work!

    The docker-compose.yaml file lists those env variables. Let me know what more you need

    Therefore Piler supports only these five env variables?

    The SSO feature is part of the open source edition

    SSO is not configurable by env variables then, right?

    Set $config['ENABLE_PROMETHEUS_METRICS'] = 1; in config-site.php

    How does this work?
    I cannot find the term “Prometheus” anywhere except in the `contrib/smtp/dictionary.txt`.
    Does the exporter come from an external dependency?

    What would be the benefit of migrating to github?

    I’d say that nobody is looking for projects on anything but GitHub.

    I think I’d lost the issue tracker part for sure.

    What’s wrong with tracking issues on GitHub?

  3. Janos SUTO repo owner

    Normally, you should use those env vars to get started. You may check docker/start.sh for more.

    SSO is configured in the config files, not by simply flipping an env var.

    You seem to mix the the open source and the commercial editions. The prometheus support is present only in the commercial edition.

    I’d say that nobody is looking for projects on anything but GitHub.

    Probably. However, I expect users to find the website.

    What’s wrong with tracking issues on GitHub?

    Nothing. I’m just not ready to lose the 1000+ issues here on bitbucket.

  4. Log in to comment