mirror of
https://github.com/gyurix1968/guacamole-client.git
synced 2025-09-05 20:57:40 +00:00
GUACAMOLE-1572: Merge updated POSTGRESQL environment variable names.
This commit is contained in:
James Muehlner
GitHub
@@ -55,31 +55,31 @@ Deploying Guacamole with PostgreSQL authentication
|
||||
--------------------------------------------------
|
||||
|
||||
docker run --name some-guacamole --link some-guacd:guacd \
|
||||
--link some-postgres:postgres \
|
||||
-e POSTGRES_DATABASE=guacamole_db \
|
||||
-e POSTGRES_USER=guacamole_user \
|
||||
-e POSTGRES_PASSWORD=some_password \
|
||||
-e POSTGRES_DATABASE_FILE=/run/secrets/<secret_name> \
|
||||
-e POSTGRES_USER_FILE=/run/secrets/<secret_name> \
|
||||
-e POSTGRES_PASSWORD_FILE=/run/secrets/<secret_name> \
|
||||
--link some-postgres:postgres \
|
||||
-e POSTGRESQL_DATABASE=guacamole_db \
|
||||
-e POSTGRESQL_USER=guacamole_user \
|
||||
-e POSTGRESQL_PASSWORD=some_password \
|
||||
-e POSTGRESQL_DATABASE_FILE=/run/secrets/<secret_name> \
|
||||
-e POSTGRESQL_USER_FILE=/run/secrets/<secret_name> \
|
||||
-e POSTGRESQL_PASSWORD_FILE=/run/secrets/<secret_name> \
|
||||
-d -p 8080:8080 guacamole/guacamole
|
||||
|
||||
Linking Guacamole to PostgreSQL requires three environment variables. If any of
|
||||
these environment variables are omitted, you will receive an error message, and
|
||||
the image will stop:
|
||||
|
||||
1. `POSTGRES_DATABASE` - The name of the database to use for Guacamole
|
||||
1. `POSTGRESQL_DATABASE` - The name of the database to use for Guacamole
|
||||
authentication.
|
||||
2. `POSTGRES_USER` - The user that Guacamole will use to connect to PostgreSQL.
|
||||
3. `POSTGRES_PASSWORD` - The password that Guacamole will provide when
|
||||
connecting to PostgreSQL as `POSTGRES_USER`.
|
||||
4. `POSTGRES_DATABASE_FILE` - The path of the docker secret containing the name
|
||||
2. `POSTGRESQL_USER` - The user that Guacamole will use to connect to PostgreSQL.
|
||||
3. `POSTGRESQL_PASSWORD` - The password that Guacamole will provide when
|
||||
connecting to PostgreSQL as `POSTGRESQL_USER`.
|
||||
4. `POSTGRESQL_DATABASE_FILE` - The path of the docker secret containing the name
|
||||
of database to use for Guacamole authentication.
|
||||
5. `POSTGRES_USER_FILE` - The path of the docker secret containing the name of
|
||||
5. `POSTGRESQL_USER_FILE` - The path of the docker secret containing the name of
|
||||
the user that Guacamole will use to connect to PostgreSQL.
|
||||
6. `POSTGRES_PASSWORD_FILE` - The path of the docker secret containing the
|
||||
6. `POSTGRESQL_PASSWORD_FILE` - The path of the docker secret containing the
|
||||
password that Guacamole will provide when connecting to PostgreSQL as
|
||||
`POSTGRES_USER.
|
||||
`POSTGRESQL_USER.
|
||||
|
||||
### Initializing the PostgreSQL database
|
||||
|
||||
@@ -91,7 +91,7 @@ To generate a SQL script which can be used to initialize a fresh PostgreSQL
|
||||
database
|
||||
[as documented in the Guacamole manual](http://guacamole.apache.org/doc/gug/jdbc-auth.html#jdbc-auth-postgresql):
|
||||
|
||||
docker run --rm guacamole/guacamole /opt/guacamole/bin/initdb.sh --postgres > initdb.sql
|
||||
docker run --rm guacamole/guacamole /opt/guacamole/bin/initdb.sh --postgresql > initdb.sql
|
||||
|
||||
Alternatively, you can use the SQL scripts included with the
|
||||
guacamole-auth-jdbc extension from
|
||||
|
||||
@@ -26,7 +26,7 @@
|
||||
##
|
||||
## @param DATABASE
|
||||
## The database to generate the SQL script for. This may be either
|
||||
## "--postgres", for PostgreSQL, "--mysql" for MySQL, or "--sqlserver" for Microsoft SQL Server.
|
||||
## "--postgresql", for PostgreSQL, "--mysql" for MySQL, or "--sqlserver" for Microsoft SQL Server.
|
||||
##
|
||||
|
||||
DATABASE="$1"
|
||||
@@ -37,7 +37,7 @@ DATABASE="$1"
|
||||
##
|
||||
incorrect_usage() {
|
||||
cat <<END
|
||||
USAGE: /opt/guacamole/bin/initdb.sh [--postgres | --mysql | --sqlserver]
|
||||
USAGE: /opt/guacamole/bin/initdb.sh [--postgresql | --mysql | --sqlserver]
|
||||
END
|
||||
exit 1
|
||||
}
|
||||
@@ -54,7 +54,7 @@ fi
|
||||
|
||||
case $DATABASE in
|
||||
|
||||
--postgres)
|
||||
--postgresql)
|
||||
cat /opt/guacamole/postgresql/schema/*.sql
|
||||
;;
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
#!/bin/sh -e
|
||||
#!/bin/bash -e
|
||||
#
|
||||
# Licensed to the Apache Software Foundation (ASF) under one
|
||||
# or more contributor license agreements. See the NOTICE file
|
||||
@@ -242,7 +242,7 @@ END
|
||||
}
|
||||
|
||||
# Print error message regarding missing required variables for PostgreSQL authentication
|
||||
postgres_missing_vars() {
|
||||
postgresql_missing_vars() {
|
||||
cat <<END
|
||||
FATAL: Missing required environment variables
|
||||
-------------------------------------------------------------------------------
|
||||
@@ -251,40 +251,63 @@ environment variables or their corresponding Docker secrets by appending _FILE
|
||||
to the environment variable, and setting the value to the path of the
|
||||
corresponding secret:
|
||||
|
||||
POSTGRES_USER The user to authenticate as when connecting to
|
||||
PostgreSQL.
|
||||
POSTGRESQL_USER The user to authenticate as when connecting to
|
||||
PostgreSQL.
|
||||
|
||||
POSTGRES_PASSWORD The password to use when authenticating with PostgreSQL
|
||||
as POSTGRES_USER.
|
||||
POSTGRESQL_PASSWORD The password to use when authenticating with PostgreSQL
|
||||
as POSTGRESQL_USER.
|
||||
|
||||
POSTGRES_DATABASE The name of the PostgreSQL database to use for Guacamole
|
||||
authentication.
|
||||
POSTGRESQL_DATABASE The name of the PostgreSQL database to use for Guacamole
|
||||
authentication.
|
||||
END
|
||||
exit 1;
|
||||
}
|
||||
|
||||
## Provide backward compatibility on POSTGRES_* environment variables
|
||||
## In case of new deployment, please use POSTGRESQL_* equivalent variables.
|
||||
for VAR_BASE in \
|
||||
HOSTNAME PORT \
|
||||
DATABASE USER PASSWORD \
|
||||
DATABASE_FILE USER_FILE PASSWORD_FILE \
|
||||
ABSOLUTE_MAX_CONNECTIONS DEFAULT_MAX_CONNECTIONS \
|
||||
DEFAULT_MAX_GROUP_CONNECTIONS DEFAULT_MAX_CONNECTIONS_PER_USER \
|
||||
DEFAULT_MAX_GROUP_CONNECTIONS_PER_USER \
|
||||
DEFAULT_STATEMENT_TIMEOUT SOCKET_TIMEOUT \
|
||||
USER_REQUIRED \
|
||||
SSL_KEY_PASSWORD_FILE SSL_KEY_PASSWORD; do
|
||||
|
||||
OLD_VAR="POSTGRES_$VAR_BASE"
|
||||
NEW_VAR="POSTGRESQL_$VAR_BASE"
|
||||
|
||||
if [ -n "${!OLD_VAR}" ]; then
|
||||
printf -v "$NEW_VAR" "%s" "${!OLD_VAR}"
|
||||
echo "WARNING: ${OLD_VAR} detected, please use ${NEW_VAR} for further deployments."
|
||||
fi
|
||||
|
||||
done
|
||||
|
||||
##
|
||||
## Adds properties to guacamole.properties which select the PostgreSQL
|
||||
## authentication provider, and configure it to connect to the linked
|
||||
## PostgreSQL container. If a PostgreSQL database is explicitly specified using
|
||||
## the POSTGRES_HOSTNAME and POSTGRES_PORT environment variables, that will be
|
||||
## the POSTGRESQL_HOSTNAME and POSTGRESQL_PORT environment variables, that will be
|
||||
## used instead of a linked container.
|
||||
##
|
||||
associate_postgresql() {
|
||||
|
||||
# Use linked container if specified
|
||||
if [ -n "$POSTGRES_NAME" ]; then
|
||||
POSTGRES_HOSTNAME="$POSTGRES_PORT_5432_TCP_ADDR"
|
||||
POSTGRES_PORT="$POSTGRES_PORT_5432_TCP_PORT"
|
||||
POSTGRESQL_HOSTNAME="$POSTGRES_PORT_5432_TCP_ADDR"
|
||||
POSTGRESQL_PORT="$POSTGRES_PORT_5432_TCP_PORT"
|
||||
fi
|
||||
|
||||
# Use default port if none specified
|
||||
POSTGRES_PORT="${POSTGRES_PORT-5432}"
|
||||
POSTGRESQL_PORT="${POSTGRESQL_PORT-5432}"
|
||||
|
||||
# Verify required connection information is present
|
||||
if [ -z "$POSTGRES_HOSTNAME" -o -z "$POSTGRES_PORT" ]; then
|
||||
if [ -z "$POSTGRESQL_HOSTNAME" -o -z "$POSTGRESQL_PORT" ]; then
|
||||
cat <<END
|
||||
FATAL: Missing POSTGRES_HOSTNAME or "postgres" link.
|
||||
FATAL: Missing POSTGRESQL_HOSTNAME or "postgres" link.
|
||||
-------------------------------------------------------------------------------
|
||||
If using a PostgreSQL database, you must either:
|
||||
|
||||
@@ -293,82 +316,82 @@ If using a PostgreSQL database, you must either:
|
||||
(b) If not using a Docker container for PostgreSQL, explicitly specify the TCP
|
||||
connection to your database using the following environment variables:
|
||||
|
||||
POSTGRES_HOSTNAME The hostname or IP address of the PostgreSQL server. If
|
||||
not using a PostgreSQL Docker container and
|
||||
corresponding link, this environment variable is
|
||||
*REQUIRED*.
|
||||
POSTGRESQL_HOSTNAME The hostname or IP address of the PostgreSQL server. If
|
||||
not using a PostgreSQL Docker container and
|
||||
corresponding link, this environment variable is
|
||||
*REQUIRED*.
|
||||
|
||||
POSTGRES_PORT The port on which the PostgreSQL server is listening for
|
||||
TCP connections. This environment variable is option. If
|
||||
omitted, the standard PostgreSQL port of 5432 will be
|
||||
used.
|
||||
POSTGRESQL_PORT The port on which the PostgreSQL server is listening for
|
||||
TCP connections. This environment variable is option. If
|
||||
omitted, the standard PostgreSQL port of 5432 will be
|
||||
used.
|
||||
END
|
||||
exit 1;
|
||||
fi
|
||||
|
||||
# Verify that the required Docker secrets are present, else, default to their normal environment variables
|
||||
if [ -n "$POSTGRES_USER_FILE" ]; then
|
||||
set_property "postgresql-username" "`cat "$POSTGRES_USER_FILE"`"
|
||||
elif [ -n "$POSTGRES_USER" ]; then
|
||||
set_property "postgresql-username" "$POSTGRES_USER"
|
||||
if [ -n "$POSTGRESQL_USER_FILE" ]; then
|
||||
set_property "postgresql-username" "`cat "$POSTGRESQL_USER_FILE"`"
|
||||
elif [ -n "$POSTGRESQL_USER" ]; then
|
||||
set_property "postgresql-username" "$POSTGRESQL_USER"
|
||||
else
|
||||
postgres_missing_vars
|
||||
postgresql_missing_vars
|
||||
exit 1;
|
||||
fi
|
||||
|
||||
if [ -n "$POSTGRES_PASSWORD_FILE" ]; then
|
||||
set_property "postgresql-password" "`cat "$POSTGRES_PASSWORD_FILE"`"
|
||||
elif [ -n "$POSTGRES_PASSWORD" ]; then
|
||||
set_property "postgresql-password" "$POSTGRES_PASSWORD"
|
||||
if [ -n "$POSTGRESQL_PASSWORD_FILE" ]; then
|
||||
set_property "postgresql-password" "`cat "$POSTGRESQL_PASSWORD_FILE"`"
|
||||
elif [ -n "$POSTGRESQL_PASSWORD" ]; then
|
||||
set_property "postgresql-password" "$POSTGRESQL_PASSWORD"
|
||||
else
|
||||
postgres_missing_vars
|
||||
postgresql_missing_vars
|
||||
exit 1;
|
||||
fi
|
||||
|
||||
if [ -n "$POSTGRES_DATABASE_FILE" ]; then
|
||||
set_property "postgresql-database" "`cat "$POSTGRES_DATABASE_FILE"`"
|
||||
elif [ -n "$POSTGRES_DATABASE" ]; then
|
||||
set_property "postgresql-database" "$POSTGRES_DATABASE"
|
||||
if [ -n "$POSTGRESQL_DATABASE_FILE" ]; then
|
||||
set_property "postgresql-database" "`cat "$POSTGRESQL_DATABASE_FILE"`"
|
||||
elif [ -n "$POSTGRESQL_DATABASE" ]; then
|
||||
set_property "postgresql-database" "$POSTGRESQL_DATABASE"
|
||||
else
|
||||
postgres_missing_vars
|
||||
postgresql_missing_vars
|
||||
exit 1;
|
||||
fi
|
||||
|
||||
# Update config file
|
||||
set_property "postgresql-hostname" "$POSTGRES_HOSTNAME"
|
||||
set_property "postgresql-port" "$POSTGRES_PORT"
|
||||
set_property "postgresql-hostname" "$POSTGRESQL_HOSTNAME"
|
||||
set_property "postgresql-port" "$POSTGRESQL_PORT"
|
||||
|
||||
set_optional_property \
|
||||
"postgresql-absolute-max-connections" \
|
||||
"$POSTGRES_ABSOLUTE_MAX_CONNECTIONS"
|
||||
"$POSTGRESQL_ABSOLUTE_MAX_CONNECTIONS"
|
||||
|
||||
set_optional_property \
|
||||
"postgresql-default-max-connections" \
|
||||
"$POSTGRES_DEFAULT_MAX_CONNECTIONS"
|
||||
"$POSTGRESQL_DEFAULT_MAX_CONNECTIONS"
|
||||
|
||||
set_optional_property \
|
||||
"postgresql-default-max-group-connections" \
|
||||
"$POSTGRES_DEFAULT_MAX_GROUP_CONNECTIONS"
|
||||
"$POSTGRESQL_DEFAULT_MAX_GROUP_CONNECTIONS"
|
||||
|
||||
set_optional_property \
|
||||
"postgresql-default-max-connections-per-user" \
|
||||
"$POSTGRES_DEFAULT_MAX_CONNECTIONS_PER_USER"
|
||||
"$POSTGRESQL_DEFAULT_MAX_CONNECTIONS_PER_USER"
|
||||
|
||||
set_optional_property \
|
||||
"postgresql-default-max-group-connections-per-user" \
|
||||
"$POSTGRES_DEFAULT_MAX_GROUP_CONNECTIONS_PER_USER"
|
||||
"$POSTGRESQL_DEFAULT_MAX_GROUP_CONNECTIONS_PER_USER"
|
||||
|
||||
set_optional_property \
|
||||
"postgresql-default-statement-timeout" \
|
||||
"$POSTGRES_DEFAULT_STATEMENT_TIMEOUT"
|
||||
"$POSTGRESQL_DEFAULT_STATEMENT_TIMEOUT"
|
||||
|
||||
set_optional_property \
|
||||
"postgresql-user-required" \
|
||||
"$POSTGRES_USER_REQUIRED"
|
||||
"$POSTGRESQL_USER_REQUIRED"
|
||||
|
||||
set_optional_property \
|
||||
"postgresql-socket-timeout" \
|
||||
"$POSTGRES_SOCKET_TIMEOUT"
|
||||
"$POSTGRESQL_SOCKET_TIMEOUT"
|
||||
|
||||
set_optional_property \
|
||||
"postgresql-ssl-mode" \
|
||||
@@ -387,10 +410,10 @@ END
|
||||
"$POSTGRESQL_SSL_ROOT_CERT_FILE"
|
||||
|
||||
# For SSL key password, check secrets, first, then standard env variable
|
||||
if [ -n "$POSTGRES_SSL_KEY_PASSWORD_FILE" ]; then
|
||||
set_property "postgresql-ssl-key-password" "`cat "$POSTGRES_SSL_KEY_PASSWORD_FILE"`"
|
||||
elif [ -n "$POSTGRES_SSL_KEY_PASSWORD" ]; then
|
||||
set_property "postgresql-ssl-key-password" "$POSTGRES_SSL_KEY_PASSWORD"
|
||||
if [ -n "$POSTGRESQL_SSL_KEY_PASSWORD_FILE" ]; then
|
||||
set_property "postgresql-ssl-key-password" "`cat "$POSTGRESQL_SSL_KEY_PASSWORD_FILE"`"
|
||||
elif [ -n "$POSTGRESQL_SSL_KEY_PASSWORD" ]; then
|
||||
set_property "postgresql-ssl-key-password" "$POSTGRESQL_SSL_KEY_PASSWORD"
|
||||
fi
|
||||
|
||||
set_optional_property \
|
||||
@@ -430,7 +453,7 @@ set the path of the corresponding secrets in the following three variables:
|
||||
the user that Guacamole will use to connect to SQLServer.
|
||||
|
||||
SQLSERVER_PASSWORD_FILE The path of the docker secret containing the
|
||||
password that Guacamole will provide when connecting to
|
||||
password that Guacamole will provide when connecting to
|
||||
SQLServer as SQLSERVER_USER.
|
||||
|
||||
END
|
||||
@@ -1077,9 +1100,9 @@ if [ -n "$MYSQL_DATABASE" -o -n "$MYSQL_DATABASE_FILE" ]; then
|
||||
fi
|
||||
|
||||
# Use PostgreSQL if database specified
|
||||
if [ -n "$POSTGRES_DATABASE" -o -n "$POSTGRES_DATABASE_FILE" ]; then
|
||||
if [ -n "$POSTGRESQL_DATABASE" -o -n "$POSTGRESQL_DATABASE_FILE" ]; then
|
||||
associate_postgresql
|
||||
INSTALLED_AUTH="$INSTALLED_AUTH postgres"
|
||||
INSTALLED_AUTH="$INSTALLED_AUTH postgresql"
|
||||
fi
|
||||
|
||||
# Use SQLServer if database specified
|
||||
@@ -1149,7 +1172,7 @@ FATAL: No authentication configured
|
||||
The Guacamole Docker container needs at least one authentication mechanism in
|
||||
order to function, such as a MySQL database, PostgreSQL database, SQLServer
|
||||
database, LDAP directory or RADIUS server. Please specify at least the
|
||||
MYSQL_DATABASE or POSTGRES_DATABASE or SQLSERVER_DATABASE environment variables,
|
||||
MYSQL_DATABASE or POSTGRESQL_DATABASE or SQLSERVER_DATABASE environment variables,
|
||||
or check Guacamole's Docker documentation regarding configuring LDAP and/or
|
||||
custom extensions.
|
||||
END
|
||||
|
||||
Reference in New Issue
Block a user