SUPPORT.md

   1 OpenSSL User Support resources
   2 ==============================
   3
   4 See the <https://www.openssl.org/support/contracts.html> for details on how to
   5 obtain commercial technical support.
   6
   7 If you have general questions about using OpenSSL
   8 -------------------------------------------------
   9
  10 In this case the [openssl-users] mailing list is the right place for you.
  11 The list is not only watched by the OpenSSL team members, but also by many
  12 other OpenSSL users. Here you will most likely get the answer to your questions.
  13 An overview over the [mailing lists](#mailing-lists) can be found below.
  14
  15 If you think you found a Bug
  16 ----------------------------
  17
  18 *NOTE: this section assumes that you want to report it or figure it out and
  19 fix it.  What's written here is not to be taken as a recipe for how to get a
  20 working production installation*
  21
  22 If you have any problems with OpenSSL then please take the following steps
  23 first:
  24
  25 - Search the mailing lists and/or the GitHub issues to find out whether
  26   the problem has already been reported.
  27 - Download the latest version from the repository to see if the problem
  28   has already been addressed.
  29 - Configure without assembler support (`no-asm`) and check whether the
  30   problem persists.
  31 - Remove compiler optimization flags.
  32
  33 Please keep in mind: Just because something doesn't work the way you expect
  34 does not mean it is necessarily a bug in OpenSSL. If you are not sure,
  35 consider searching the mail archives and posting a question to the
  36 [openssl-users] mailing list first.
  37
  38 ### Open an Issue
  39
  40 If you wish to report a bug, please open an [issue][github-issues] on GitHub
  41 and include the following information:
  42
  43 - OpenSSL version: output of `openssl version -a`
  44 - Configuration data: output of `perl configdata.pm --dump`
  45 - OS Name, Version, Hardware platform
  46 - Compiler Details (name, version)
  47 - Application Details (name, version)
  48 - Problem Description (steps that will reproduce the problem, if known)
  49 - Stack Traceback (if the application dumps core)
  50
  51 Not only errors in the software, also errors in the documentation, in
  52 particular the manual pages, can be reported as issues.
  53
  54 ### Submit a Pull Request
  55
  56 The fastest way to get a bug fixed is to fix it yourself ;-). If you are
  57 experienced in programming and know how to fix the bug, you can open a
  58 pull request. The details are covered in the [Contributing](#contributing) section.
  59
  60 Don't hesitate to open a pull request, even if it's only a small change
  61 like a grammatical or typographical error in the documentation.
  62
  63 Mailing Lists
  64 =============
  65
  66 The OpenSSL maintains a number of [mailing lists] for various purposes.
  67 The most important lists are:
  68
  69 - [openssl-users]    for general questions about using the OpenSSL software
  70                      and discussions between OpenSSL users.
  71
  72 - [openssl-announce] for official announcements to the OpenSSL community.
  73
  74 - [openssl-project]  for discussion about the development roadmap
  75                      and governance.
  76
  77 Only subscribers can post to [openssl-users] or [openssl-project].  The
  78 archives are made public, however.  For more information, see the [mailing
  79 lists] page.
  80
  81 There was an [openssl-dev] list that has been discontinued since development
  82 is now taking place in the form of GitHub pull requests. Although not active
  83 anymore, the searchable archive may still contain useful information.
  84
  85 <!-- Links -->
  86
  87 [mailing lists]:     https://www.openssl.org/community/mailinglists.html
  88 [openssl-users]:     https://mta.openssl.org/mailman/listinfo/openssl-users
  89 [openssl-announce]:  https://mta.openssl.org/mailman/listinfo/openssl-announce
  90 [openssl-project]:   https://mta.openssl.org/mailman/listinfo/openssl-project
  91 [openssl-dev]:       https://mta.openssl.org/mailman/listinfo/openssl-dev