ansible-role-guacamole

KO | EN

gitlite — search

#javascript #react #typescript #llm #rust #deep-learning #docker #macos #nodejs #java #awesome #kubernetes #ios #open-source

ansible-role-guacamole

(★ 8)

An Ansible role for installing cisagov/guacamole-composition

ansible-role-guacamole Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# ansible-role-guacamole #

[![GitHub Build Status](https://github.com/cisagov/ansible-role-guacamole/workflows/build/badge.svg)](https://github.com/cisagov/ansible-role-guacamole/actions)
[![License](https://img.shields.io/github/license/cisagov/ansible-role-guacamole)](https://spdx.org/licenses/)
[![CodeQL](https://github.com/cisagov/ansible-role-guacamole/workflows/CodeQL/badge.svg)](https://github.com/cisagov/ansible-role-guacamole/actions/workflows/codeql-analysis.yml)

An Ansible role for installing [cisagov/guacamole-composition](https://github.com/cisagov/guacamole-composition).

> [!NOTE]
> Note that we disable apache2.service in this Ansible role.
> apache2.service cannot start successfully until cloud-final.service
> has run because it requires that certificates be downloaded via a
> cloud-init user-data script, but adding cloud-final.service as a
> dependency of apache2.service results in a systemd dependency loop.
> The solution is to start and enable apache2.service via a user-data
> script run by cloud-init *after* cloud-init has downloaded the
> certificates.

## Requirements ##

None.

## Role Variables ##

| Variable | Description | Default | Required |
| -------- | ----------- | ------- | -------- |
| guacamole_composition_version | The version of [cisagov/guacamole-composition](https://github.com/cisagov/guacamole-composition) to use. | `1.0.3` | No |
| guacamole_postgres_username | The username to use when connecting to the PostgreSQL database that backends Guacamole. | n/a | Yes |
| guacamole_postgres_password | The password to use when connecting to the PostgreSQL database that backends Guacamole. | n/a | Yes |
| guacamole_private_ssh_key | The private ssh key to use for SFTP file transfer in Guacamole. | n/a | Yes |
| guacamole_rdp_username | The username for Guacamole to use when connecting to an instance via RDP. | n/a | Yes |
| guacamole_rdp_password | The password for Guacamole to use when connecting to an instance via RDP. | n/a | Yes |
| guacamole_vnc_username | The username for Guacamole to use when connecting to an instance via VNC. | n/a | Yes |
| guacamole_vnc_password | The password for Guacamole to use when connecting to an instance via VNC. | n/a | Yes |
| guacamole_windows_sftp_base | The base path for the SFTP directories that Guacamole will use when connecting to a Windows instance via VNC. | n/a | Yes |

## Dependencies ##

- [cisagov/ansible-role-docker](https://github.com/cisagov/ansible-role-docker)
- [cisagov/ansible-role-httpd](https://github.com/cisagov/ansible-role-httpd)

## Installation ##

This role can be installed via the command:

```console
ansible-galaxy install --role-file path/to/requirements.yml
```

where `requirements.yml` looks like:

```yaml
---
- name: guacamole
  src: https://github.com/cisagov/ansible-role-guacamole
```

and may contain other roles as well.

For more information about installing Ansible roles via a YAML file,
please see [the `ansible-galaxy`
documentation](https://docs.ansible.com/ansible/latest/galaxy/user_guide.html#installing-multiple-roles-from-a-file).

## Example Playbook ##

Here's how to use it in a playbook:

```yaml
- hosts: all
  become: true
  become_method: sudo
  tasks:
    - name: Install Guacamole
      ansible.builtin.include_role:
        name: guacamole
      vars:
        guacamole_postgres_username: postgres_user
        guacamole_postgres_password: postgres_password
        guacamole_private_ssh_key: dummy_key
        guacamole_rdp_username: rdp_user
        guacamole_rdp_password: rdp_password
        guacamole_vnc_username: vnc_user
        guacamole_vnc_password: vnc_password
        guacamole_windows_sftp_base: /C:/Users/vnc_user
```

## Contributing ##

We welcome contributions!  Please see [`CONTRIBUTING.md`](CONTRIBUTING.md) for
details.

## License ##

This project is in the worldwide [public domain](LICENSE).

This project is in the public domain within the United States, and
copyright and related rights in the work worldwide are waived through
the [CC0 1.0 Universal public domain
dedication](https://creativecommons.org/publicdomain/zero/1.0/).

All contributions to this project will be released under the CC0
dedication. By submitting a pull request, you are agreeing to comply
with this waiver of copyright interest.

## Author Information ##

Kyle Evers - <kyle.evers@gwe.cisa.dhs.gov>

ansible-role-guacamole

ansible-role-guacamole Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

ansible-role-guacamole

ansible-role-guacamole Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README