110 lines
6.6 KiB
HTML
110 lines
6.6 KiB
HTML
<!doctype html>
|
|
<html class="no-js" lang="en" dir="ltr">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="x-ua-compatible" content="ie=edge">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<title>Syng.Rocks</title>
|
|
<link rel="stylesheet" href="css/foundation.css">
|
|
<link rel="stylesheet" href="css/app.css">
|
|
</head>
|
|
<body>
|
|
|
|
<div class="top-content-section">
|
|
<div class="top-bar">
|
|
<div class="top-bar-left">
|
|
<ul class="menu">
|
|
<li class="menu-text"><img src="images/rocks.syng.Syng.png" alt="Syng.Rocks! Logo" height=30></li>
|
|
<li><a href="index.html">Home</a></li>
|
|
<li><a href="install.html">Installation</a></li>
|
|
<li><a href="faq.html">FAQ</a></li>
|
|
<li><a href="#">Server</a></li>
|
|
<li><a href="#privacy">Privacy Policy</a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="main-content-section" style="padding-top: 100px;">
|
|
<div class="grid-container">
|
|
<h1>FAQ</h1>
|
|
<dl>
|
|
<dt>Does Syng.Rocks! cost money?</dt>
|
|
<dd>
|
|
No, Syng.Rocks! is free software and licensed under the GNU Affero General Public License v3.0 (AGPL-3.0). You can use it for free without any limitations.
|
|
</dd>
|
|
<dt>Can you add song XYZ?</dt>
|
|
<dd>
|
|
Syng.Rocks! does not host any songs itself.
|
|
The client fetches songs from YouTube or any of your configured sources.
|
|
</dd>
|
|
<dt>What are sources?</dt>
|
|
<dd>
|
|
Since Syng.Rocks! does not host any songs itself, songs played by the playback client, need to come from external sources. Currently the following sources can be added:
|
|
<ul>
|
|
<li>YouTube</li>
|
|
<li>A S3 compatible server</li>
|
|
<li>A local directory</li>
|
|
</ul>
|
|
The sources are accessed from the playback client directly, the server is mostly unaware of the sources. It currently is sent a list of files to utilize the search feature.
|
|
</dd>
|
|
<dt>What file format can Syng.Rocks! play?</dt>
|
|
<dd>
|
|
Syng.Rocks! uses <a href="https://mpv.io" target="_blank">MPV</a> to play the karaoke songs, so it supports most video formats including <code>cdg+mp3</code>.
|
|
</dd>
|
|
<dt>What do you mean by <emph>Playback Client</emph>,<emph>Web Client</emph> and <emph>Server</emph>?</dt>
|
|
<dd>
|
|
<p></p>The <emph>Playback Client</emph> is the application that plays the songs and displays the lyrics. It is a desktop application.
|
|
The <emph>Web Client</emph> is the web application that allows you to manage the queue and search for songs. It is used by the guests to add songs to the queue.
|
|
The <emph>Server</emph> is the backend that manages the queue and handles connection between web clients and playback clients.</p>
|
|
<p>
|
|
If you only want to host a karaoke event, you only need the playback client.
|
|
The server is optional, as you can use the public server at <a href="https://syng.rocks" target="_blank">syng.rocks</a>.
|
|
</p>
|
|
</dd>
|
|
<dt>Can I use Syng.Rocks! without internet?</dt>
|
|
<dd>
|
|
Yes and no. The playback client needs to connect to a server instance. While you can host the server yourself in your intranet, the featureset will be limited, as some source (such as YouTube) need the playback client to reach YouTube. You can however use local and s3 sources, that are reachable from the playback client.
|
|
</dd>
|
|
<dt>Can I use Syng.Rocks! without a server?</dt>
|
|
<dd>
|
|
You can use the public server at <a href="https://syng.rocks" target="_blank">syng.rocks</a> to host your karaoke events. No need to roll up your own server.
|
|
</dd>
|
|
<dt>Can I host my own server?</dt>
|
|
<dd>
|
|
Yes, you can host your own server. The server is available as a Docker image on GitHub, or you can install it using the Python Package Index (PyPI) package <code>syng[server]</code>.
|
|
For more information, see the <a href="install.html">installation instructions</a>.
|
|
</dd>
|
|
<dt><a id="waiting-room"></a>What is the waiting room?</dt>
|
|
<dd>
|
|
The waiting room is a feature that allows you to limit the amount of songs a guest can have in the queue.
|
|
If the waiting room is enabled, guests can only add songs to the queue if they have no songs in the queue. All additional songs are placed in a waiting room and automatically leave the queue once no songs of the guest are left in the queue.
|
|
</dd>
|
|
<dt>What data do you store?</dt>
|
|
<dd>
|
|
Syng.Rocks! does not store any personal data. The server only stores the current state of the queue.
|
|
If you use the public server at <a href="https://syng.rocks" target="_blank">syng.rocks</a>, the server will also store your IP address for a limited time to prevent abuse.
|
|
For more information, see the <a href="#privacy">privacy policy</a>.
|
|
</dd>
|
|
<dt>I cannot connect to <a href="https://syng.rocks" target="_blank">https://syng.rocks</a>.</dt>
|
|
<dd>
|
|
Sometimes the server is down for maintenance. Check the official <a href="https://floss.social/@syng" target="_blank">Mastodon account</a> for announcements. Also check, if your client is up to date. The server is only compatible with the latest release.
|
|
</dd>
|
|
<dt>What is the restricted mode of the server?</dt>
|
|
<dd>
|
|
When the server is in restricted mode, <i>server side search</i> is only available to authenticated rooms. For other rooms, a search request is forwarded to the playback client and results are then send back to the web client.
|
|
</dd>
|
|
<dt>Something does not work, or I have questions not covered here</dt>
|
|
<dd>
|
|
Feel free to open an issue on the official issue tracker on <a href="https://github.com/christofsteel/syng/issues" target="_blank">GitHub</a> or reach out to us at our official Mastodon account: <a href="https://floss.social/@syng" target="_blank">@syng@floss.social</a> account or join our official matrix room: <a href="https://matrix.to/#/#syng:matrix.org" target="_blank">#syng:matrix.org</a>.
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</div>
|
|
|
|
<script src="js/vendor/jquery.js"></script>
|
|
<script src="js/vendor/what-input.js"></script>
|
|
<script src="js/vendor/foundation.js"></script>
|
|
<script src="js/app.js"></script>
|
|
</body>
|
|
</html>
|