README update to document -pw changes

This commit is contained in:
F. Duncanh
2025-08-06 09:23:35 -04:00
parent 2b0da9125a
commit 2436081088
3 changed files with 48 additions and 24 deletions

View File

@@ -1069,16 +1069,23 @@ options -restrict, -block, -allow for more ways to control client
access). <em>(Add a line “reg” in the startup file if you wish to use
this feature.)</em></p>
<p><strong>-pw</strong> [<em>pwd</em>]. (since 1.72). As an alternative
to -pin, client access can be controlled with a password set when uxplay
starts (set it in the .uxplay startup file, where it is stored as
cleartext.) All users must then know this password. This uses HTTP md5
Digest authentication, which is now regarded as providing weak security,
but it is only used to validate the uxplay password, and no user
credentials are exposed. If <em>pwd</em> is <strong>not</strong>
specified, a random 4-digit pin code is displayed, and must be entered
on the client at <strong>each</strong> new connection. <em>Note: -pin
and -pw are alternatives: if both are specified at startup, the earlier
of these two options is discarded.</em></p>
to -pin, client access can be controlled with a password. If a password
<em>pwd</em> (of length at least six characters) is set when uxplay
starts (usually set in the startup file, where it is stored as
cleartext), all users must know this password to connect to UxPlay (the
client prompts for it). This method uses HTTP md5 Digest authentication,
which is now regarded as providing weak security, but it is only used to
validate the uxplay password, and no user credentials are exposed. After
a successful authentication, the client stores the password, and will
use it initially for future authentications without prompting, so long
as the UxPlay deviceID has not changed (this initial authentication will
fail if the UxPlay password has changed). If <em>pwd</em> is
<strong>not</strong> specified with the -pw option when UxPlay starts, a
new random 4-digit pin code is generated and displayed on the UxPlay
terminal for <strong>each</strong> new connection, and must be entered
on the client (there are three chances to enter it, before it is
changed). <em>Note: -pin and -pw are alternatives: if both are specified
at startup, the earlier of these two options is discarded.</em></p>
<p><strong>-vsync [x]</strong> (In Mirror mode:) this option
(<strong>now the default</strong>) uses timestamps to synchronize audio
with video on the server, with an optional audio delay in (decimal)