| <?xml version="1.0" encoding="UTF-8" standalone="no"?> |
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Appendix A. FAQ</title><link rel="stylesheet" type="text/css" href="gug.css" /><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot" /><link rel="home" href="index.html" title="Guacamole Manual" /><link rel="up" href="appendices.html" title="Part III. Appendices" /><link rel="prev" href="appendices.html" title="Part III. Appendices" /><link rel="next" href="protocol-reference.html" title="Appendix B. Guacamole protocol reference" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0, user-scalable=no, target-densitydpi=device-dpi"/> |
| </head><body> |
| <!-- CONTENT --> |
| |
| <div id="page"><div id="content"> |
| <div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Appendix A. FAQ</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="appendices.html">Prev</a> </td><th width="60%" align="center">Part III. Appendices</th><td width="20%" align="right"> <a accesskey="n" href="protocol-reference.html">Next</a></td></tr></table><hr /></div><div xml:lang="en" class="appendix" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="faq"></a>Appendix A. FAQ</h2></div></div></div><div class="qandaset"><a id="idm46420844214880"></a><dl><dt>A.1. <a href="faq.html#idm46420844749776">Where does the name "Guacamole" come from? </a></dt><dt>A.2. <a href="faq.html#idm46420844870544">What does "clientless" mean? </a></dt><dt>A.3. <a href="faq.html#idm46420844212832">Does Guacamole use WebSocket? </a></dt><dt>A.4. <a href="faq.html#idm46420844218816">I have Tomcat (or some other servlet container) set up behind a proxy (like |
| mod_proxy) and cannot connect to Guacamole. Why? How do I solve this? </a></dt><dt>A.5. <a href="faq.html#idm46420844209248">I connect to the internet through a web proxy, and cannot connect to |
| Guacamole. I cannot reconfigure the proxy. How do I solve this? </a></dt><dt>A.6. <a href="faq.html#idm46420844205952">Can I buy special licensing of the Guacamole code base, such that I can use it |
| in my own product, without providing the source to my users, without |
| contributing back, and without acknowledging the project? </a></dt><dt>A.7. <a href="faq.html#idm46420844203520">Can I pay for custom Guacamole work, or for help integrating Guacamole into my |
| product, if the open source nature and licenses are preserved?</a></dt><dt>A.8. <a href="faq.html#idm46420844157440">How can I contribute to the project? </a></dt><dt>A.9. <a href="faq.html#idm46420844154480">How can I become an official member of the project? </a></dt><dt>A.10. <a href="faq.html#idm46420844150848">I think I've found a bug. How do I report it? </a></dt><dt>A.11. <a href="faq.html#idm46420844146752">I need help! Where can I find some? </a></dt></dl><table border="0" style="width: 100%;"><colgroup><col align="left" width="1%" /><col /></colgroup><tbody><tr class="question"><td align="left" valign="top"><a id="idm46420844749776"></a><a id="idm46420844749520"></a><p><strong>A.1.</strong></p></td><td align="left" valign="top"><p>Where does the name "Guacamole" come from? </p></td></tr><tr class="answer"><td align="left" valign="top"></td><td align="left" valign="top"><p>The name was chosen arbitrarily from a random utterance in a conversation with |
| a member of the project. </p><p>When the project reached the point where it was growing out of the |
| proof-of-concept phase, and needed a real home on the internet, we needed to |
| think of a name to register the project under. </p><p>Several acronyms were toyed with and discarded. We tried anagrams, but all |
| were too wordy and complex. We considered naming the project after a fish or an |
| animal, and after suggesting the guanaco, James Muehlner, a developer of the |
| project, suggested (randomly): "guacamole". </p><p>The name had a nice ring, we weren't embarrassed to use it, and it stuck. </p></td></tr><tr class="question"><td align="left" valign="top"><a id="idm46420844870544"></a><a id="idm46420844870288"></a><p><strong>A.2.</strong></p></td><td align="left" valign="top"><p>What does "clientless" mean? </p></td></tr><tr class="answer"><td align="left" valign="top"></td><td align="left" valign="top"><p>The term "clientless" means that no specific client is needed. A Guacamole |
| user needs only have an HTML5 web browser installed, which is exceedingly |
| common; virtually all modern computers and mobile devices have such a browser |
| installed by default. </p><p>In this sense, Guacamole is "clientless" in that it does not require any |
| additional software to be installed beyond what is considered standard for any |
| computer. </p></td></tr><tr class="question"><td align="left" valign="top"><a id="idm46420844212832"></a><a id="idm46420844212544"></a><p><strong>A.3.</strong></p></td><td align="left" valign="top"><p>Does Guacamole use WebSocket? </p></td></tr><tr class="answer"><td align="left" valign="top"></td><td align="left" valign="top"><p>Guacamole uses either WebSocket or plain HTTP, whichever is supported by both |
| the browser and your servlet container. If WebSocket cannot be used for any |
| reason, Guacamole will fall back to using HTTP.</p><p>Historically, Guacamole had no WebSocket support at all. This was due to a |
| lack of browser support and lack of a true standard. Overall, it didn't matter |
| as there really wasn't any need: the tunnel used by Guacamole when WebSocket is |
| not available is largely equivalent to WebSocket in terms of efficiency and |
| latency, and is more compatible with proxies and existing browsers.</p></td></tr><tr class="question"><td align="left" valign="top"><a id="idm46420844218816"></a><a id="idm46420844218528"></a><p><strong>A.4.</strong></p></td><td align="left" valign="top"><p>I have Tomcat (or some other servlet container) set up behind a proxy (like |
| mod_proxy) and cannot connect to Guacamole. Why? How do I solve this? </p></td></tr><tr class="answer"><td align="left" valign="top"></td><td align="left" valign="top"><p>You need to enable automatic flushing of the proxy's buffer as it receives |
| packets. </p><p>Most proxies, including mod_proxy, buffer data received from the server, and |
| will not flush this data in real-time. Each proxy has an option to force |
| flushing of each packet automatically, as this is necessary for streaming |
| applications like Guacamole, but this is usually not enabled by default. </p><p>Because Guacamole depends on streaming to function, a proxy configured to not |
| automatically flush packets will disrupt the stream to the point that the |
| connection seems unreasonably slow, or just fails to establish altogether. </p><p>In the case of mod_proxy, this option is <code class="code">flushpackets=on</code>. </p></td></tr><tr class="question"><td align="left" valign="top"><a id="idm46420844209248"></a><a id="idm46420844208960"></a><p><strong>A.5.</strong></p></td><td align="left" valign="top"><p>I connect to the internet through a web proxy, and cannot connect to |
| Guacamole. I cannot reconfigure the proxy. How do I solve this? </p></td></tr><tr class="answer"><td align="left" valign="top"></td><td align="left" valign="top"><p>You need to enable automatic flushing of your proxy's buffer to avoid |
| disrupting the stream used by Guacamole. </p><p>If you cannot change the settings of your proxy, using HTTPS instead of HTTP |
| should solve the problem. Proxies are required to stream HTTPS because of the |
| nature of SSL. Using HTTPS will allow Guacamole traffic to stream through |
| proxies unencumbered, even if you cannot access the proxy settings directly. </p></td></tr><tr class="question"><td align="left" valign="top"><a id="idm46420844205952"></a><a id="idm46420844205664"></a><p><strong>A.6.</strong></p></td><td align="left" valign="top"><p>Can I buy special licensing of the Guacamole code base, such that I can use it |
| in my own product, without providing the source to my users, without |
| contributing back, and without acknowledging the project? </p></td></tr><tr class="answer"><td align="left" valign="top"></td><td align="left" valign="top"><p>Usually, no. Previous requests for such licensing have been very one-sided and |
| there would be no direct or indirect benefit to the community and the project. |
| That said, we handle requests for licensing on a case-by-case basis. In general, |
| any special licensing has to somehow provide for the community and the |
| open-source project.</p></td></tr><tr class="question"><td align="left" valign="top"><a id="idm46420844203520"></a><a id="idm46420844203232"></a><p><strong>A.7.</strong></p></td><td align="left" valign="top"><p>Can I pay for custom Guacamole work, or for help integrating Guacamole into my |
| product, if the open source nature and licenses are preserved?</p></td></tr><tr class="answer"><td align="left" valign="top"></td><td align="left" valign="top"><p>Yes. We love to be paid to work on Guacamole, especially if that work remains |
| open source. </p></td></tr><tr class="question"><td align="left" valign="top"><a id="idm46420844157440"></a><a id="idm46420844157152"></a><p><strong>A.8.</strong></p></td><td align="left" valign="top"><p>How can I contribute to the project? </p></td></tr><tr class="answer"><td align="left" valign="top"></td><td align="left" valign="top"><p>If you are a programmer and want to contribute code, Guacamole is open-source |
| and you are welcome to do so! Just send us your patches. There is no guarantee |
| that your patch will be added to the upstream source, and all changes are |
| carefully reviewed. </p><p>If you are not a programmer, but want to help out, feel free to look through |
| the documentation or try installing Guacamole and test it out. General editing, |
| documentation contributions, and testing are always helpful. </p></td></tr><tr class="question"><td align="left" valign="top"><a id="idm46420844154480"></a><a id="idm46420844154192"></a><p><strong>A.9.</strong></p></td><td align="left" valign="top"><p>How can I become an official member of the project? </p></td></tr><tr class="answer"><td align="left" valign="top"></td><td align="left" valign="top"><p>The short answer is: "by being asked." </p><p>People are only added as official members of the Guacamole project after their |
| work has been proven. This usually means you will have contributed code in the |
| form of patches before, or we know you from extensive testing work, or you |
| frequently help with documentation, and we are impressed enough that we want you |
| as part of the project. </p><p>All that said, you do not need to be a member of the project to help out. Feel |
| free to contribute anything. </p></td></tr><tr class="question"><td align="left" valign="top"><a id="idm46420844150848"></a><a id="idm46420844150560"></a><p><strong>A.10.</strong></p></td><td align="left" valign="top"><p>I think I've found a bug. How do I report it? </p></td></tr><tr class="answer"><td align="left" valign="top"></td><td align="left" valign="top"><p>The project tracks in-progress tasks and bugs via the JIRA instance hosted by |
| the Apache Software Foundation:</p><p><a class="link" href="https://issues.apache.org/jira/browse/GUACAMOLE/" target="_top"><code class="uri">https://issues.apache.org/jira/browse/GUACAMOLE/</code></a></p><p>All bugs should be reported there as new issues. This is also where you would |
| request a new feature. If the bug you found is security-related, we would prefer |
| to be contacted personally via email, such that the bug can be fixed before |
| becoming dangerously widely known. </p></td></tr><tr class="question"><td align="left" valign="top"><a id="idm46420844146752"></a><a id="idm46420844146464"></a><p><strong>A.11.</strong></p></td><td align="left" valign="top"><p>I need help! Where can I find some? </p></td></tr><tr class="answer"><td align="left" valign="top"></td><td align="left" valign="top"><p>If you would like help with Apache Guacamole, or wish to help others, we |
| highly recommend sending an email to the one of the project’s <a class="link" href="http://guacamole.apache.org/support/#mailing-lists" target="_top">mailing lists</a>. <span class="emphasis"><em>You will need to subscribe prior to sending |
| email to any list.</em></span> All mailing lists are actively filtered for |
| spam, and any email not originating from a subscriber will bounce.</p><p>There are two primary mailing lists:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><a class="link" href="http://mail-archives.apache.org/mod_mbox/guacamole-user/" target="_top"><code class="email"><<a class="email" href="mailto:user@guacamole.apache.org">user@guacamole.apache.org</a>></code></a></span></dt><dd><p>The user list is intended for general questions and discussions |
| which do not necessarily pertain to development. This list replaces |
| the old <a class="link" href="https://sourceforge.net/p/guacamole/discussion/" target="_top">SourceForge forums</a> used by Guacamole prior to its |
| acceptance into the Apache Software Foundation.</p><p><span class="emphasis"><em>If you're not sure which mailing list to use, the user |
| list is probably the correct choice.</em></span></p></dd><dt><span class="term"><a class="link" href="http://mail-archives.apache.org/mod_mbox/guacamole-dev/" target="_top"><code class="email"><<a class="email" href="mailto:dev@guacamole.apache.org">dev@guacamole.apache.org</a>></code></a></span></dt><dd><p>The development list is for development-related discussion |
| involving people who are contributors to the Apache Guacamole |
| project (or who wish to become contributors).</p></dd></dl></div></td></tr></tbody></table></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="appendices.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="appendices.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="protocol-reference.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Part III. Appendices </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Appendix B. Guacamole protocol reference</td></tr></table></div> |
| |
| </div></div> |
| </body></html> |
