]>
Commit | Line | Data |
---|---|---|
71368339 RL |
1 | OpenSSL User Support resources |
2 | ============================== | |
3 | ||
be0c6a36 DMSP |
4 | _Under Construction; not more than a collection of text fragments yet._ |
5 | ||
6 | See the OpenSSL website www.openssl.org for details on how to obtain | |
7 | commercial technical support. Free community support is available through the | |
8 | openssl-users email list (see | |
257e9d03 | 9 | <https://www.openssl.org/community/mailinglists.html for> further details). |
be0c6a36 DMSP |
10 | |
11 | If you have any problems with OpenSSL then please take the following steps | |
12 | first: | |
13 | ||
14 | - Download the latest version from the repository | |
15 | to see if the problem has already been addressed | |
16 | - Configure with no-asm | |
17 | - Remove compiler optimization flags | |
18 | ||
19 | If you wish to report a bug then please include the following information | |
20 | and create an issue on GitHub: | |
21 | ||
22 | - OpenSSL version: output of 'openssl version -a' | |
23 | - Configuration data: output of 'perl configdata.pm ==dump' | |
24 | - OS Name, Version, Hardware platform | |
25 | - Compiler Details (name, version) | |
26 | - Application Details (name, version) | |
27 | - Problem Description (steps that will reproduce the problem, if known) | |
28 | - Stack Traceback (if the application dumps core) | |
29 | ||
30 | Just because something doesn't work the way you expect does not mean it | |
31 | is necessarily a bug in OpenSSL. Use the openssl-users email list for this type | |
32 | of query. | |
33 | ||
71368339 RL |
34 | For *questions* on how to use OpenSSL or what went wrong when you |
35 | tried something, our primary resource is the mailing list | |
36 | openssl-users@openssl.org, where you can get help from others in the | |
37 | OpenSSL community (which includes the developers as time permits). | |
38 | ||
39 | Only subscribers can post to openssl-users@openssl.org (although the | |
40 | archives are public). | |
257e9d03 | 41 | For more information, see <https://www.openssl.org/community/mailinglists.html> |
be0c6a36 DMSP |
42 | |
43 | You have general questions about using OpenSSL | |
44 | ---------------------------------------------- | |
45 | ||
46 | In this case the [openssl-users][] mailing list is the right place for you. | |
47 | The list is not only watched by the OpenSSL team members, but also by many | |
48 | other OpenSSL users. Here you will most likely get the answer to your questions. | |
49 | An overview over the [mailing lists](#mailing-lists) can be found below. | |
50 | ||
51 | You found a Bug | |
52 | --------------- | |
53 | ||
54 | If you have any problems with OpenSSL then please take the following steps first: | |
55 | ||
56 | - Search the mailing lists and/or the GitHub issues to find out whether | |
57 | the problem has already been reported. | |
58 | - Download the latest version from the repository to see if the problem | |
59 | has already been addressed. | |
60 | - Configure without assembler support (`no-asm`) and check whether the | |
61 | problem persists. | |
62 | - Remove compiler optimization flags. | |
63 | ||
64 | Please keep in mind: Just because something doesn't work the way you expect | |
65 | does not mean it is necessarily a bug in OpenSSL. If you are not sure, | |
66 | consider searching the mail archives and posting a question to the | |
67 | [openssl-users][] mailing list first. | |
68 | ||
69 | ### Open an Issue | |
70 | ||
71 | If you wish to report a bug, please open an [issue][github-issues] on GitHub | |
72 | and include the following information: | |
73 | ||
74 | - OpenSSL version: output of `openssl version -a` | |
75 | - Configuration data: output of `perl configdata.pm --dump` | |
76 | - OS Name, Version, Hardware platform | |
77 | - Compiler Details (name, version) | |
78 | - Application Details (name, version) | |
79 | - Problem Description (steps that will reproduce the problem, if known) | |
80 | - Stack Traceback (if the application dumps core) | |
81 | ||
82 | Not only errors in the software, also errors in the documentation, in | |
83 | particular the manual pages, can be reported as issues. | |
84 | ||
85 | ### Submit a Pull Request | |
86 | ||
87 | The fastest way to get a bug fixed is to fix it yourself ;-). If you are | |
88 | experienced in programming and know how to fix the bug, you can open a | |
89 | pull request. The details are covered in the [Contributing](#contributing) section. | |
90 | ||
91 | Don't hesitate to open a pull request, even if it's only a small change | |
92 | like a grammatical or typographical error in the documentation. | |
93 | ||
be0c6a36 DMSP |
94 | Mailing Lists |
95 | ============= | |
96 | ||
97 | The OpenSSL maintains a number of [mailing lists][] for various purposes. | |
98 | The most important lists are: | |
99 | ||
100 | - [openssl-users][] for general questions about using the OpenSSL software | |
101 | and discussions between OpenSSL users. | |
102 | ||
103 | - [openssl-announce][] for official announcements to the OpenSSL community. | |
104 | ||
105 | - [openssl-project][] for discussion about the development roadmap | |
106 | and governance. | |
107 | ||
108 | - [openssl-dev][] for discussion about development of OpenSSL. | |
109 | ||
110 | The openssl-dev list has been discontinued since development is now taking | |
111 | place in form of GitHub pull requests. Although not active anymore, the | |
112 | searchable archive may still contain useful information. | |
113 | ||
be0c6a36 DMSP |
114 | <!-- Links --> |
115 | ||
116 | [mailing lists]: https://www.openssl.org/community/mailinglists.html | |
117 | [openssl-users]: https://mta.openssl.org/mailman/listinfo/openssl-users | |
118 | [openssl-announce]: https://mta.openssl.org/mailman/listinfo/openssl-announce | |
119 | [openssl-project]: https://mta.openssl.org/mailman/listinfo/openssl-project | |
120 | [openssl-dev]: https://mta.openssl.org/mailman/listinfo/openssl-dev |