diff --git a/CHANGELOG.md b/CHANGELOG.md index ed499ecf..ce06fe6b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,7 @@ ### New +- **Name**: Karaoke Forever is now Karaoke Eternal - **(app)** User management interface - **(app)** "Make user's next" button for upcoming songs - **(app)** "Re-queue" button for played songs @@ -13,7 +14,6 @@ - **(server)** Custom database file path support (see `--data` CLI option) - **(server)** Session key can be rotated on startup (see `--rotateKey` CLI option) - **(server)** All CLI options now have equivalent environment variables -- **(server)** PUID and PGID environment variable support ### Changed @@ -33,9 +33,7 @@ ### Sponsors -Massive thanks to this release's sponsors: [fulldecent](https://github.com/fulldecent), [vze22jjw](https://github.com/vze22jjw) - -If you have fun with it, consider [sponsoring](https://github.com/sponsors/bhj) as we roll down [the road to v1.0](https://github.com/bhj/KaraokeEternal/issues/13). +Massive thanks to this release's sponsors: [fulldecent](https://github.com/fulldecent), [vze22jjw](https://github.com/vze22jjw). If you have fun with it, please consider [sponsoring](https://www.karaoke-eternal.com/sponsor). ### New diff --git a/docs/content/docs/index.md b/docs/content/docs/index.md index 0f73c757..c9ae27ad 100644 --- a/docs/content/docs/index.md +++ b/docs/content/docs/index.md @@ -18,31 +18,6 @@ resources: galleryOrder: 5 --- -## Quick Start - -1. Install and run [Karaoke Eternal Server](#karaoke-eternal-server) on the system that will serve the app and media on your local network. - -2. Browse to the [app](#karaoke-eternal-the-app) at the **server URL**. You can copy the URL or open it in your default browser using the Karaoke Eternal Server menu bar or tray icon in macOS or Windows. - - - -3. Create your **admin** account at the welcome page. - -4. In the Preferences panel, tap Media Folders and add your [supported media](#media-files). - -5. Once the media scanner finishes, head to the [library](#library) and add some songs by tapping an artist, then tapping a song title. A glowing song means it's upcoming in the queue. - -6. Now we just need a [player](#player). On the system that will output the room's audio/video, browse to the **server URL**, sign in with your admin account, and tap the **Start Player** link at the top. If you don't see a link, your current browser doesn't support fullscreen mode, but you can still navigate to `/player`. - -7. Playback and display controls will appear on all your devices now that there's a player in the room. The current singer sees these during their turn; admins always see these. - -Congratulations, you are now ready to press play and party! - -
- ## Karaoke Eternal (the app) Karaoke Eternal is a modern mobile browser app that lets everyone join without having to install anything on their phones. It's built for touch, but a mouse is supported in desktop browsers (click and drag to emulate swipe gestures). @@ -143,11 +118,6 @@ Once a player is in the room, playback and display controls will appear. These a The server hosts the app and your media files, and can run on relatively minimal hardware (Raspberry Pi 3B+). Note that [players](#player) don't need to run on the same system as the server. - - ### Installation #### macOS or Windows @@ -164,6 +134,12 @@ The server hosts the app and your media files, and can run on relatively minimal

These packages are not currently signed. On macOS, do not disable Gatekeeper; simply right-click Karaoke Eternal Server.app in your Applications folder and choose Open. On Windows, click More Info and then Run Anyway.

+ + +See [Quick Start](#quick-start) if you're new to Karaoke Eternal. #### Docker (Synology) @@ -234,11 +210,6 @@ Karaoke Eternal is available as an `npm` package for systems running [Node.js](h $ npm i -g karaoke-eternal {{< /highlight >}} - - 2. Start the server {{< highlight shell >}} @@ -368,6 +339,31 @@ The default locations for the database (`database.sqlite3`), web server log (`se
+## Quick Start + +1. Install and run [Karaoke Eternal Server](#karaoke-eternal-server) on the system that will serve the app and media on your local network. + +2. Browse to the [app](#karaoke-eternal-the-app) at the **server URL**. You can copy the URL or open it in your default browser using the Karaoke Eternal Server menu bar or tray icon in macOS or Windows. + + + +3. Create your **admin** account at the welcome page. + +4. In the Preferences panel, tap Media Folders and add your [supported media](#media-files). + +5. Once the media scanner finishes, head to the [library](#library) and add some songs by tapping an artist, then tapping a song title. A glowing song means it's upcoming in the queue. + +6. Now we just need a [player](#player). On the system that will output the room's audio/video, browse to the **server URL**, sign in with your admin account, and tap the **Start Player** link at the top. If you don't see a link, your current browser doesn't support fullscreen mode, but you can still navigate to `/player`. + +7. Playback and display controls will appear on all your devices now that there's a player in the room. The current singer sees these during their turn; admins always see these. + +Congratulations, you are now ready to press play and party! + +
+ ## Acknowledgements - [David Zukowski](https://zuko.me){{% icon-external %}}: react-redux-starter-kit, which this project began as a fork of (all contributors up until it was detached to its own project are listed on the Contributors page) diff --git a/docs/layouts/partials/sidebar.html b/docs/layouts/partials/sidebar.html index 104800fb..be7cfd59 100644 --- a/docs/layouts/partials/sidebar.html +++ b/docs/layouts/partials/sidebar.html @@ -38,7 +38,6 @@

KaraokeEternal F.A.Q. Documentation