IXP Manager

Getting Help

Documentation

All documentation for IXP Manager is linked in the support menu above. There is also a page linked there for presentations and talks which should be quiet useful.

Mailing Lists

  • IXP Manager Users: As an open source project, the primary channel for requesting help is via our mailing list. The developers and operations staff from INEX (and other IXs) are on this list but we also try and foster an environment where other more experienced users can help new comers.

    Please subscribe here (and see the archives here).

    This list has moderate traffic - from low levels to ~100 emails / month.

    Please read the section The Best Way to Ask for Help below to maximise your chances of getting a quick and useful reply.

  • IXP Manager Announce: announcements of new releases, security issues or important project news. We strongly advise all users of IXP Manager to subscribe to this list.

    This list has extremely low volume (~0-5 emails / month) and posting is restricted to project members only.

    Please subscribe here. (and see the archives here).

Bugs and Feature Requests

All bugs should be filed on the GitHub Issues page. It is vitally important that you file a detailed bug report with steps on how to reproduce the issue. One line / vague bug reports are likely to be closed without investigation.

The ideal feature request comes with code via a pull request. This (or commercial support) is the most probable way to get a feature into IXP Manager! Feel free to file feature requests as an issue and tag it as such.

We will give all feature requests a fair hearing and due consideration. But, those that we are unlikely to implement pro bono or those that do not align with the core purpose of IXP Manager may be closed or moved to a feature request file so as not to clog up the issue tracker.

"Support, Out in the Open"

INEX promotes a "Support, out in the open" model. When support issues crop up, we invite people to send them to the IXP Manager Users mailing list (see above) where a member of the community can answer them. When this model is used, search engines pick up relevant query terms, everybody learns about the application and the developers can see what's important to the community. This allows all members of the community to benefit.

Alternatively if the problem is a repeatable bug, this can be reported on the IXP Manager issue tracker on Github where it can be triaged by our dev team.

INEX doesn't offer free private technical support. This means that if you email one of the development team directly, we will politely suggest that you send your question to the mailing list or direct you to commercial support options.

The Best Way to Ask for Help

If you do need help with something and you have decided to open a bug or email the mailing list, please remember that the developers and contributors are busy people and their help is on a voluntary basis.

With that in mind, the best way to get a thoughtful, complete and helpful response is to offer as much information as possible in your original query. So, where appropriate, consider the following:

  • make sure the problem was not already reported as a bug or asked on the mailing list to avoid duplicates (to search the mailing list add this to your Google search: site:www.inex.ie);
  • ensure you have read the documentation in detail: https://docs.ixpmanager.org/;
    • If, when your problem is solved, you feel that the documentation could be improved, please contribute back with suggested improvements;
  • explain the issue with sufficient detail that we will be certain of what you are trying to do. Include your understanding of what the expected result should be versus what you are getting;
  • always provide detailed steps to reproduce an issue;
  • always test if the latest release is affected. Bug reports on older releases cannot be accepted and will be closed;
  • provide relevant snippnets of your .env (or all of it after removing keys, passwords, etc.)
  • copy all relevant logs to an online pastebin such as this one and place the URL you receive from the pastebin into your email. Logs will usually be found under $IXPROOT/storage/logs/.... Our mailing list has size and attachement restrictions, as such:
    • never attach screenshots of logs;
    • never attach log files to your mailing list email;
  • mention the OS you are running IXP Manager on (including Linux variant if relevant)
  • mention the version of IXP Manager you are running (output from cat $IXPROOT/library/IXP/Version.php | grep APPLICATION);
  • mention the version of PHP you have (php -v)
  • provide anything else you think might help someone solve your problem.