GUACAMOLE-1316: Remove all unnecessary trailing whitespace from Docker-related files.
diff --git a/guacamole-docker/README.md b/guacamole-docker/README.md
index 34124b1..f7b7abe 100644
--- a/guacamole-docker/README.md
+++ b/guacamole-docker/README.md
@@ -30,24 +30,24 @@
Docker Secrets
==============
-The string `_FILE` may be appended to some of the environment variables listed
-below if you are using MySQL or PostgreSQL authentication. This will cause the
+The string `_FILE` may be appended to some of the environment variables listed
+below if you are using MySQL or PostgreSQL authentication. This will cause the
startup script to load the values for those variables from files within
-the container.
+the container.
-This is useful for specifying sensitive info, ie. passwords for
+This is useful for specifying sensitive info, ie. passwords for
the database, in secured files instead of plaintext environment variables. This
-is generally used for loading values from [Docker secrets](https://docs.docker.com/engine/swarm/secrets/#read-more-about-docker-secret-commands), which are stored at
-`/run/secrets/<secret_name>` within the container.
+is generally used for loading values from [Docker secrets](https://docs.docker.com/engine/swarm/secrets/#read-more-about-docker-secret-commands),
+which are stored at `/run/secrets/<secret_name>` within the container.
It is important to note that the startup script is configured such that:
-1. You may mix the use of Docker secrets and normal environment variables.
-For example, you may wish to use `MYSQL_USER_FILE` and `MYSQL_PASSWORD_FILE`,
+1. You may mix the use of Docker secrets and normal environment variables.
+For example, you may wish to use `MYSQL_USER_FILE` and `MYSQL_PASSWORD_FILE`,
but wish to specify the database name with `MYSQL_DATABASE`
2. If both a normal environment variable and its corresponding secret are defined
-in the same command line, or section within a [Compose](https://docs.docker.com/compose/) file,
+in the same command line, or section within a [Compose](https://docs.docker.com/compose/) file,
the secret will take precedence. For instance, if both `MYSQL_PASSWORD`
and `MYSQL_PASSWORD_FILE` are given, `MYSQL_PASSWORD_FILE` will be used.
@@ -58,7 +58,7 @@
--link some-postgres:postgres \
-e POSTGRES_DATABASE=guacamole_db \
-e POSTGRES_USER=guacamole_user \
- -e POSTGRES_PASSWORD=some_password \
+ -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> \
@@ -68,16 +68,18 @@
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 authentication.
+1. `POSTGRES_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 of database
-to use for Guacamole authentication.
-5. `POSTGRES_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 password
-that Guacamole will provide when connecting to PostgreSQL as `POSTGRES_USER.
+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
+ of database to use for Guacamole authentication.
+5. `POSTGRES_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
+ password that Guacamole will provide when connecting to PostgreSQL as
+ `POSTGRES_USER.
### Initializing the PostgreSQL database
@@ -123,16 +125,18 @@
these environment variables are omitted, you will receive an error message, and
the image will stop:
-1. `MYSQL_DATABASE` - The name of the database to use for Guacamole authentication.
+1. `MYSQL_DATABASE` - The name of the database to use for Guacamole
+ authentication.
2. `MYSQL_USER` - The user that Guacamole will use to connect to MySQL.
-3. `MYSQL_PASSWORD` - The password that Guacamole will provide when connecting
-to MySQL as `MYSQL_USER`.
-4. `MYSQL_DATABASE_FILE` - The path of the docker secret containing the name of the
-database to use for Guacamole authentication.
-5. `MYSQL_USER_FILE` - The path of the docker secret containing the name of the user
-that Guacamole will use to connect to MySQL.
-6. `MYSQL_PASSWORD_FILE` - The path of the docker secret containing the password
-that Guacamole will provide when connecting to MySQL as`MYSQL_USER`.
+3. `MYSQL_PASSWORD` - The password that Guacamole will provide when connecting
+ to MySQL as `MYSQL_USER`.
+4. `MYSQL_DATABASE_FILE` - The path of the docker secret containing the name of
+ the database to use for Guacamole authentication.
+5. `MYSQL_USER_FILE` - The path of the docker secret containing the name of the
+ user that Guacamole will use to connect to MySQL.
+6. `MYSQL_PASSWORD_FILE` - The path of the docker secret containing the
+ password that Guacamole will provide when connecting to MySQL
+ as`MYSQL_USER`.
### Initializing the MySQL database
diff --git a/guacamole-docker/bin/start.sh b/guacamole-docker/bin/start.sh
index 4d6ab41..e6bd50e 100755
--- a/guacamole-docker/bin/start.sh
+++ b/guacamole-docker/bin/start.sh
@@ -91,7 +91,7 @@
-------------------------------------------------------------------------------
If using a MySQL database, you must provide each of the following
environment variables or their corresponding Docker secrets by appending _FILE
-to the environment variable, and setting the value to the path of the
+to the environment variable, and setting the value to the path of the
corresponding secret:
MYSQL_USER The user to authenticate as when connecting to
@@ -158,7 +158,7 @@
mysql_missing_vars
exit 1;
fi
-
+
if [ -n "$MYSQL_PASSWORD_FILE" ]; then
set_property "mysql-password" "`cat "$MYSQL_PASSWORD_FILE"`"
elif [ -n "$MYSQL_PASSWORD" ]; then
@@ -248,7 +248,7 @@
-------------------------------------------------------------------------------
If using a PostgreSQL database, you must provide each of the following
environment variables or their corresponding Docker secrets by appending _FILE
-to the environment variable, and setting the value to the path of the
+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
@@ -315,7 +315,7 @@
postgres_missing_vars
exit 1;
fi
-
+
if [ -n "$POSTGRES_PASSWORD_FILE" ]; then
set_property "postgresql-password" "`cat "$POSTGRES_PASSWORD_FILE"`"
elif [ -n "$POSTGRES_PASSWORD" ]; then
@@ -470,13 +470,13 @@
If using RADIUS server, you must provide each of the following environment
variables:
- RADIUS_SHARED_SECRET The shared secret to use when talking to the
+ RADIUS_SHARED_SECRET The shared secret to use when talking to the
RADIUS server.
- RADIUS_AUTH_PROTOCOL The authentication protocol to use when talking
+ RADIUS_AUTH_PROTOCOL The authentication protocol to use when talking
to the RADIUS server.
- Supported values are:
- pap, chap, mschapv1, mschapv2, eap-md5,
+ Supported values are:
+ pap, chap, mschapv1, mschapv2, eap-md5,
eap-tls and eap-ttls.
END
exit 1;
@@ -485,7 +485,7 @@
# Verify provided files do exist and are readable
if [ -n "$RADIUS_KEY_FILE" -a ! -r "$RADIUS_KEY_FILE" ]; then
cat <<END
-FATAL: Provided file RADIUS_KEY_FILE=$RADIUS_KEY_FILE does not exist
+FATAL: Provided file RADIUS_KEY_FILE=$RADIUS_KEY_FILE does not exist
or is not readable!
-------------------------------------------------------------------------------
If you provide key or CA files you need to mount those into the container and
@@ -495,7 +495,7 @@
fi
if [ -n "$RADIUS_CA_FILE" -a ! -r "$RADIUS_CA_FILE" ]; then
cat <<END
-FATAL: Provided file RADIUS_CA_FILE=$RADIUS_CA_FILE does not exist
+FATAL: Provided file RADIUS_CA_FILE=$RADIUS_CA_FILE does not exist
or is not readable!
-------------------------------------------------------------------------------
If you provide key or CA files you need to mount those into the container and
@@ -559,19 +559,19 @@
OPENID_AUTHORIZATION_ENDPOINT The authorization endpoint (URI) of the OpenID service.
OPENID_JWKS_ENDPOINT The endpoint (URI) of the JWKS service which defines
- how received ID tokens (JSON Web Tokens or JWTs)
+ how received ID tokens (JSON Web Tokens or JWTs)
shall be validated.
OPENID_ISSUER The issuer to expect for all received ID tokens.
- OPENID_CLIENT_ID The OpenID client ID which should be submitted
- to the OpenID service when necessary.
- This value is typically provided to you by the OpenID
+ OPENID_CLIENT_ID The OpenID client ID which should be submitted
+ to the OpenID service when necessary.
+ This value is typically provided to you by the OpenID
service when OpenID credentials are generated for your application.
- OPENID_REDIRECT_URI The URI that should be submitted to the OpenID service such that
- they can redirect the authenticated user back to Guacamole after
- the authentication process is complete. This must be the full URL
+ OPENID_REDIRECT_URI The URI that should be submitted to the OpenID service such that
+ they can redirect the authenticated user back to Guacamole after
+ the authentication process is complete. This must be the full URL
that a user would enter into their browser to access Guacamole.
END
exit 1;
@@ -623,14 +623,14 @@
cat <<END
FATAL: Missing required environment variables
-------------------------------------------------------------------------------
-If using the Duo authentication extension, you must provide each of the
+If using the Duo authentication extension, you must provide each of the
following environment variables:
DUO_API_HOSTNAME The hostname of the Duo API endpoint.
DUO_INTEGRATION_KEY The integration key provided for Guacamole by Duo.
- DUO_SECRET_KEY The secret key provided for Guacamole by Duo.
+ DUO_SECRET_KEY The secret key provided for Guacamole by Duo.
DUO_APPLICATION_KEY An arbitrary, random key.
This value must be at least 40 characters.
@@ -840,8 +840,8 @@
-------------------------------------------------------------------------------
The Guacamole Docker container needs at least one authentication mechanism in
order to function, such as a MySQL database, PostgreSQL database, LDAP
-directory or RADIUS server. Please specify at least the MYSQL_DATABASE or
-POSTGRES_DATABASE environment variables, or check Guacamole's Docker
+directory or RADIUS server. Please specify at least the MYSQL_DATABASE or
+POSTGRES_DATABASE environment variables, or check Guacamole's Docker
documentation regarding configuring LDAP and/or custom extensions.
END
exit 1;
