kopia lustrzana https://github.com/linuxserver/docker-documentation
Bot Updating Documentation
rodzic
cc3c666500
commit
2f886b2ba7
|
@ -1,9 +1,19 @@
|
||||||
# linuxserver/guacd
|
# [linuxserver/guacd](https://github.com/linuxserver/docker-guacd)
|
||||||
|
|
||||||
[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-guacd.svg?style=flat-square&color=E68523&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-guacd) [![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-guacd.svg?style=flat-square&color=E68523&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-guacd/releases) [![GitHub Package Repository](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=GitHub%20Package&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-guacd/packages) [![GitLab Container Registry](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab&logoColor=FFFFFF)](https://gitlab.com/Linuxserver.io/docker-guacd/container_registry) [![Quay.io](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=Quay.io)](https://quay.io/repository/linuxserver.io/guacd) [![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/guacd.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/guacd) [![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/guacd.svg?style=flat-square&color=E68523&label=pulls&logo=docker&logoColor=FFFFFF)](https://hub.docker.com/r/linuxserver/guacd) [![Docker Stars](https://img.shields.io/docker/stars/linuxserver/guacd.svg?style=flat-square&color=E68523&label=stars&logo=docker&logoColor=FFFFFF)](https://hub.docker.com/r/linuxserver/guacd) [![Build Status](https://ci.linuxserver.io/view/all/job/Docker-Pipeline-Builders/job/docker-guacd/job/master/badge/icon?style=flat-square)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-guacd/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/guacd/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/guacd/latest/index.html)
|
[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-guacd.svg?style=flat-square&color=E68523&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-guacd)
|
||||||
|
[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-guacd.svg?style=flat-square&color=E68523&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-guacd/releases)
|
||||||
|
[![GitHub Package Repository](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=GitHub%20Package&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-guacd/packages)
|
||||||
|
[![GitLab Container Registry](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab&logoColor=FFFFFF)](https://gitlab.com/Linuxserver.io/docker-guacd/container_registry)
|
||||||
|
[![Quay.io](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=Quay.io)](https://quay.io/repository/linuxserver.io/guacd)
|
||||||
|
[![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/guacd.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/guacd "Get your own version badge on microbadger.com")
|
||||||
|
[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/guacd.svg?style=flat-square&color=E68523&label=pulls&logo=docker&logoColor=FFFFFF)](https://hub.docker.com/r/linuxserver/guacd)
|
||||||
|
[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/guacd.svg?style=flat-square&color=E68523&label=stars&logo=docker&logoColor=FFFFFF)](https://hub.docker.com/r/linuxserver/guacd)
|
||||||
|
[![Build Status](https://ci.linuxserver.io/view/all/job/Docker-Pipeline-Builders/job/docker-guacd/job/master/badge/icon?style=flat-square)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-guacd/job/master/)
|
||||||
|
[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/guacd/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/guacd/latest/index.html)
|
||||||
|
|
||||||
[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.
|
[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.
|
||||||
|
|
||||||
|
|
||||||
## Supported Architectures
|
## Supported Architectures
|
||||||
|
|
||||||
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/).
|
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/).
|
||||||
|
@ -13,18 +23,19 @@ Simply pulling `linuxserver/guacd` should retrieve the correct image for your ar
|
||||||
The architectures supported by this image are:
|
The architectures supported by this image are:
|
||||||
|
|
||||||
| Architecture | Tag |
|
| Architecture | Tag |
|
||||||
| :---: | :--- |
|
| :----: | --- |
|
||||||
| x86-64 | amd64-latest |
|
| x86-64 | amd64-latest |
|
||||||
| arm64 | arm64v8-latest |
|
| arm64 | arm64v8-latest |
|
||||||
| armhf | arm32v7-latest |
|
| armhf | arm32v7-latest |
|
||||||
|
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
Here are some example snippets to help you get started creating a container from this image.
|
Here are some example snippets to help you get started creating a container from this image.
|
||||||
|
|
||||||
### docker
|
### docker
|
||||||
|
|
||||||
```text
|
```
|
||||||
docker create \
|
docker create \
|
||||||
--name=guacd \
|
--name=guacd \
|
||||||
-p 4822:4822 \
|
-p 4822:4822 \
|
||||||
|
@ -32,6 +43,7 @@ docker create \
|
||||||
linuxserver/guacd
|
linuxserver/guacd
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
### docker-compose
|
### docker-compose
|
||||||
|
|
||||||
Compatible with docker-compose v2 schemas.
|
Compatible with docker-compose v2 schemas.
|
||||||
|
@ -50,35 +62,38 @@ services:
|
||||||
|
|
||||||
## Parameters
|
## Parameters
|
||||||
|
|
||||||
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.
|
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.
|
||||||
|
|
||||||
### Ports \(`-p`\)
|
### Ports (`-p`)
|
||||||
|
|
||||||
| Parameter | Function |
|
| Parameter | Function |
|
||||||
| :---: | :--- |
|
| :----: | --- |
|
||||||
| `4822` | Port Guacamole server listens on |
|
| `4822` | Port Guacamole server listens on |
|
||||||
|
|
||||||
### Environment Variables \(`-e`\)
|
|
||||||
|
### Environment Variables (`-e`)
|
||||||
|
|
||||||
| Env | Function |
|
| Env | Function |
|
||||||
| :---: | :--- |
|
| :----: | --- |
|
||||||
|
|
||||||
|
### Volume Mappings (`-v`)
|
||||||
### Volume Mappings \(`-v`\)
|
|
||||||
|
|
||||||
| Volume | Function |
|
| Volume | Function |
|
||||||
| :---: | :--- |
|
| :----: | --- |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Application Setup
|
## Application Setup
|
||||||
|
|
||||||
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).
|
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).
|
||||||
|
|
||||||
|
|
||||||
## Docker Mods
|
## Docker Mods
|
||||||
|
[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?style=for-the-badge&color=E68523&label=mods&query=%24.mods%5B%27guacd%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=guacd "view available mods for this container.")
|
||||||
|
|
||||||
[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?style=for-the-badge&color=E68523&label=mods&query=%24.mods%5B%27guacd%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=guacd)
|
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.
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
## Support Info
|
## Support Info
|
||||||
|
|
||||||
|
@ -95,4 +110,3 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to
|
||||||
|
|
||||||
* **08.02.20:** - Bump to 1.1.0.
|
* **08.02.20:** - Bump to 1.1.0.
|
||||||
* **25.05.19:** - Initial Release.
|
* **25.05.19:** - Initial Release.
|
||||||
|
|
||||||
|
|
Ładowanie…
Reference in New Issue