izackp/Apollo
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update docs

Browse Source 
- add information about various ports
- correct typos in macos installation instructions
This commit is contained in:
ReenigneArcher
2022-08-26 17:05:12 -04:00
parent 642c4a9ed7
commit 43fa4100d2
3 changed files with 26 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/source/about/advanced_usage.rst
+22 -1
View File
@@ -443,7 +443,28 @@ port
^^^^ ^^^^
Description Description
Set the family of ports used by Sunshine. Set the family of ports used by Sunshine. Changing this value will offset other ports per the table below.
.. table::
:widths: auto
================ ============ ===========================
Port Description Default Port Difference from config port
================ ============ ===========================
HTTPS 47984 TCP -5
HTTP 47989 TCP 0
Web 47990 TCP +1
RTSP 48010 TCP +21
Video 47998 UDP +9
Control 47999 UDP +10
Audio 48000 UDP +11
tbd 48002 UDP +13
================ ============ ===========================
.. Attention:: Custom ports are only allowed on select Moonlight clients.
.. Todo:: Determine the function of port 48002 UDP. See
`here <https://github.com/moonlight-stream/moonlight-docs/wiki/Setup-Guide#manual-port-forwarding-advanced>`_.
Default Default
``47989`` ``47989``
docs/source/about/installation.rst
+2 -2
View File
@@ -188,7 +188,7 @@ Portfile
Add this line, replacing your username, below the line that starts with ``rsync``. Add this line, replacing your username, below the line that starts with ``rsync``.
file://Users/<username>/ports ``file:///Users/<username>/ports``
``Ctrl+x``, then ``Y`` to exit and save changes. ``Ctrl+x``, then ``Y`` to exit and save changes.
@@ -197,7 +197,7 @@ Portfile
.. code-block:: bash .. code-block:: bash
mkdir -p ~/ports/multimedia/sunshine mkdir -p ~/ports/multimedia/sunshine
mv ~/Downlaods/Portfile ~/ports/multimedia/sunshine mv ~/Downloads/Portfile ~/ports/multimedia/sunshine/
cd ~/ports cd ~/ports
portindex portindex
sudo port install sunshine sudo port install sunshine
docs/source/about/usage.rst
+2 -2
View File
@@ -39,9 +39,9 @@ Usage
Network Network
------- -------
Sunshine will be available on port 47990 by default. The Sunshine user interface will be available on port 47990 by default.
.. Danger:: Do not expose port 47990, or the web ui, to the internet! .. Warning:: Exposing ports to the internet can be dangerous. Do this at your own risk.
Arguments Arguments
--------- ---------