Gathering information

To get appropriate support, you need to provide sufficient information about your operating system, environment and setup. You can utilize the foreman-debug tool - for more info see the manual.

Redmine icon Issue tracker

The issue tracker (Redmine) should be used to check for existing issues or to file a new issue. First, find the project and then use the Issues tab to view bugs and feature requests. Use the search feature at the top of the issue list to filter by Category to narrow down the results.

When filing a new issue, check that the correct project is selected, then click the New Issue link in the header. Try to set the Category, Found in release and include as much information as possible, including log files and screenshots. For support requests, please use one of the other options below.

Google groups icon Mailing lists

Mailing lists are available via Google Groups. For help or support with Foreman problems, questions and answers or general discussion, post to the foreman-users list:

  • foreman-users or email

For discussions about developing Foreman or plugins, use the development list:

  • foreman-dev or email

There is also a low-traffic list dedicated to release and security announcements:

Stack overflow icon Server Fault

Ask questions about how to use Foreman on Server Fault, so anyone can benefit from the answers. Tag your questions with ‘foreman’.

IRC icon IRC

A great place to get real-time help with The Foreman is our IRC channel:

There are usually many helpful people there in addition to some of the Foreman developers. For discussions about the intricacies of developing Foreman or plugins, use the development channel:

Please read and understand this fantastic guide to getting help for open-source projects on irc before diving in. All of the points there apply to #theforeman, especially “Don’t repeat yourself”, “Don’t ask to ask”, and “Stick around”. #theforeman in particular has concentrations of people in Europe (CEST) and East-coast US (EST), so asking your question when those time zones are in business hours is more likely to get a good result.

Be aware that the IRC channel is not an official support channel, it’s an ad hoc group of people (some of whom work on Foreman for a living) self-organizing to help each other out. If you do not receive an answer to your question, (especially if you have not followed the getting help on IRC best practices!), that doesn’t mean you are out of options; the software may have a bug, the docs may be lacking, or it’s possible Foreman doesn’t yet support your use case. It just means you need to keep troubleshooting to find out which.

We also have a few IRC-specific guidelines:

  • Don’t be a jerk: Treat people with respect and consideration.
  • Be helpful: Be patient with new people and be willing to jump in to answer questions.
  • Stay calm: The written word is always subject to interpretation, so give people the benefit of the doubt and try not to let emotions get out of control.
  • Don’t post chunks: Avoid posting big chunks of text - use a pastebin or similar service to shorten it to a link. Likewise, try not to spam the channel with many messages, it breaks the flow of other conversations.
  • Be patient: Folks might not be around when you ask a question, so wait a while for someone to speak before leaving.
  • Search first: Believe it or not, your question might not be new or you might be able to find someone who has already asked or answered your question. Do a thorough search of the Manual, the Redmine Issues, and the Mailing List to see if it has been answered before.
  • Don’t private message: Ask permission before you send someone a private message (PM). Not everyone likes them. Also, by keeping it in public, others with similar issues can see the solution you were given.
  • Don’t highlight specific people unless you are already discussing something with them. Highlighting a specific user with your opening question makes it far less likely others will respond.
  • Try to keep conversations on-topic where possible - going off on a tangent doesn’t solve anyone’s problem.

More information: This IRC primer for new users and the general IRC guidelines, from freenode, are also useful resources.

(Thanks to the Puppet Labs IRC Guidelines for the original document)

YouTube icon YouTube channel

Please subscribe to our YouTube channel. We regularly upload deep dives on Foreman features, screencasts to learn how to use the different features and plugins of Foreman, discussions and much more.

Our Google+ community regularly hosts live hangouts on a variety of topics. Become a member of the community and you will be notified about these events, so you can ask questions to the presenters and join the conversation.

Join in testing of our Foreman 1.13.0 release candidates, now available in our repos and due for final release in October. Read about the changes in the release notes, and follow the quick start to install it.

A new bug fix release for Foreman 1.12 is available. See the Foreman 1.12.3 release notes for more details.