GUACAMOLE-2064: Document database terminal protocols#299
Open
4m1nr wants to merge 1 commit into
Open
Conversation
Document the new MySQL, PostgreSQL, SQL Server, MongoDB, and Oracle terminal protocols provided by guacamole-server. Add a "Database terminals" section to the connection configuration chapter describing the interactive shell (line editing, history, and per-dialect statement terminators), the parameters common to all database protocols, and the parameters, capabilities, and caveats specific to each database. List the required client libraries among the build dependencies, note that Oracle support requires the Oracle Instant Client and is not built by default, and record which database protocols the guacd Docker image includes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What this does
Documents the five new database terminal protocols (MySQL, PostgreSQL, SQL
Server, MongoDB, Oracle) added to guacamole-server for
GUACAMOLE-2064.
Changes
configuring-guacamole.md.j2— a new "Database terminals" section (afterTelnet) covering:
and support all of Guacamole's session-logging features;
terminators (
;, T-SQLGO, Oracle PL/SQL/, and JSON documents forMongoDB);
caveats (TLS options,
tds-version, MongoDB's JSON command shell withexamples and
\use/\show, Oracle's requiredservice-name, and thecancellation behavior of each).
guacamole-native.md.j2— adds MariaDB Connector/C, libpq, FreeTDS, theMongoDB C Driver, and the Oracle Instant Client SDK to the optional build
dependencies (with Debian/Ubuntu and Fedora/RHEL package names), notes that
Oracle is not built by default and is enabled with
--with-oracle, andupdates the sample
configuresummary output.guacamole-docker.md— records that the guacd image includes the fourredistributable database protocols and describes the custom-image approach for
Oracle.
Testing
make(Sphinx build) completes with no warnings; the rendered HTMLcontains the new "Database terminals" section and the new dependency entries.
Related PRs
Part of a three-repo change under GUACAMOLE-2064: