morgan/UxPlay
1
0
Fork 0
mirror of https://github.com/morgan9e/UxPlay synced 2026-04-14 00:04:13 +09:00
Code Issues Packages Projects Releases Wiki Activity

README edits

Browse Source
This commit is contained in:
F. Duncanh
2024-01-19 11:55:33 -05:00
parent 9c44d2ed47
commit b7984f848a
3 changed files with 48 additions and 53 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
README.html
View File

@@ -15,7 +15,7 @@ improved support for Apple-style one-time “pin” codes introduced in
maintained to check returning clients; a simpler method for generating a
persistent public key (based on the MAC address, which can be set in the
UxPlay startup file) is now the default. (The OpenSSL “pem-file” method
introduced in 1.67 is still available with the ’-key” option.)</em></li>
introduced in 1.67 is still available with the “-key” option.)</em></li>
</ul>
<h2 id="highlights">Highlights:</h2>
<ul>
@@ -42,6 +42,9 @@ decoding</strong> by the Broadcom GPU. <em>Tested on Raspberry Pi Models
<li>Support for running on Microsoft Windows (builds with the MinGW-64
compiler in the unix-like MSYS2 environment).</li>
</ul>
<p>Note: AirPlay2 multi-room audio streaming is not supported: use <a
href="https://github.com/mikebrady/shairport-sync">shairport-sync</a>
for that.</p>
<h2 id="packaging-status-linux-and-bsd-distributions">Packaging status
(Linux and *BSD distributions)</h2>
<p><a href="https://repology.org/project/uxplay/versions"><img
@@ -903,14 +906,13 @@ time: a four-digit pin code is displayed on the terminal, and the client
screen shows a login prompt for this to be entered. When “-pin” is used
by itself, a new random pin code is chosen for each authentication; if
“-pin nnnn” (e.g., “-pin 3939”) is used, this will set an unchanging
fixed code. To retain client authentication after UxPlay restarts, at
the first use of “-pin”, the server public key is written to file
(default: $HOME/.uxplay.pem; can be changed with option
<code>-key &lt;filename&gt;</code>), and read back in at subsequent
UxPlay startups. As long as this file is not deleted or moved, a client
will not have to re-authenticate after an initial authentication.
<em>(Add a “pin” entry in the UxPlay startup file if you wish the UxPlay
server to use this protocol).</em></p>
fixed code. Clients will not need to reauthenticate so long as the
client and server public keys remain unchanged. (By default since v1.68,
the server public key is generated from the MAC address, which can be
changed with the -m option; see the -key option for an alternative
method of key generation). <em>(Add a line “pin” in the UxPlay startup
file if you wish the UxPlay server to use the pin authentication
protocol).</em></p>
<p><strong>-reg [<em>filename</em>]</strong>: (since v1.68). This option
maintains a list of previously-pin-registered clients in
$HOME/.uxplay.register (or optionally, in <em>filename</em>). Without
@@ -1160,16 +1162,13 @@ or read from it, if it exists. (Optionally, the key can be stored in
<em>filename</em>.) This method is more secure than the new default
method, (because the Device ID is broadcast in the DNS_SD announcement)
but still leaves the private key exposed to anyone who can access the
pem file. Because the default (but “less-secure”) “Device ID” method is
simpler, and security of client access to uxplay is unlikely to be an
important issue, the -key option is no longer recommended.</p>
<p>By default, the storage of the Server private key is in the file
$HOME/.uxplay.pem. Use the “-key <em>filename</em>” option to change
this location. This option should be set in the UxPlay startup file as a
line “<code>key filename</code>” (no initial “-”), where
<code>filename</code> is a full path. The filename may be enclosed in
quotes (<code>"...."</code>), (and must be, if the filename has any
blank spaces).</p>
pem file. This option should be set in the UxPlay startup file as a line
“key” or “key <em>filename</em>” (no initial “-”), where
<em>filename</em> is a full path which should be enclosed in quotes
(<code>"...."</code>) if it contains any blank spaces. <strong>Because
the default method is simpler, and security of client access to uxplay
is unlikely to be an important issue, the -key option is no longer
recommended</strong>.</p>
<p><strong>-dacp [<em>filename</em>]</strong>: Export current client
DACP-ID and Active-Remote key to file: default is $HOME/.uxplay.dacp.
(optionally can be changed to <em>filename</em>). Can be used by remote