You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@guacamole.apache.org by "aleitner (via GitHub)" <gi...@apache.org> on 2023/04/12 19:49:00 UTC
[GitHub] [guacamole-manual] aleitner opened a new pull request, #203: Restructured dbc related parameter descriptions and wording.
aleitner opened a new pull request, #203:
URL: https://github.com/apache/guacamole-manual/pull/203
* Cleaned up wording to be more concise and clear. Fixed typos or syntax issues.
TODO: Missing Guacamole number as that hasn't been created yet
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@guacamole.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [guacamole-manual] jmuehlner commented on a diff in pull request #203: GUACAMOLE-XXXX: Restructured dbc related parameter descriptions and wording.
Posted by "jmuehlner (via GitHub)" <gi...@apache.org>.
jmuehlner commented on code in PR #203:
URL: https://github.com/apache/guacamole-manual/pull/203#discussion_r1164691066
##########
src/jdbc-auth.md:
##########
@@ -1435,59 +1405,49 @@ descriptive name with the protocol to be used for the connection. It contains
the following columns:
`connection_id`
-: The unique integer associated with each connection. This value is
- generated automatically when a new entry is inserted into the
- `guacamole_connection` table.
+: A unique integer for each connection, generated automatically upon creating a
+ new entry in the `guacamole_connection` table.
`connection_name`
-: The unique name associated with each connection. This value must be
- specified manually, and must be different from any existing connection
- name in the same connection group. References to connections in other
- tables use the value from `connection_id`, not `connection_name`.
+: A unique name for each connection. This value must be manually specified and
+ unique within the same connection group. Other tables reference connections
+ using `connection_id`, not `connection_name`.
`protocol`
-: The protocol to use with this connection. This is the name of the protocol
- that should be sent to guacd when connecting, for example "`vnc`" or
- "`rdp`".
+: The protocol for the connection (e.g., "`vnc`" or "`rdp`").
`parent_id`
: The unique integer associated with the connection group containing this
connection, or `NULL` if this connection is within the root group.
`max_connections`
-: The maximum number of concurrent connections to allow to this connection
- at any one time *regardless of user*. `NULL` will use the default value
- specified in `guacamole.properties` and a value of `0` denotes unlimited.
+: The maximum concurrent connections allowed to this connection. `NULL` uses the
+ default value from `guacamole.properties`, and `0` denotes unlimited.
`max_connections_per_user`
-: The maximum number of concurrent connections to allow to this connection
- at any one time *from a single user*. `NULL` will use the default value
- specified in `guacamole.properties` and a value of `0` denotes unlimited.
+: The maximum concurrent connections allowed per user. `NULL` uses the default
Review Comment:
It's probably still worth being clear that the limit is for _this connection_ somewhere. It's unlikely that anyone's going to get confused about it, but still.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@guacamole.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [guacamole-manual] jmuehlner commented on a diff in pull request #203: GUACAMOLE-XXXX: Restructured dbc related parameter descriptions and wording.
Posted by "jmuehlner (via GitHub)" <gi...@apache.org>.
jmuehlner commented on code in PR #203:
URL: https://github.com/apache/guacamole-manual/pull/203#discussion_r1164681268
##########
src/jdbc-auth.md:
##########
@@ -1435,59 +1405,49 @@ descriptive name with the protocol to be used for the connection. It contains
the following columns:
`connection_id`
-: The unique integer associated with each connection. This value is
- generated automatically when a new entry is inserted into the
- `guacamole_connection` table.
+: A unique integer for each connection, generated automatically upon creating a
+ new entry in the `guacamole_connection` table.
`connection_name`
-: The unique name associated with each connection. This value must be
- specified manually, and must be different from any existing connection
- name in the same connection group. References to connections in other
- tables use the value from `connection_id`, not `connection_name`.
+: A unique name for each connection. This value must be manually specified and
+ unique within the same connection group. Other tables reference connections
+ using `connection_id`, not `connection_name`.
`protocol`
-: The protocol to use with this connection. This is the name of the protocol
- that should be sent to guacd when connecting, for example "`vnc`" or
- "`rdp`".
+: The protocol for the connection (e.g., "`vnc`" or "`rdp`").
`parent_id`
: The unique integer associated with the connection group containing this
connection, or `NULL` if this connection is within the root group.
`max_connections`
-: The maximum number of concurrent connections to allow to this connection
- at any one time *regardless of user*. `NULL` will use the default value
- specified in `guacamole.properties` and a value of `0` denotes unlimited.
+: The maximum concurrent connections allowed to this connection. `NULL` uses the
+ default value from `guacamole.properties`, and `0` denotes unlimited.
`max_connections_per_user`
-: The maximum number of concurrent connections to allow to this connection
- at any one time *from a single user*. `NULL` will use the default value
- specified in `guacamole.properties` and a value of `0` denotes unlimited.
+: The maximum concurrent connections allowed per user. `NULL` uses the default
+ value from `guacamole.properties`, and `0` denotes unlimited.
`proxy_hostname`
-: The hostname or IP address of the Guacamole proxy daemon (guacd) which
- should be used for this connection. If `NULL`, the value defined with the
- `guacd-hostname` property in `guacamole.properties` will be used.
+: The hostname or IP address of the Guacamole proxy daemon (guacd) for this
+ connection. If `NULL`, the `guacd-hostname` property in
+ `guacamole.properties` will be used.
`proxy_port`
-: The TCP port number of the Guacamole proxy daemon (guacd) which should be
- used for this connection. If `NULL`, the value defined with the
- `guacd-port` property in `guacamole.properties` will be used.
+: The TCP port number of the Guacamole proxy daemon (guacd) for this connection.
+ If `NULL`, the `guacd-port` property in `guacamole.properties` will be used.
`proxy_encryption_method`
-: The encryption method which should be used when communicating with the
- Guacamole proxy daemon (guacd) for this connection. This can be either
- `NONE`, for no encryption, or `SSL`, for SSL/TLS. If `NULL`, the
- encryption method will be dictated by the `guacd-ssl` property in
- `guacamole.properties`.
+: The encryption method for communicating with the Guacamole proxy daemon
+ (guacd): `NONE` for no encryption or `SSL` for SSL/TLS. If `NULL`, the
+ `guacd-ssl` property in `guacamole.properties` will be used.
`connection_weight`
-: The weight for a connection, used for applying weighted load balancing
- algorithms when connections are part of a `BALANCING` group. This is an
- integer value, where values `1` or greater will weight the connection
- relative to other connections in that group, and values below `1` cause
- the connection to be disabled in the group. If `NULL`, the connection will
- be assigned a default weight of `1`.
+: The weight for a connection within a `BALANCING` group, used for weighted load
+ balancing algorithms. A value of `1` or greater will weight the connection
+ relative to other connections in that group, and values below `1` cause the
+ connection to be disabled in the group.If `NULL`, the connection will have a
Review Comment:
Missing a space between sentences here : `group.If`
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@guacamole.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [guacamole-manual] jmuehlner commented on a diff in pull request #203: GUACAMOLE-XXXX: Restructured dbc related parameter descriptions and wording.
Posted by "jmuehlner (via GitHub)" <gi...@apache.org>.
jmuehlner commented on code in PR #203:
URL: https://github.com/apache/guacamole-manual/pull/203#discussion_r1164683287
##########
src/jdbc-auth.md:
##########
@@ -1435,59 +1405,49 @@ descriptive name with the protocol to be used for the connection. It contains
the following columns:
`connection_id`
-: The unique integer associated with each connection. This value is
- generated automatically when a new entry is inserted into the
- `guacamole_connection` table.
+: A unique integer for each connection, generated automatically upon creating a
+ new entry in the `guacamole_connection` table.
`connection_name`
-: The unique name associated with each connection. This value must be
- specified manually, and must be different from any existing connection
- name in the same connection group. References to connections in other
- tables use the value from `connection_id`, not `connection_name`.
+: A unique name for each connection. This value must be manually specified and
+ unique within the same connection group. Other tables reference connections
+ using `connection_id`, not `connection_name`.
`protocol`
-: The protocol to use with this connection. This is the name of the protocol
- that should be sent to guacd when connecting, for example "`vnc`" or
- "`rdp`".
+: The protocol for the connection (e.g., "`vnc`" or "`rdp`").
`parent_id`
: The unique integer associated with the connection group containing this
connection, or `NULL` if this connection is within the root group.
`max_connections`
-: The maximum number of concurrent connections to allow to this connection
- at any one time *regardless of user*. `NULL` will use the default value
- specified in `guacamole.properties` and a value of `0` denotes unlimited.
+: The maximum concurrent connections allowed to this connection. `NULL` uses the
+ default value from `guacamole.properties`, and `0` denotes unlimited.
`max_connections_per_user`
-: The maximum number of concurrent connections to allow to this connection
- at any one time *from a single user*. `NULL` will use the default value
- specified in `guacamole.properties` and a value of `0` denotes unlimited.
+: The maximum concurrent connections allowed per user. `NULL` uses the default
+ value from `guacamole.properties`, and `0` denotes unlimited.
`proxy_hostname`
-: The hostname or IP address of the Guacamole proxy daemon (guacd) which
- should be used for this connection. If `NULL`, the value defined with the
- `guacd-hostname` property in `guacamole.properties` will be used.
+: The hostname or IP address of the Guacamole proxy daemon (guacd) for this
+ connection. If `NULL`, the `guacd-hostname` property in
+ `guacamole.properties` will be used.
`proxy_port`
-: The TCP port number of the Guacamole proxy daemon (guacd) which should be
- used for this connection. If `NULL`, the value defined with the
- `guacd-port` property in `guacamole.properties` will be used.
+: The TCP port number of the Guacamole proxy daemon (guacd) for this connection.
+ If `NULL`, the `guacd-port` property in `guacamole.properties` will be used.
`proxy_encryption_method`
-: The encryption method which should be used when communicating with the
- Guacamole proxy daemon (guacd) for this connection. This can be either
- `NONE`, for no encryption, or `SSL`, for SSL/TLS. If `NULL`, the
- encryption method will be dictated by the `guacd-ssl` property in
- `guacamole.properties`.
+: The encryption method for communicating with the Guacamole proxy daemon
+ (guacd): `NONE` for no encryption or `SSL` for SSL/TLS. If `NULL`, the
+ `guacd-ssl` property in `guacamole.properties` will be used.
`connection_weight`
-: The weight for a connection, used for applying weighted load balancing
- algorithms when connections are part of a `BALANCING` group. This is an
- integer value, where values `1` or greater will weight the connection
Review Comment:
That this should be an integer seems relevant and probably shouldn't be cut from the docs.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@guacamole.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [guacamole-manual] jmuehlner commented on a diff in pull request #203: GUACAMOLE-XXXX: Restructured dbc related parameter descriptions and wording.
Posted by "jmuehlner (via GitHub)" <gi...@apache.org>.
jmuehlner commented on code in PR #203:
URL: https://github.com/apache/guacamole-manual/pull/203#discussion_r1164695383
##########
src/jdbc-auth.md:
##########
@@ -1435,59 +1405,49 @@ descriptive name with the protocol to be used for the connection. It contains
the following columns:
`connection_id`
-: The unique integer associated with each connection. This value is
- generated automatically when a new entry is inserted into the
- `guacamole_connection` table.
+: A unique integer for each connection, generated automatically upon creating a
+ new entry in the `guacamole_connection` table.
`connection_name`
-: The unique name associated with each connection. This value must be
- specified manually, and must be different from any existing connection
- name in the same connection group. References to connections in other
- tables use the value from `connection_id`, not `connection_name`.
+: A unique name for each connection. This value must be manually specified and
+ unique within the same connection group. Other tables reference connections
Review Comment:
What is this connection group the same as now? With these edits, this sentence doesn't make sense to me anymore.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@guacamole.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [guacamole-manual] jmuehlner commented on a diff in pull request #203: GUACAMOLE-XXXX: Restructured dbc related parameter descriptions and wording.
Posted by "jmuehlner (via GitHub)" <gi...@apache.org>.
jmuehlner commented on code in PR #203:
URL: https://github.com/apache/guacamole-manual/pull/203#discussion_r1164701254
##########
src/jdbc-auth.md:
##########
@@ -1383,35 +1358,30 @@ corresponding entry in the `guacamole_user_group` and
[`guacamole_entity`](jdbc-auth-schema-entities) tables. Each user group has a
corresponding unique name specified via `guacamole_entity`.
-If deleting a user group, the [corresponding entity](jdbc-auth-schema-entities)
-should also be deleted. As any user group which points to the entity will be
-deleted automatically when the entity is deleted through cascading deletion,
-*it is advisable to use the entity as the basis for any delete operation*.
+When deleting a user group, it is important to also delete the
+[corresponding entity](jdbc-auth-schema-entities). Due to cascading deletion,
+the related user group records will be automatically deleted when the entity
+is removed.
Review Comment:
This comment now implies it, but I still think it's worth keeping the explicit recommendation to delete the associated entity as opposed to this record.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@guacamole.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [guacamole-manual] jmuehlner commented on a diff in pull request #203: GUACAMOLE-XXXX: Restructured dbc related parameter descriptions and wording.
Posted by "jmuehlner (via GitHub)" <gi...@apache.org>.
jmuehlner commented on code in PR #203:
URL: https://github.com/apache/guacamole-manual/pull/203#discussion_r1164690271
##########
src/jdbc-auth.md:
##########
@@ -1435,59 +1405,49 @@ descriptive name with the protocol to be used for the connection. It contains
the following columns:
`connection_id`
-: The unique integer associated with each connection. This value is
- generated automatically when a new entry is inserted into the
- `guacamole_connection` table.
+: A unique integer for each connection, generated automatically upon creating a
+ new entry in the `guacamole_connection` table.
`connection_name`
-: The unique name associated with each connection. This value must be
- specified manually, and must be different from any existing connection
- name in the same connection group. References to connections in other
- tables use the value from `connection_id`, not `connection_name`.
+: A unique name for each connection. This value must be manually specified and
+ unique within the same connection group. Other tables reference connections
+ using `connection_id`, not `connection_name`.
`protocol`
-: The protocol to use with this connection. This is the name of the protocol
- that should be sent to guacd when connecting, for example "`vnc`" or
- "`rdp`".
+: The protocol for the connection (e.g., "`vnc`" or "`rdp`").
`parent_id`
: The unique integer associated with the connection group containing this
connection, or `NULL` if this connection is within the root group.
`max_connections`
-: The maximum number of concurrent connections to allow to this connection
- at any one time *regardless of user*. `NULL` will use the default value
- specified in `guacamole.properties` and a value of `0` denotes unlimited.
+: The maximum concurrent connections allowed to this connection. `NULL` uses the
+ default value from `guacamole.properties`, and `0` denotes unlimited.
`max_connections_per_user`
-: The maximum number of concurrent connections to allow to this connection
- at any one time *from a single user*. `NULL` will use the default value
- specified in `guacamole.properties` and a value of `0` denotes unlimited.
+: The maximum concurrent connections allowed per user. `NULL` uses the default
+ value from `guacamole.properties`, and `0` denotes unlimited.
`proxy_hostname`
-: The hostname or IP address of the Guacamole proxy daemon (guacd) which
- should be used for this connection. If `NULL`, the value defined with the
- `guacd-hostname` property in `guacamole.properties` will be used.
+: The hostname or IP address of the Guacamole proxy daemon (guacd) for this
+ connection. If `NULL`, the `guacd-hostname` property in
+ `guacamole.properties` will be used.
`proxy_port`
-: The TCP port number of the Guacamole proxy daemon (guacd) which should be
- used for this connection. If `NULL`, the value defined with the
- `guacd-port` property in `guacamole.properties` will be used.
+: The TCP port number of the Guacamole proxy daemon (guacd) for this connection.
Review Comment:
I do like shortening and concising these descriptions, but to be pedantic, these descriptions are not quite correct anymore.
It really is the _value_ of the property that will be used here, not the property itself. Consider rephrasing to be clear about that. I'd be fine with "property value" or instead of "property" here, though it does give it a real estatey vibe...
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@guacamole.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [guacamole-manual] jmuehlner commented on a diff in pull request #203: GUACAMOLE-XXXX: Restructured dbc related parameter descriptions and wording.
Posted by "jmuehlner (via GitHub)" <gi...@apache.org>.
jmuehlner commented on code in PR #203:
URL: https://github.com/apache/guacamole-manual/pull/203#discussion_r1164690271
##########
src/jdbc-auth.md:
##########
@@ -1435,59 +1405,49 @@ descriptive name with the protocol to be used for the connection. It contains
the following columns:
`connection_id`
-: The unique integer associated with each connection. This value is
- generated automatically when a new entry is inserted into the
- `guacamole_connection` table.
+: A unique integer for each connection, generated automatically upon creating a
+ new entry in the `guacamole_connection` table.
`connection_name`
-: The unique name associated with each connection. This value must be
- specified manually, and must be different from any existing connection
- name in the same connection group. References to connections in other
- tables use the value from `connection_id`, not `connection_name`.
+: A unique name for each connection. This value must be manually specified and
+ unique within the same connection group. Other tables reference connections
+ using `connection_id`, not `connection_name`.
`protocol`
-: The protocol to use with this connection. This is the name of the protocol
- that should be sent to guacd when connecting, for example "`vnc`" or
- "`rdp`".
+: The protocol for the connection (e.g., "`vnc`" or "`rdp`").
`parent_id`
: The unique integer associated with the connection group containing this
connection, or `NULL` if this connection is within the root group.
`max_connections`
-: The maximum number of concurrent connections to allow to this connection
- at any one time *regardless of user*. `NULL` will use the default value
- specified in `guacamole.properties` and a value of `0` denotes unlimited.
+: The maximum concurrent connections allowed to this connection. `NULL` uses the
+ default value from `guacamole.properties`, and `0` denotes unlimited.
`max_connections_per_user`
-: The maximum number of concurrent connections to allow to this connection
- at any one time *from a single user*. `NULL` will use the default value
- specified in `guacamole.properties` and a value of `0` denotes unlimited.
+: The maximum concurrent connections allowed per user. `NULL` uses the default
+ value from `guacamole.properties`, and `0` denotes unlimited.
`proxy_hostname`
-: The hostname or IP address of the Guacamole proxy daemon (guacd) which
- should be used for this connection. If `NULL`, the value defined with the
- `guacd-hostname` property in `guacamole.properties` will be used.
+: The hostname or IP address of the Guacamole proxy daemon (guacd) for this
+ connection. If `NULL`, the `guacd-hostname` property in
+ `guacamole.properties` will be used.
`proxy_port`
-: The TCP port number of the Guacamole proxy daemon (guacd) which should be
- used for this connection. If `NULL`, the value defined with the
- `guacd-port` property in `guacamole.properties` will be used.
+: The TCP port number of the Guacamole proxy daemon (guacd) for this connection.
Review Comment:
I do like shortening and concising these descriptions, but to be pedantic, these descriptions are not quite correct anymore.
It really is the _value_ of the property that will be used here, not the property itself. Consider rephrasing to be clear about that. I'd be fine with "property value" instead of "property" here, though it does give it a real estatey vibe...
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@guacamole.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org