README.md (1780B)
1What is guacd? 2============== 3 4[guacd](https://github.com/apache/guacamole-server/) is the native 5server-side proxy used by the [Apache Guacamole web 6application](http://guacamole.apache.org/). If you wish to deploy 7Guacamole, or an application using the [Guacamole core 8APIs](http://guacamole.apache.org/api-documentation), you will need a 9copy of guacd running. 10 11How to use this image 12===================== 13 14Running guacd for use by the [Guacamole Docker image](https://registry.hub.docker.com/u/guacamole/guacamole/) 15----------------------------------------------------- 16 17 docker run --name some-guacd -d guacamole/guacd 18 19guacd will be listening on port 4822, but this port will only be available to 20Docker containers that have been explicitly linked to `some-guacd`. 21 22Running guacd for use services by outside Docker 23------------------------------------------------ 24 25 docker run --name some-guacd -d -p 4822:4822 guacamole/guacd 26 27guacd will be listening on port 4822, and Docker will expose this port on the 28same server hosting Docker. Other services, such as an instance of Tomcat 29running outside of Docker, will be able to connect to guacd. 30 31Beware of the security ramifications of doing this. There is no authentication 32within guacd, so allowing access from untrusted applications is dangerous. If 33you need to expose guacd, ensure that you only expose it as absolutely 34necessary, and that only specific trusted applications have access. 35 36Connecting to guacd from an application 37--------------------------------------- 38 39 docker run --name some-app --link some-guacd:guacd -d application-that-uses-guacd 40 41Reporting issues 42================ 43 44Please report any bugs encountered by opening a new issue in 45[our JIRA](https://issues.apache.org/jira/browse/GUACAMOLE/). 46