glyptodon/guacamole-db-postgres repository overview

⁠About this image

Glyptodon Enterprise⁠ provides packages of Apache Guacamole⁠ which follow best practices, receive regular updates, and are backed by commercial support. Updates to these packages are made only through contributions to upstream Apache Guacamole, and only to the extent possible without breaking compatibility.

This specific image (glyptodon/guacamole-db-postgres) is a Dockerized deployment of PostgreSQL, built off Docker's official PostgreSQL image⁠ which is automatically initialized with the Apache Guacamole database schema. It is built using the packages provided by Glyptodon Enterprise⁠ and made available under the same EULA⁠. It is normally used to provide a PostgreSQL database for a container using the glyptodon/guacamole image⁠.

⁠How to use this image

⁠Start a Guacamole database instance

To start a PostgreSQL instance which is automatically initialized for use with Apache Guacamole:

docker run --name some-guacamole-db \
    -e ACCEPT_EULA=Y \
    -e GUACAMOLE_DATABASE=guacamole_db \
    -e GUACAMOLE_USERNAME=guacamole_user \
    -e GUACAMOLE_PASSWORD=guacamole_password \
    -d glyptodon/guacamole

where some-guacamole-db is the name you wish to assign to your container, guacamole_db is the name of the database that should be created within PostgreSQL, and guacamole_user and guacamole_password are the credentials that Guacamole will be using to authenticate with PostgreSQL.

⁠... or use docker-compose⁠

docker-compose is highly recommend if deploying Glyptodon Enterprise using Docker, as any deployment of Glyptodon Enterprise using the provided Docker images will involve multiple containers which docker-compose can greatly assist in orchestrating.

For example, a full deployment of Glyptodon Enterprise which uses an automatically-initialized PostgreSQL database for authentication would look like:

version: "3"
services:

    guacd:
        image: glyptodon/guacd
        environment:
            ACCEPT_EULA: Y

    db:
        image: glyptodon/guacamole-db-postgres
        environment:
            ACCEPT_EULA: Y
            GUACAMOLE_DATABASE: guacamole_db
            GUACAMOLE_USERNAME: guacamole_user
            GUACAMOLE_PASSWORD: some_password

    guacamole:
        image: glyptodon/guacamole
        ports:
            - "8080:8080"
        environment:
            ACCEPT_EULA: Y
            GUACD_HOSTNAME: guacd
            POSTGRES_HOSTNAME: db
            POSTGRES_DATABASE: guacamole_db
            POSTGRES_USERNAME: guacamole_user
            POSTGRES_PASSWORD: some_password

⁠Environment variables

In addition to the environment variables documented below, all environment variables supported by the official Docker PostgreSQL image⁠ are accepted, as the official PostgreSQL image forms the basis of this image.

⁠ACCEPT_EULA

The ACCEPT_EULA environment variable must be set to "Y" to indicate your acceptance of the Glyptodon Enterprise EULA⁠. This Docker image may not be used except under the terms of the EULA.

⁠GUACAMOLE_DATABASE

The name of the database to create and initialized for use with Apache Guacamole. This environment variable ultimately maps to the POSTGRES_DB environment variable of the official PostgreSQL image⁠. If omitted, the default value defined by the official PostgreSQL image will be used.

The GUACAMOLE_DATABASE variable is provided here for consistency with the other Guacamole-specific variables and may be omitted if POSTGRES_DB is provided.

⁠GUACAMOLE_USERNAME and GUACAMOLE_PASSWORD

The username and password to use for the PostgreSQL database user specific to the Guacamole web application. This pair of variables differ from the POSTGRES_USER and POSTGRES_PASSWORD environment variables provided by the official PostgreSQL image⁠ in that the created user has limited privileges, being granted only what privileges are absolutely required for Guacamole to run.

The GUACAMOLE_USERNAME and GUACAMOLE_PASSWORD are not strictly required, as the user created with POSTGRES_USER and POSTGRES_PASSWORD may be used instead, however they are strongly recommended to ensure the Principle of Least Privilege⁠ is followed.

⁠Docker secrets

Rather than pass data directly in environment variables, a _FILE suffix may be added to any environment variable supported by this image to force that variable to be read from the named file within the container. As Docker secrets store sensitive data within files beneath /run/secrets/ within the container, this can be used to load sensitive data from Docker secrets.

For example, to load the username and password for the limited-privilege user specific to the Guacamole web application from Docker secrets:

docker run --name some-guacamole-db \
    -e ACCEPT_EULA=Y \
    -e GUACAMOLE_DATABASE=guacamole_db \
    -e GUACAMOLE_USERNAME_FILE=/run/secrets/postgres-username \
    -e GUACAMOLE_PASSWORD_FILE=/run/secrets/postgres-password \
    -d glyptodon/guacamole-db-postgres

⁠License

This Docker image is made available only under the terms of the Glyptodon Enterprise EULA⁠. By passing the value "Y" to the environment variable ACCEPT_EULA, you are expressing that you have a valid and existing license for Glyptodon Enterprise and that you accept that your use of this Docker image is bound by these terms.