Skip to content

Commit

Permalink
README update: Add guacd installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
vadimpronin committed Jan 19, 2024
1 parent 576f57b commit 06a1595
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,13 +101,26 @@ npm install guacamole-lite --save
This will add `guacamole-lite` as a dependency to your `package.json` file and download it to the `node_modules`
directory.

## Before You Start

Before you start, make sure you have `guacd` installed and running on your server.
The easiest way to run `guacd` is to use the official Docker image:

```sh
docker run --name guacd -d -p 4822:4822 guacamole/guacd
```

Alternatively, you can install guacd from source. For more details, refer to the official documentation on
[Installing guacamole-server](https://guacamole.apache.org/doc/gug/installing-guacamole.html#installing-guacamole-server)
or `guacamole-server` [README](https://github.com/apache/guacamole-server/blob/master/README) on github.

## Quick Start Guide

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

### Basic Server Setup
### Basic `guacamole-lite` Server Setup

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

Expand Down

0 comments on commit 06a1595

Please sign in to comment.