You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@guacamole.apache.org by vn...@apache.org on 2018/09/28 20:52:27 UTC
[1/3] guacamole-manual git commit: GUACAMOLE-464: document
enable-environment-properties configuration property
Repository: guacamole-manual
Updated Branches:
refs/heads/master 37be4cc7e -> aa503620e
GUACAMOLE-464: document enable-environment-properties configuration property
Project: http://git-wip-us.apache.org/repos/asf/guacamole-manual/repo
Commit: http://git-wip-us.apache.org/repos/asf/guacamole-manual/commit/998f9d63
Tree: http://git-wip-us.apache.org/repos/asf/guacamole-manual/tree/998f9d63
Diff: http://git-wip-us.apache.org/repos/asf/guacamole-manual/diff/998f9d63
Branch: refs/heads/master
Commit: 998f9d6303b3815ad06c4cf0c63eb75d1a4050bd
Parents: c36251e
Author: Carl Harris <ce...@vt.edu>
Authored: Tue Jan 16 16:47:49 2018 -0500
Committer: Carl Harris <ce...@vt.edu>
Committed: Fri Sep 28 10:14:43 2018 -0400
----------------------------------------------------------------------
src/chapters/configuring.xml | 22 ++++++++++++++++++++++
src/chapters/docker.xml | 12 ++++++++++++
2 files changed, 34 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/guacamole-manual/blob/998f9d63/src/chapters/configuring.xml
----------------------------------------------------------------------
diff --git a/src/chapters/configuring.xml b/src/chapters/configuring.xml
index e8104f7..4d930e3 100644
--- a/src/chapters/configuring.xml
+++ b/src/chapters/configuring.xml
@@ -161,6 +161,28 @@
</varlistentry>
<varlistentry>
<term><indexterm xmlns:xl="http://www.w3.org/1999/xlink">
+ <primary>enable-environment-properties</primary>
+ </indexterm><parameter>enable-environment-properties</parameter></term>
+ <listitem>
+ <para>If set to "true", Guacamole will first evaluate its environment to obtain
+ the value for any given configuration property, before using a value specified
+ in <filename>guacamole.properties</filename> or falling back to a default
+ value. By enabling this option, you can easily override any other configuration
+ property using an environment variable.</para>
+ <informalexample>
+ <programlisting>enable-environment-properties: true</programlisting>
+ </informalexample>
+ <para>When searching for a configuration property in the environment, the name of
+ the property is first transformed by converting all lower case characters to
+ their upper case equivalents, and by replacing all hyphen characters (<code>-</code>) with
+ underscore characters (<code>_</code>). For example, the
+ <parameter>guacd-hostname</parameter> property would be transformed to
+ <parameter>GUACD_HOSTNAME</parameter> when searching the environment.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><indexterm xmlns:xl="http://www.w3.org/1999/xlink">
<primary>guacd-hostname</primary>
</indexterm><parameter>guacd-hostname</parameter></term>
<listitem>
http://git-wip-us.apache.org/repos/asf/guacamole-manual/blob/998f9d63/src/chapters/docker.xml
----------------------------------------------------------------------
diff --git a/src/chapters/docker.xml b/src/chapters/docker.xml
index c58cee8..d63ceb7 100644
--- a/src/chapters/docker.xml
+++ b/src/chapters/docker.xml
@@ -106,6 +106,18 @@
<uri>http://<replaceable>HOSTNAME</replaceable>:8080/guacamole/</uri>, where
<replaceable>HOSTNAME</replaceable> is the hostname or address of the machine
hosting Docker.</para>
+ <section xml:id="guacamole-docker-config-via-env">
+ <title>Configuring Guacamole when using Docker</title>
+ <para>When running Guacamole using Docker, the traditional approach to configuring
+ Guacamole by editing <filename>guacamole.properties</filename> is less
+ convenient. When using Docker, you may wish to make use of the
+ <parameter>enable-environment-properties</parameter> configuration
+ property, which allows you to specify values for arbitrary Guacamole
+ configuration properties using environment variables. This is covered in
+ <xref xmlns:xlink="http://www.w3.org/1999/xlink"
+ linkend="configuring-guacamole"/>.
+ </para>
+ </section>
<section xml:id="guacamole-docker-guacd">
<title>Connecting Guacamole to <package>guacd</package></title>
<para>The Guacamole Docker image needs to be able to connect to <package>guacd</package>
[3/3] guacamole-manual git commit: Merge 1.0.0 changes back to master.
Posted by vn...@apache.org.
Merge 1.0.0 changes back to master.
Project: http://git-wip-us.apache.org/repos/asf/guacamole-manual/repo
Commit: http://git-wip-us.apache.org/repos/asf/guacamole-manual/commit/aa503620
Tree: http://git-wip-us.apache.org/repos/asf/guacamole-manual/tree/aa503620
Diff: http://git-wip-us.apache.org/repos/asf/guacamole-manual/diff/aa503620
Branch: refs/heads/master
Commit: aa503620e13b7cda8aaa46673b6fd4c8c5d3c692
Parents: 37be4cc 7083723
Author: Nick Couchman <vn...@apache.org>
Authored: Fri Sep 28 16:51:39 2018 -0400
Committer: Nick Couchman <vn...@apache.org>
Committed: Fri Sep 28 16:51:39 2018 -0400
----------------------------------------------------------------------
src/chapters/configuring.xml | 22 ++++++++++++++++++++++
src/chapters/docker.xml | 12 ++++++++++++
2 files changed, 34 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/guacamole-manual/blob/aa503620/src/chapters/configuring.xml
----------------------------------------------------------------------
[2/3] guacamole-manual git commit: GUACAMOLE-464: Merge document
enable-environment-properties
Posted by vn...@apache.org.
GUACAMOLE-464: Merge document enable-environment-properties
Project: http://git-wip-us.apache.org/repos/asf/guacamole-manual/repo
Commit: http://git-wip-us.apache.org/repos/asf/guacamole-manual/commit/70837238
Tree: http://git-wip-us.apache.org/repos/asf/guacamole-manual/tree/70837238
Diff: http://git-wip-us.apache.org/repos/asf/guacamole-manual/diff/70837238
Branch: refs/heads/master
Commit: 708372381b07d8a47b34bc3c1628ccfcfe9bef54
Parents: 563a0e6 998f9d6
Author: Nick Couchman <vn...@apache.org>
Authored: Fri Sep 28 16:49:31 2018 -0400
Committer: Nick Couchman <vn...@apache.org>
Committed: Fri Sep 28 16:49:31 2018 -0400
----------------------------------------------------------------------
src/chapters/configuring.xml | 22 ++++++++++++++++++++++
src/chapters/docker.xml | 12 ++++++++++++
2 files changed, 34 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/guacamole-manual/blob/70837238/src/chapters/configuring.xml
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/guacamole-manual/blob/70837238/src/chapters/docker.xml
----------------------------------------------------------------------