Skip to main content

Easy deployment of Apache Guacamole.

Project description

guacamole-compose

docker-compose script for running apache guacamole.

Overview

This set of scripts and templates automates the deployment process for guacamole.

  • Generates the docker-compose script.
  • Generates the mysql initialization script, to configure a new mysql database.
  • Generates an nginx configuration.
  • Has parameter options and templates, so you should just have to change a single parameter file for each deployment.
  • Adds users to mysql from ldap.
  • Configures connections from ldap.
  • Configures additional manual connections from the paramters.yaml file.

Requirements

  • docker
  • docker-compose
  • python3 (3.9)
  • pip

Python Packages

  • guacamole-compose

  • Note, guacamole-compose will install the following packages:

    • sqlalchemy
    • docker
    • ldap3
    • pymysql
    • dnspython (v2.0.0)
    • pyyaml
    • cryptography
    • yamlarg

Usage

sudo python3.9 -m pip install --upgrade guacamole-compose
sudo guacamole-compose --init
sudo guacamole-compose --deploy --ldap

% guacamole-compose --help
usage: guacamole-compose [-h] [--init] [--clean] [--deploy] [--nginx] [--ldap]

optional arguments:
  -h, --help  show this help message and exit
  --init      Initialize the directory and files required.
  --clean     Clean the directories automatically created during deployment.
  --deploy    Generate configurations and deploy guacamole using docker-compose.
  --nginx     Generate the nginx.conf file located at./nginx/conf/nginx.conf.
  --ldap      Used to create/update connections, groups, and permissions using ldap.

Cleanup of shared directory, and periodic user sync.

Note: Check your python executable path, and modify for the cron entry below. Or just use 'python3.9' in the cron job, instead of the full path.

python3.9
import sys
print(sys.executable)
crontab -e

0 0 * * * find /root/guacamole-compose/shared/* -mtime +6 -type f -delete
*/5 * * * * cd /root/guacamole-compose && /usr/local/bin/python3.8 ./guac-deploy.py --create_users

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

guacamole_compose-0.0.9-py2.py3-none-any.whl (20.3 MB view details)

Uploaded Python 2Python 3

File details

Details for the file guacamole_compose-0.0.9-py2.py3-none-any.whl.

File metadata

  • Download URL: guacamole_compose-0.0.9-py2.py3-none-any.whl
  • Upload date:
  • Size: 20.3 MB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/51.1.1 requests-toolbelt/0.9.1 tqdm/4.56.2 CPython/3.9.1

File hashes

Hashes for guacamole_compose-0.0.9-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 5324ba1c0bf5ef6349b79796cf442d50d164415a591ea7b9c7f8ac3f656f3d87
MD5 64aef89b8e36fc0b54f377cd62067652
BLAKE2b-256 7ff9b700de21170a7ca6298a2b138b70a07ec0cdac9d222452d7b08fed7c6140

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page