2020-06-29 07:29:55 +00:00
# linuxserver/guacd
2019-05-26 02:42:45 +00:00
2020-06-29 07:29:55 +00:00
[](https://github.com/linuxserver/docker-guacd) [](https://github.com/linuxserver/docker-guacd/releases) [](https://github.com/linuxserver/docker-guacd/packages) [](https://gitlab.com/Linuxserver.io/docker-guacd/container_registry) [](https://microbadger.com/images/linuxserver/guacd) [](https://hub.docker.com/r/linuxserver/guacd) [](https://hub.docker.com/r/linuxserver/guacd) [](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-guacd/job/master/) [](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/guacd/latest/index.html)
2019-10-03 15:36:43 +00:00
2020-06-29 07:29:55 +00:00
[Guacd ](https://guacamole.apache.org/ ) - Apache Guacamole is a clientless remote desktop gateway. It supports standard protocols like VNC, RDP, and SSH. This container is only the backend server component needed to use The official or 3rd party HTML5 frontends.
2020-04-30 15:36:07 +00:00
2019-05-26 02:42:45 +00:00
## Supported Architectures
2019-09-05 15:36:02 +00:00
Our images support multiple architectures such as `x86-64` , `arm64` and `armhf` . We utilise the docker manifest for multi-platform awareness. More information is available from docker [here ](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list ) and our announcement [here ](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/ ).
2019-05-26 02:42:45 +00:00
Simply pulling `linuxserver/guacd` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
The architectures supported by this image are:
| Architecture | Tag |
2020-06-29 07:29:55 +00:00
| :---: | :--- |
2019-05-26 02:42:45 +00:00
| x86-64 | amd64-latest |
| arm64 | arm64v8-latest |
| armhf | arm32v7-latest |
## Usage
Here are some example snippets to help you get started creating a container from this image.
### docker
2020-06-29 07:29:55 +00:00
```text
2019-05-26 02:42:45 +00:00
docker create \
--name=guacd \
-p 4822:4822 \
--restart unless-stopped \
linuxserver/guacd
```
### docker-compose
Compatible with docker-compose v2 schemas.
```yaml
---
2020-04-09 15:36:18 +00:00
version: "2.1"
2019-05-26 02:42:45 +00:00
services:
guacd:
image: linuxserver/guacd
container_name: guacd
ports:
- 4822:4822
restart: unless-stopped
```
## Parameters
2020-06-29 07:29:55 +00:00
Docker images are configured using parameters passed at runtime \(such as those above\). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
2019-05-26 02:42:45 +00:00
2020-06-29 07:29:55 +00:00
### Ports \(`-p`\)
2019-05-26 02:42:45 +00:00
| Parameter | Function |
2020-06-29 07:29:55 +00:00
| :---: | :--- |
2019-05-26 02:42:45 +00:00
| `4822` | Port Guacamole server listens on |
2020-06-29 07:29:55 +00:00
### Environment Variables \(`-e`\)
2019-05-26 02:42:45 +00:00
2020-04-30 15:36:07 +00:00
| Env | Function |
2020-06-29 07:29:55 +00:00
| :---: | :--- |
2019-10-03 15:36:43 +00:00
2019-05-26 02:42:45 +00:00
2020-06-29 07:29:55 +00:00
### Volume Mappings \(`-v`\)
2020-04-30 15:36:07 +00:00
2020-06-29 07:29:55 +00:00
| Volume | Function |
| :---: | :--- |
2020-04-30 15:36:07 +00:00
2019-05-26 02:42:45 +00:00
2020-06-29 07:29:55 +00:00
## Environment variables from files \(Docker secrets\)
2020-05-28 19:46:04 +00:00
You can set any environment variable from a file by using a special prepend `FILE__` .
As an example:
2020-06-29 07:29:55 +00:00
```text
2020-05-28 19:46:04 +00:00
-e FILE__PASSWORD=/run/secrets/mysecretpassword
```
Will set the environment variable `PASSWORD` based on the contents of the `/run/secrets/mysecretpassword` file.
## Umask for running applications
2020-06-29 07:29:55 +00:00
For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional `-e UMASK=022` setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up [here ](https://en.wikipedia.org/wiki/Umask ) before asking for support.
2020-04-09 15:36:18 +00:00
2019-05-26 02:42:45 +00:00
## Application Setup
2020-06-29 07:29:55 +00:00
This is a backend only service, to leverage Guacd server you need to use either the official Java frontend [guacamole-client ](https://github.com/apache/guacamole-client ) or an open source alterantive like [guacamole-lite ](https://github.com/vadimpronin/guacamole-lite ).
2019-10-03 15:36:43 +00:00
2020-04-09 15:36:18 +00:00
## Docker Mods
2020-06-29 07:29:55 +00:00
[](https://mods.linuxserver.io/?mod=guacd)
2020-04-09 15:36:18 +00:00
2020-06-29 07:29:55 +00:00
We publish various [Docker Mods ](https://github.com/linuxserver/docker-mods ) to enable additional functionality within the containers. The list of Mods available for this image \(if any\) can be accessed via the dynamic badge above.
2019-05-26 02:42:45 +00:00
## Support Info
2019-09-05 15:36:02 +00:00
* Shell access whilst the container is running:
2019-05-26 02:42:45 +00:00
* `docker exec -it guacd /bin/bash`
2019-09-05 15:36:02 +00:00
* To monitor the logs of the container in realtime:
2019-05-26 02:42:45 +00:00
* `docker logs -f guacd`
2019-09-05 15:36:02 +00:00
* Container version number
2019-05-26 02:42:45 +00:00
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' guacd`
* Image version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/guacd`
## Versions
2020-02-08 23:24:56 +00:00
* **08.02.20:** - Bump to 1.1.0.
2019-05-26 02:42:45 +00:00
* **25.05.19:** - Initial Release.
2020-06-29 07:29:55 +00:00
