Skip to content

Commit

Permalink
GUACAMOLE-1906: Merge Guacamole version bump to 1.5.5 in manual.
Browse files Browse the repository at this point in the history
  • Loading branch information
jmuehlner authored Mar 11, 2024
2 parents 0ee3811 + a1cc812 commit 0f65d46
Show file tree
Hide file tree
Showing 25 changed files with 77 additions and 77 deletions.
4 changes: 2 additions & 2 deletions src/adhoc-connections.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ release notes for that version. You can find the release notes for current
versions of Guacamole here: <http://guacamole.apache.org/releases/>.

The quickconnect extension is packaged as a `.tar.gz` file containing only the
extension itself, `guacamole-auth-quickconnect-1.5.4.jar`, which must
extension itself, `guacamole-auth-quickconnect-1.5.5.jar`, which must
ultimately be placed in `GUACAMOLE_HOME/extensions`.

(installing-quickconnect)=
Expand All @@ -62,7 +62,7 @@ To install the extension, you must:
1. Create the `GUACAMOLE_HOME/extensions` directory, if it does not already
exist.

2. Place the `guacamole-auth-quickconnect-1.5.4.jar` file in the
2. Place the `guacamole-auth-quickconnect-1.5.5.jar` file in the
`GUACAMOLE_HOME/extensions` directory.

(guac-quickconnect-config)=
Expand Down
4 changes: 2 additions & 2 deletions src/cas-auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Downloading the CAS authentication extension
```

The extension for the desired SSO method, in this case
`guacamole-auth-sso-cas-1.5.4.jar` from within the `cas/` subdirectory, must
`guacamole-auth-sso-cas-1.5.5.jar` from within the `cas/` subdirectory, must
ultimately be placed in `GUACAMOLE_HOME/extensions`.

(installing-cas-auth)=
Expand All @@ -35,7 +35,7 @@ To install the CAS authentication extension, you must:
1. Create the `GUACAMOLE_HOME/extensions` directory, if it does not already
exist.

2. Copy `guacamole-auth-sso-cas-1.5.4.jar` within `GUACAMOLE_HOME/extensions`.
2. Copy `guacamole-auth-sso-cas-1.5.5.jar` within `GUACAMOLE_HOME/extensions`.

3. Configure Guacamole to use CAS authentication, as described below.

Expand Down
2 changes: 1 addition & 1 deletion src/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
#

project = u'Apache Guacamole'
version = u'1.5.4'
version = u'1.5.5'

year = date.today().year
author = u'The Apache Software Foundation'
Expand Down
10 changes: 5 additions & 5 deletions src/configuring-guacamole.md
Original file line number Diff line number Diff line change
Expand Up @@ -175,10 +175,10 @@ that are always available for use:
```
...
23:32:06.467 [main] INFO o.a.g.extension.ExtensionModule - Multiple extensions are installed and will be loaded in order of decreasing priority:
23:32:06.468 [main] INFO o.a.g.extension.ExtensionModule - - [postgresql] "PostgreSQL Authentication" (/etc/guacamole/extensions/guacamole-auth-jdbc-postgresql-1.5.4.jar)
23:32:06.468 [main] INFO o.a.g.extension.ExtensionModule - - [ldap] "LDAP Authentication" (/etc/guacamole/extensions/guacamole-auth-ldap-1.5.4.jar)
23:32:06.468 [main] INFO o.a.g.extension.ExtensionModule - - [openid] "OpenID Authentication Extension" (/etc/guacamole/extensions/guacamole-auth-sso-openid-1.5.4.jar)
23:32:06.468 [main] INFO o.a.g.extension.ExtensionModule - - [saml] "SAML Authentication Extension" (/etc/guacamole/extensions/guacamole-auth-sso-saml-1.5.4.jar)
23:32:06.468 [main] INFO o.a.g.extension.ExtensionModule - - [postgresql] "PostgreSQL Authentication" (/etc/guacamole/extensions/guacamole-auth-jdbc-postgresql-1.5.5.jar)
23:32:06.468 [main] INFO o.a.g.extension.ExtensionModule - - [ldap] "LDAP Authentication" (/etc/guacamole/extensions/guacamole-auth-ldap-1.5.5.jar)
23:32:06.468 [main] INFO o.a.g.extension.ExtensionModule - - [openid] "OpenID Authentication Extension" (/etc/guacamole/extensions/guacamole-auth-sso-openid-1.5.5.jar)
23:32:06.468 [main] INFO o.a.g.extension.ExtensionModule - - [saml] "SAML Authentication Extension" (/etc/guacamole/extensions/guacamole-auth-sso-saml-1.5.5.jar)
23:32:06.468 [main] INFO o.a.g.extension.ExtensionModule - To change this order, set the "extension-priority" property or rename the extension files. The default priority of extensions is dictated by the sort order of their filenames.
...
```
Expand Down Expand Up @@ -2171,7 +2171,7 @@ the interpreted events:

```console
$ guaclog /path/to/recording/NAME
guaclog: INFO: Guacamole input log interpreter (guaclog) version 1.5.4
guaclog: INFO: Guacamole input log interpreter (guaclog) version 1.5.5
guaclog: INFO: 1 input file(s) provided.
guaclog: INFO: Writing input events from "/path/to/recording/NAME" to "/path/to/recording/NAME.txt" ...
guaclog: INFO: All files interpreted successfully.
Expand Down
12 changes: 6 additions & 6 deletions src/custom-auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ server logs.
<groupId>org.apache.guacamole</groupId>
<artifactId>guacamole-auth-tutorial</artifactId>
<packaging>jar</packaging>
<version>1.5.4</version>
<version>1.5.5</version>
<name>guacamole-auth-tutorial</name>

<properties>
Expand Down Expand Up @@ -97,7 +97,7 @@ server logs.
<dependency>
<groupId>org.apache.guacamole</groupId>
<artifactId>guacamole-ext</artifactId>
<version>1.5.4</version>
<version>1.5.5</version>
<scope>provided</scope>
</dependency>

Expand Down Expand Up @@ -185,7 +185,7 @@ pick it up during the build and include it within the `.jar`.
```json
{

"guacamoleVersion" : "1.5.4",
"guacamoleVersion" : "1.5.5",

"name" : "Tutorial Authentication Extension",
"namespace" : "guac-auth-tutorial",
Expand Down Expand Up @@ -213,7 +213,7 @@ all steps have been followed correctly so far:
$ mvn package
[INFO] Scanning for projects...
[INFO] ------------------------------------------------------------------------
[INFO] Building guacamole-auth-tutorial 1.5.4
[INFO] Building guacamole-auth-tutorial 1.5.5
[INFO] ------------------------------------------------------------------------
...
[INFO] ------------------------------------------------------------------------
Expand All @@ -227,7 +227,7 @@ $
```

Assuming you see the "`BUILD SUCCESS`" message when you build the extension,
there will be a new file, `target/guacamole-auth-tutorial-1.5.4.jar`, which can
there will be a new file, `target/guacamole-auth-tutorial-1.5.5.jar`, which can
be installed within Guacamole and tested. If you changed the name or version of
the project in the `pom.xml` file, the name of this new `.jar` file will be
different, but it can still be found within `target/`.
Expand Down Expand Up @@ -485,7 +485,7 @@ directory within the home directory of the user running Tomcat.
To install your extension, ensure that the required properties have been added
to your `guacamole.properties`, copy the
`target/guacamole-auth-tutorial-1.5.4.jar` file into
`target/guacamole-auth-tutorial-1.5.5.jar` file into
`GUACAMOLE_HOME/extensions` and restart Tomcat. Guacamole will automatically
load your extension, logging an informative message that it has done so:
Expand Down
4 changes: 2 additions & 2 deletions src/duo-auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ notes for current versions of Guacamole here:
http://guacamole.apache.org/releases/.

The Duo authentication extension is packaged as a `.tar.gz` file
containing only the extension itself, `guacamole-auth-duo-1.5.4.jar`,
containing only the extension itself, `guacamole-auth-duo-1.5.5.jar`,
which must ultimately be placed in `GUACAMOLE_HOME/extensions`.

(installing-duo-auth)=
Expand All @@ -65,7 +65,7 @@ authentication extension, you must:
1. Create the `GUACAMOLE_HOME/extensions` directory, if it does not already
exist.

2. Copy `guacamole-auth-duo-1.5.4.jar` within `GUACAMOLE_HOME/extensions`.
2. Copy `guacamole-auth-duo-1.5.5.jar` within `GUACAMOLE_HOME/extensions`.

3. Configure Guacamole to use Duo authentication, as described below.

Expand Down
12 changes: 6 additions & 6 deletions src/event-listeners.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ extension and pointing to our listener class.
<groupId>org.apache.guacamole</groupId>
<artifactId>guacamole-listener-tutorial</artifactId>
<packaging>jar</packaging>
<version>1.5.4</version>
<version>1.5.5</version>
<name>guacamole-listener-tutorial</name>

<properties>
Expand Down Expand Up @@ -86,7 +86,7 @@ extension and pointing to our listener class.
<dependency>
<groupId>org.apache.guacamole</groupId>
<artifactId>guacamole-ext</artifactId>
<version>1.5.4</version>
<version>1.5.5</version>
<scope>provided</scope>
</dependency>

Expand Down Expand Up @@ -163,7 +163,7 @@ pick it up during the build and include it within the `.jar`.
```json
{

"guacamoleVersion" : "1.5.4",
"guacamoleVersion" : "1.5.5",

"name" : "Tutorial Listener Extension",
"namespace" : "guac-listener-tutorial",
Expand All @@ -187,7 +187,7 @@ successfully even though it is just a skeleton at this point.
$ mvn package
[INFO] Scanning for projects...
[INFO] ---------------------------------------------------------------
[INFO] Building guacamole-listener-tutorial 1.5.4
[INFO] Building guacamole-listener-tutorial 1.5.5
[INFO] ---------------------------------------------------------------
...
[INFO] ---------------------------------------------------------------
Expand All @@ -201,7 +201,7 @@ $
```

Assuming you see the "`BUILD SUCCESS`" message when you build the extension,
there will be a new file, `target/guacamole-listener-tutorial-1.5.4.jar`, which
there will be a new file, `target/guacamole-listener-tutorial-1.5.5.jar`, which
can be installed within Guacamole (see [](custom-listener-installing) at the
end of this chapter). It should log event notifications that occur during, for
example, authentication attempts. If you changed the name or version of the
Expand Down Expand Up @@ -361,7 +361,7 @@ configuration files and extensions. Typically, this will be the `.guacamole`
directory within the home directory of the user running Tomcat.

To install your extension, copy the
`target/guacamole-listener-tutorial-1.5.4.jar` file into
`target/guacamole-listener-tutorial-1.5.5.jar` file into
`GUACAMOLE_HOME/extensions` and restart Tomcat. Guacamole will automatically
load your extension, logging an informative message that it has done so:

Expand Down
8 changes: 4 additions & 4 deletions src/guacamole-docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -1000,10 +1000,10 @@ priority can be overridden with the `EXTENSION_PRIORITY` environment variable.
```
...
23:32:06.467 [main] INFO o.a.g.extension.ExtensionModule - Multiple extensions are installed and will be loaded in order of decreasing priority:
23:32:06.468 [main] INFO o.a.g.extension.ExtensionModule - - [postgresql] "PostgreSQL Authentication" (/etc/guacamole/extensions/guacamole-auth-jdbc-postgresql-1.5.4.jar)
23:32:06.468 [main] INFO o.a.g.extension.ExtensionModule - - [ldap] "LDAP Authentication" (/etc/guacamole/extensions/guacamole-auth-ldap-1.5.4.jar)
23:32:06.468 [main] INFO o.a.g.extension.ExtensionModule - - [openid] "OpenID Authentication Extension" (/etc/guacamole/extensions/guacamole-auth-sso-openid-1.5.4.jar)
23:32:06.468 [main] INFO o.a.g.extension.ExtensionModule - - [saml] "SAML Authentication Extension" (/etc/guacamole/extensions/guacamole-auth-sso-saml-1.5.4.jar)
23:32:06.468 [main] INFO o.a.g.extension.ExtensionModule - - [postgresql] "PostgreSQL Authentication" (/etc/guacamole/extensions/guacamole-auth-jdbc-postgresql-1.5.5.jar)
23:32:06.468 [main] INFO o.a.g.extension.ExtensionModule - - [ldap] "LDAP Authentication" (/etc/guacamole/extensions/guacamole-auth-ldap-1.5.5.jar)
23:32:06.468 [main] INFO o.a.g.extension.ExtensionModule - - [openid] "OpenID Authentication Extension" (/etc/guacamole/extensions/guacamole-auth-sso-openid-1.5.5.jar)
23:32:06.468 [main] INFO o.a.g.extension.ExtensionModule - - [saml] "SAML Authentication Extension" (/etc/guacamole/extensions/guacamole-auth-sso-saml-1.5.5.jar)
23:32:06.468 [main] INFO o.a.g.extension.ExtensionModule - To change this order, set the "extension-priority" property or rename the extension files. The default priority of extensions is dictated by the sort order of their filenames.
...
```
Expand Down
4 changes: 2 additions & 2 deletions src/guacamole-ext.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ checks. The most minimal `guac-manifest.json` will look something like this:

```json
{
"guacamoleVersion" : "1.5.4",
"guacamoleVersion" : "1.5.5",
"name" : "My Extension",
"namespace" : "my-extension"
}
Expand All @@ -148,7 +148,7 @@ extension providing theming or branding would be more involved:
```json
{

"guacamoleVersion" : "1.5.4",
"guacamoleVersion" : "1.5.5",

"name" : "My Extension",
"namespace" : "my-extension",
Expand Down
4 changes: 2 additions & 2 deletions src/header-auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ release notes for that version. You can find the release notes for current
versions of Guacamole here: <http://guacamole.apache.org/releases/>.

The HTTP header authentication extension is packaged as a `.tar.gz` file
containing only the extension itself, `guacamole-auth-header-1.5.4.jar`, which
containing only the extension itself, `guacamole-auth-header-1.5.5.jar`, which
must ultimately be placed in `GUACAMOLE_HOME/extensions`.

(installing-header-auth)=
Expand All @@ -45,7 +45,7 @@ To install the HTTP header authentication extension, you must:
1. Create the `GUACAMOLE_HOME/extensions` directory, if it does not already
exist.

2. Copy `guacamole-auth-header-1.5.4.jar` within `GUACAMOLE_HOME/extensions`.
2. Copy `guacamole-auth-header-1.5.5.jar` within `GUACAMOLE_HOME/extensions`.

3. Configure Guacamole to use HTTP header authentication, as described below.

Expand Down
6 changes: 3 additions & 3 deletions src/include/sso-download.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ extension for each supported SSO method:

| SSO Method | Extension |
| ----------------------------- | -------------------------------------------- |
| [CAS](cas-auth) | `cas/guacamole-auth-sso-cas-1.5.4.jar` |
| [OpenID Connect](openid-auth) | `openid/guacamole-auth-sso-openid-1.5.4.jar` |
| [SAML](saml-auth) | `saml/guacamole-auth-sso-saml-1.5.4.jar` |
| [CAS](cas-auth) | `cas/guacamole-auth-sso-cas-1.5.5.jar` |
| [OpenID Connect](openid-auth) | `openid/guacamole-auth-sso-openid-1.5.5.jar` |
| [SAML](saml-auth) | `saml/guacamole-auth-sso-saml-1.5.5.jar` |

16 changes: 8 additions & 8 deletions src/installing-guacamole.md
Original file line number Diff line number Diff line change
Expand Up @@ -340,8 +340,8 @@ a `.tar.gz` archive which you can extract
from the command line:

```console
$ tar -xzf guacamole-server-1.5.4.tar.gz
$ cd guacamole-server-1.5.4/
$ tar -xzf guacamole-server-1.5.5.tar.gz
$ cd guacamole-server-1.5.5/
$
```

Expand Down Expand Up @@ -400,7 +400,7 @@ checking whether build environment is sane... yes
...

------------------------------------------------
guacamole-server version 1.5.4
guacamole-server version 1.5.5
------------------------------------------------

Library status:
Expand Down Expand Up @@ -581,8 +581,8 @@ consumption. Source downloaded from the project web site will take the form of
a `.tar.gz` archive which you can extract from the command line:

```console
$ tar -xzf guacamole-client-1.5.4.tar.gz
$ cd guacamole-client-1.5.4/
$ tar -xzf guacamole-client-1.5.5.tar.gz
$ cd guacamole-client-1.5.5/
$
```

Expand Down Expand Up @@ -649,7 +649,7 @@ $ mvn package
[INFO] guacamole-playback-example [war]
...
[INFO] ------------------------------------------------------------------------
[INFO] Reactor Summary for guacamole-client 1.5.4:
[INFO] Reactor Summary for guacamole-client 1.5.5:
[INFO]
[INFO] guacamole-client ................................... SUCCESS [ 11.879 s]
[INFO] guacamole-common ................................... SUCCESS [ 15.140 s]
Expand Down Expand Up @@ -721,7 +721,7 @@ from the name of the `.war` file, you will likely want to rename this to simply
`guacamole.war` while copying:

```console
# cp guacamole/target/guacamole-1.5.4.war /var/lib/tomcat/webapps/guacamole.war
# cp guacamole/target/guacamole-1.5.5.war /var/lib/tomcat/webapps/guacamole.war
#
```

Expand All @@ -742,7 +742,7 @@ Stopping Tomcat... OK
Starting Tomcat... OK
# /etc/init.d/guacd start
Starting guacd: SUCCESS
guacd[6229]: INFO: Guacamole proxy daemon (guacd) version 1.5.4 started
guacd[6229]: INFO: Guacamole proxy daemon (guacd) version 1.5.5 started
#
```

Expand Down
12 changes: 6 additions & 6 deletions src/jdbc-auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ driver must be downloaded separately from the database vendor and placed within
:::{list-table}
:stub-columns: 1
* - Guacamole extension
- `mysql/guacamole-auth-jdbc-mysql-1.5.4.jar`
- `mysql/guacamole-auth-jdbc-mysql-1.5.5.jar`
* - SQL schema scripts
- `mysql/schema/`
* - JDBC driver
Expand All @@ -79,7 +79,7 @@ If using the JDBC driver from MySQL, the required `.jar` will be within a
:::{list-table}
:stub-columns: 1
* - Guacamole extension
- `postgresql/guacamole-auth-jdbc-postgresql-1.5.4.jar`
- `postgresql/guacamole-auth-jdbc-postgresql-1.5.5.jar`
* - SQL schema scripts
- `postgresql/schema/`
* - JDBC driver
Expand All @@ -91,7 +91,7 @@ If using the JDBC driver from MySQL, the required `.jar` will be within a
:::{list-table}
:stub-columns: 1
* - Guacamole extension
- `sqlserver/guacamole-auth-jdbc-sqlserver-1.5.4.jar`
- `sqlserver/guacamole-auth-jdbc-sqlserver-1.5.5.jar`
* - SQL schema scripts
- `sqlserver/schema/`
* - JDBC driver
Expand Down Expand Up @@ -340,9 +340,9 @@ authentication extension, you must:
1. Create the `GUACAMOLE_HOME/extensions` and `GUACAMOLE_HOME/lib` directories,
if they do not already exist.

2. Copy `guacamole-auth-jdbc-mysql-1.5.4.jar` *or*
`guacamole-auth-jdbc-postgresql-1.5.4.jar` *or*
`guacamole-auth-jdbc-sqlserver-1.5.4.jar` within
2. Copy `guacamole-auth-jdbc-mysql-1.5.5.jar` *or*
`guacamole-auth-jdbc-postgresql-1.5.5.jar` *or*
`guacamole-auth-jdbc-sqlserver-1.5.5.jar` within
`GUACAMOLE_HOME/extensions`, depending on whether you are using
MySQL/MariaDB, PostgreSQL, or SQL Server.

Expand Down
4 changes: 2 additions & 2 deletions src/json-auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ release notes for that version. You can find the release notes for current
versions of Guacamole here: <http://guacamole.apache.org/releases/>.

The JSON authentication extension is packaged as a `.tar.gz` file containing
only the extension itself, `guacamole-auth-json-1.5.4.jar`, which must
only the extension itself, `guacamole-auth-json-1.5.5.jar`, which must
ultimately be placed in `GUACAMOLE_HOME/extensions`.

(installing-json-auth)=
Expand All @@ -38,7 +38,7 @@ To install the JSON authentication extension, you must:
1. Create the `GUACAMOLE_HOME/extensions` directory, if it does not already
exist.

2. Copy `guacamole-auth-json-1.5.4.jar` within `GUACAMOLE_HOME/extensions`.
2. Copy `guacamole-auth-json-1.5.5.jar` within `GUACAMOLE_HOME/extensions`.

3. Configure Guacamole to use JSON authentication, as described below.

Expand Down
4 changes: 2 additions & 2 deletions src/ldap-auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ versions of Guacamole here: <http://guacamole.apache.org/releases/>.

The LDAP authentication extension is packaged as a `.tar.gz` file containing:

`guacamole-auth-ldap-1.5.4.jar`
`guacamole-auth-ldap-1.5.5.jar`
: The Guacamole LDAP support extension itself, which must be placed in
`GUACAMOLE_HOME/extensions`.

Expand Down Expand Up @@ -209,7 +209,7 @@ extension, you must:
1. Create the `GUACAMOLE_HOME/extensions` directory, if it does not already
exist.

2. Copy `guacamole-auth-ldap-1.5.4.jar` within `GUACAMOLE_HOME/extensions`.
2. Copy `guacamole-auth-ldap-1.5.5.jar` within `GUACAMOLE_HOME/extensions`.

3. Configure Guacamole to use LDAP authentication, as described below.

Expand Down
Loading

0 comments on commit 0f65d46

Please sign in to comment.