Skip to content

Commit 06a1595

Browse files
committed
README update: Add guacd installation instructions
1 parent 576f57b commit 06a1595

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,13 +101,26 @@ npm install guacamole-lite --save
101101
This will add `guacamole-lite` as a dependency to your `package.json` file and download it to the `node_modules`
102102
directory.
103103

104+
## Before You Start
105+
106+
Before you start, make sure you have `guacd` installed and running on your server.
107+
The easiest way to run `guacd` is to use the official Docker image:
108+
109+
```sh
110+
docker run --name guacd -d -p 4822:4822 guacamole/guacd
111+
```
112+
113+
Alternatively, you can install guacd from source. For more details, refer to the official documentation on
114+
[Installing guacamole-server](https://guacamole.apache.org/doc/gug/installing-guacamole.html#installing-guacamole-server)
115+
or `guacamole-server` [README](https://github.com/apache/guacamole-server/blob/master/README) on github.
116+
104117
## Quick Start Guide
105118

106119
To get started with `guacamole-lite` and create a Guacamole-compatible server, follow the basic example below. For
107120
advanced configuration options, please refer to the relevant sections of
108121
the [advanced configuration documentation](docs/advanced-configuration.md).
109122

110-
### Basic Server Setup
123+
### Basic `guacamole-lite` Server Setup
111124

112125
Here's a minimal example to set up a `guacamole-lite` server:
113126

0 commit comments

Comments
 (0)