diff --git a/css/app.css b/css/app.css index 7a55abb..66c7c86 100644 --- a/css/app.css +++ b/css/app.css @@ -7,15 +7,32 @@ border-radius: 10px; } -.work-feature-block-image { +.textleft .work-feature-block-image { display: block; - margin-right: 0; + margin-right: auto; margin-left: auto; max-height: 500px; /* width: 100%; */ padding: 10px 0; } +.textleft .text { + text-align: right; +} + +.grid-container h1 { + border-bottom: 1px solid #0a0a0a; +} + +.textright .work-feature-block-image { + display: block; + margin-left: auto; + margin-right: auto; + max-height: 500px; + /* width: 100%; */ + padding: 10px 0; +} + .hero-full-screen { padding-top: 100px; margin-bottom: 100px; @@ -33,7 +50,7 @@ justify-content: space-between; } body { - background: url("../images/background.jpg") center center no-repeat; + background: url("../images/background_small.jpg") center center no-repeat; background-size: cover; background-attachment: fixed; } diff --git a/faq.html b/faq.html new file mode 100644 index 0000000..d81db13 --- /dev/null +++ b/faq.html @@ -0,0 +1,110 @@ + + + + + + + Syng.Rocks + + + + + +
+
+
+ +
+
+
+ +
+
+

FAQ

+
+
Does Syng.Rocks! cost money?
+
+ 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. +
+
Can you add song XYZ?
+
+ Syng.Rocks! does not host any songs itself. + The client fetches songs from YouTube or any of your configured sources. +
+
What are sources?
+
+ 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: +
    +
  • YouTube
    • +
  • A S3 compatible server
    • +
  • A local directory
    • +
+ 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. +
+
What file format can Syng.Rocks! play?
+
+ Syng.Rocks! uses MPV to play the karaoke songs, so it supports most video formats including cdg+mp3. +
+
What do you mean by Playback Client,Web Client and Server?
+
+

The Playback Client is the application that plays the songs and displays the lyrics. It is a desktop application. + The Web Client 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 Server is the backend that manages the queue and handles connection between web clients and playback clients.

+

+ 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 syng.rocks. +

+
+
Can I use Syng.Rocks! without internet?
+
+ 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. +
+
Can I use Syng.Rocks! without a server?
+
+ You can use the public server at syng.rocks to host your karaoke events. No need to roll up your own server. +
+
Can I host my own server?
+
+ 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 syng[server]. + For more information, see the installation instructions. +
+
What is the waiting room?
+
+ 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. +
+
What data do you store?
+
+ 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 syng.rocks, the server will also store your IP address for a limited time to prevent abuse. + For more information, see the privacy policy. +
+
I cannot connect to https://syng.rocks.
+
+ Sometimes the server is down for maintenance. Check the official Mastodon account for announcements. Also check, if your client is up to date. The server is only compatible with the latest release. +
+
What is the restricted mode of the server?
+
+ When the server is in restricted mode, server side search 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. +
+
Something does not work, or I have questions not covered here
+
+ Feel free to open an issue on the official issue tracker on GitHub or reach out to us at our official Mastodon account: @syng@floss.social account or join our official matrix room: #syng:matrix.org. +
+
+
+
+ + + + + + + diff --git a/images/background_small.jpg b/images/background_small.jpg new file mode 100644 index 0000000..5438116 Binary files /dev/null and b/images/background_small.jpg differ diff --git a/images/sources.png b/images/sources.png new file mode 100644 index 0000000..04f6295 Binary files /dev/null and b/images/sources.png differ diff --git a/images/sources.svg b/images/sources.svg new file mode 100644 index 0000000..e1aacd1 --- /dev/null +++ b/images/sources.svg @@ -0,0 +1,742 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/index.html b/index.html index 0fe442e..2e977ee 100644 --- a/index.html +++ b/index.html @@ -1,4 +1,3 @@ - @@ -16,8 +15,9 @@
@@ -54,18 +54,18 @@
-
-
+
+

Get started

If you only want to have a small YouTube based karaoke event, you can just download the app, share the generated QR Code and start singing. No registration, no login and no configuration required.

-
+
Syng.Rocks Client
-
+
Syng.Rocks Web Client
@@ -77,17 +77,28 @@

-
+

Configure to your needs

- Syng allows for a lot of configuration options. You can set up your own song database, you can set up a waiting room, a set time the event ends and much more. + Syng allows for a lot of configuration options. You can set up your own song database, you can set up a waiting room, a set time the event ends and much more.

Syng.Rocks Client
+
+
+ Syng.Rocks Web Client +
+
+

Multiple Sources

+

+ Syng.Rocks! supports multiple sources for karaoke songs. The default source is YouTube, but you can configure a remote S3 compatible server or simply a folder on your system. The client connects directly to the sources, no login data is ever shared with the server. +

+
+
diff --git a/install.html b/install.html new file mode 100644 index 0000000..89a351a --- /dev/null +++ b/install.html @@ -0,0 +1,67 @@ + + + + + + + Syng.Rocks + + + + + +
+
+
+ +
+
+
+ +
+
+

Installation

+

Client

+

+ Depending on your platform, you can install Syng.Rocks! in different ways. +

+
Linux
+
+ Syng.Rocks! is available as a Flatpak on Flathub. You can install it using the command line with: + 
flatpak install rocks.syng.Syng
+ There also exists an Arch Linux package in the AUR. +
+
Windows
+
+ Windows binaries are available on GitHub. This is a portable version and does not require installation. +
+
Generic
+
+ The Syng.Rocks! client is available in the Python Package Index (PyPI) as syng. You can install it using pip: + 
pip install syng[client]
+
+
+

+

Server

+

+ The server is available as a Docker image hosted on GitHub. You can install it with + 

docker run ghcr.io/christofsteel/syng
+ Alternatively, you can also run the server using the Python Package Index (PyPI) package syng: + 
pip install syng[server]
+

+
+
+ + + + + + +