colin/sublime-music
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update settings documentation

Browse Source
This commit is contained in:
Sumner Evans
2020-06-07 10:42:05 -06:00
parent 11074b4e84
commit e798fada3b
2 changed files with 58 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
cicd/publish-gitlab-release.sh
View File

@@ -30,7 +30,9 @@ if [[ $(head -n 1 CHANGELOG.rst) == "${CI_COMMIT_TAG}" ]]; then
# i is now the index of the line below the second header.
description="**Release Notes:**
description="
Release Notes
#############
$(head -n $(( $i - 2 )) CHANGELOG.rst | tail -n $(( $i - 5 )))"
fi

92
docs/settings.rst
View File

@@ -23,74 +23,92 @@ Serve Local Files to Chromecasts on the LAN : (``bool``)
If checked, a local server will be started on your computer which will serve
your locally cached music files to the Chromecast. If not checked, the
Chromecast will always stream from the server.
If you are having trouble playing on your Chromecast, try disabling this
feature.
LAN Server Port Number : (int)
LAN Server Port Number : (``int``)
The port number to use for streaming to Chromecast devices on the same
LAN.
A server will be started on this port and when you play a song that is
already cached locally, the Chromecast will connect to your computer and
stream from it instead of from the internet.
Allow Song Downloads : (bool)
Allow Song Downloads : (``bool``)
If toggled on, this will allow songs to be downloaded and cached locally.
When Streaming, Also Download Song : (bool)
When Streaming, Also Download Song : (``bool``)
If toggled on, when a song is streamed, it will also be downloaded. Once the
download is complete, Sublime Music will stop streaming and switch to the
downloaded version (if playing locally with MPV).
Number of Songs to Prefetch : (int)
Number of Songs to Prefetch : (``int``)
If the next :math:`n` songs in the play queue are not already downloaded,
they will be downloaded.
Maximum Concurrent Downloads : (int)
Maximum Concurrent Downloads : (``int``)
Specifies the maximum number of songs that should be downloaded at the same
time.
Subsonic Server Settings
------------------------
Music Provider Settings
-----------------------
Each server has the following configuration options:
Name : (string)
Music Provider Name : (``string``)
The friendly name of this server which is used throughout the UI to
differentiate servers.
differentiate music providers.
Server address : (uri)
Subsonic Music Provider Settings
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The following settings are configurable when using Subsonic as the music
provider.
Server Address : (URI)
The URI of the Subsonic-API-compliant server (specify the server root, do
not include ``/api`` or any other suffix).
not include ``/api`` or any other suffix). If you don't include ``https://``
at the front o
Local network address : (string)
See *Local network SSID*
Local network SSID : (string)
If this SSID is active (as reported by NetworkManager), then the *Local
network address* will be used to connect to the Subsonic-API-compliant
server instead of the *Server address*.
This is useful if your internet provider does not allow you to connect to
your internal network using the IP of your network.
Username : (string)
Username : (``string``)
The username to login as.
Password : (string)
The password to login with. This is stored in the system keyring.
Password : (``string``)
The password to login with. Sublime Music will attempt to store it in the
system keyring, but fall back to storing it in plaintext in the
configuration.
Play queue sync enabled : (bool)
If checked, Sublime Music will synchronise the play queue and song progress
to the server every 15 seconds, whenever the song is paused/played, whenever
the play queue is edited, and whenever a new song is started.
Do not verify certificate : (bool)
Disables certificate verification if the protocol is HTTPS.
Verify Certificate : (``bool``, default ``True``)
Whether or not to verify the SSL certificate of the server.
.. danger::
Only check this if you are *absolutely certain* that your connection to
your server is secure, despite having an invalid or self-signed
certificate.
Only turn this off if you are *absolutely certain* that your connection
to your server is secure. One reasons this may be necessary is if you
have a self-signed certificate.
Sync Play Queue : (``bool``, default ``True``)
If on, Sublime Music will periodically save the play queue state so that you
can resume on other devices.
.. admonition:: Details
Sublime Music will synchronise the play queue and song progress to the
server every 15 seconds while playing a song. It will also sync whenever
a song is is paused/played, or when the play queue is edited, and
whenever a new song is started.
Local Network SSID : (``string``)
If Sublime Music is connected to the given SSID, the Local Network Address
will be used instead of the Server address when making network requests.
.. admonition:: Details
If this SSID is active (as reported by NetworkManager), then the *Local
network address* will be used to connect to the Subsonic-API-compliant
server instead of the *Server address*.
This is useful if your internet provider does not allow you to connect to
your internal network using the external IP of your network.
Local Network Address : (``string``)
See *Local network SSID*