Building a Self-Hosted Karaoke System with Jellyfin: A Fun Project for Music Lovers

A journey to create a web-based karaoke system that integrates with Jellyfin

I’ve always been a fan of karaoke nights with friends, but the expensive machines and subscription services were a bit of a turn-off. So, I decided to take matters into my own hands and build a self-hosted karaoke system that integrates with Jellyfin. The result is a web-based system that’s easy to use, customizable, and most importantly, fun! In this post, I’ll share my journey and guide you through the process of building your own self-hosted karaoke system.

What is Karaoke for Jellyfin?

Karaoke for Jellyfin is a web-based karaoke system that turns your existing Jellyfin media server into a full karaoke setup. With this system, you can search and queue songs from your phone, and display the lyrics on your TV in full screen. The system also includes features like performance ratings, next song indicators, and real-time updates. The best part? It’s completely free and open-source, so you can customize it to your heart’s content.

Key Features of Karaoke for Jellyfin

Here are some of the key features that make Karaoke for Jellyfin an awesome karaoke system:

• Uses your existing Jellyfin music library, so you don’t need to upload or manage separate song files
• Mobile-optimized song search and queueing, so you can easily find and add songs to the queue from your phone
• Full-screen TV display with synchronized lyrics, so you can focus on singing without distractions
• Progressive Web App (install like a native app), so you can access the system from any device with a web browser
• Works offline once loaded, so you don’t need to worry about internet connectivity issues during your karaoke party
• Docker deployment (one command setup!), so you can easily set up and deploy the system on your server

Setting Up Karaoke for Jellyfin

Setting up Karaoke for Jellyfin is relatively easy, thanks to Docker Compose. Here’s a step-by-step guide to get you started:

First, you’ll need to create a Docker Compose file that points to your Jellyfin server. You can do this by creating a new file named `docker-compose.yml` with the following content:

version: "3.8"
services:
  karaoke-app:
    image: mrorbitman/karaoke-for-jellyfin:latest
    ports:
      - 3967:3000
    environment:
      # Jellyfin Configuration
      - JELLYFIN_SERVER_URL=${JELLYFIN_SERVER_URL:-http://host.docker.internal:8096}
      - JELLYFIN_API_KEY=${JELLYFIN_API_KEY}
      - JELLYFIN_USERNAME=${JELLYFIN_USERNAME}
      # TV Display Timing Configuration (in milliseconds)
      - RATING_ANIMATION_DURATION=${RATING_ANIMATION_DURATION:-15000}
      - NEXT_SONG_DURATION=${NEXT_SONG_DURATION:-15000}
      - CONTROLS_AUTO_HIDE_DELAY=${CONTROLS_AUTO_HIDE_DELAY:-10000}
      - AUTOPLAY_DELAY=${AUTOPLAY_DELAY:-500}
      - QUEUE_AUTOPLAY_DELAY=${QUEUE_AUTOPLAY_DELAY:-1000}
      - TIME_UPDATE_INTERVAL=${TIME_UPDATE_INTERVAL:-2000}
      # System Configuration
      - NODE_ENV=production
      - PORT=3000
      - HOSTNAME=0.0.0.0
    restart: always

Once you’ve created the Docker Compose file, you can start the Karaoke for Jellyfin service by running the command `docker-compose up -d`. This will start the service in detached mode, and you can access the web interface by navigating to `http://localhost:3967` in your web browser.

Using Karaoke for Jellyfin

Using Karaoke for Jellyfin is straightforward. Once you’ve set up the system, you can access the web interface from any device with a web browser. From here, you can search for songs, add them to the queue, and view the lyrics on your TV in full screen. You can also use the mobile interface to search and queue songs from your phone, and the system will update in real-time.

Conclusion

Building a self-hosted karaoke system with Jellyfin was a fun project that’s brought a lot of joy to my friends and me. The system is easy to use, customizable, and most importantly, fun! If you’re a music lover looking for a new way to enjoy your favorite songs, I highly recommend giving Karaoke for Jellyfin a try. With its open-source nature and customizable features, you can tailor the system to your needs and create a unique karaoke experience that’s all your own.

—

Budowanie Samoobsługowego Systemu Karaoke z Jellyfin: Fajny Projekt dla Miłośników Muzyki

Podróż po stworzeniu sieciowego systemu karaoke, który integruje się z Jellyfin

Zawsze byłem fanem nocy karaoke z przyjaciółmi, ale drogie maszyny i usługi subskrypcyjne były trochę odstraszające. Postanowiłem więc wziąć sprawy w swoje ręce i zbudować samoobsługowy system karaoke, który integruje się z Jellyfin. Efektem jest sieciowy system, który jest łatwy w użyciu, dostosowywalny i co najważniejsze, zabawny! W tym poście opowiem o swojej podróży i przeprowadzę Cię przez proces budowania własnego samoobsługowego systemu karaoke.

Co to jest Karaoke dla Jellyfin?

Karaoke dla Jellyfin to sieciowy system karaoke, który zmienia istniejący serwer Jellyfin w pełny zestaw karaoke. Z tym systemem możesz wyszukiwać i dodawać piosenki do kolejki z telefonu, a teksty wyświetlać na telewizorze w pełnym ekranie. System zawiera również funkcje takie jak oceny wykonania, wskaźniki następnej piosenki i aktualizacje w czasie rzeczywistym. Najlepsza część? Jest całkowicie darmowy i open-source, więc możesz go dostosować do swoich potrzeb.

Główne cechy Karaoke dla Jellyfin

Oto niektóre z głównych cech, które sprawiają, że Karaoke dla Jellyfin jest świetnym systemem karaoke:

• Używa Twojej istniejącej biblioteki muzyki Jellyfin, więc nie musisz przesyłać ani zarządzać oddzielnymi plikami piosenek
• Wyszukiwanie i dodawanie piosenek do kolejki zoptymalizowane dla urządzeń mobilnych, więc możesz łatwo znaleźć i dodać piosenki do kolejki z telefonu
• Wyświetlanie tekstów w pełnym ekranie na telewizorze, więc możesz się skupić na śpiewaniu bez rozpraszających elementów
• Aplikacja webowa postępowa (instalowana jak aplikacja natywna), więc możesz uzyskać dostęp do systemu z dowolnego urządzenia z przeglądarką internetową
• Działa offline po załadowaniu, więc nie musisz się martwić o problemy z łącznością internetową podczas Twojej imprezy karaoke
• Wdrożenie Docker (konfiguracja jednym poleceniem!), więc możesz łatwo zainstalować i wdrożyć system na swoim serwerze

Konfiguracja Karaoke dla Jellyfin

Konfiguracja Karaoke dla Jellyfin jest dość prosta dzięki Docker Compose. Oto krok po kroku, aby rozpocząć:

Najpierw musisz utworzyć plik Docker Compose, który wskazuje na Twój serwer Jellyfin. Możesz to zrobić, tworząc nowy plik o nazwie `docker-compose.yml` z następującą zawartością:

wersja: "3.8"
usługi:
  karaoke-app:
    obraz: mrorbitman/karaoke-for-jellyfin:latest
    porty:
      - 3967:3000
    środowisko:
      # Konfiguracja Jellyfin
      - JELLYFIN_SERVER_URL=${JELLYFIN_SERVER_URL:-http://host.docker.internal:8096}
      - JELLYFIN_API_KEY=${JELLYFIN_API_KEY}
      - JELLYFIN_USERNAME=${JELLYFIN_USERNAME}
      # Konfiguracja czasu wyświetlania telewizora (w milisekundach)
      - RATING_ANIMATION_DURATION=${RATING_ANIMATION_DURATION:-15000}
      - NEXT_SONG_DURATION=${NEXT_SONG_DURATION:-15000}
      - CONTROLS_AUTO_HIDE_DELAY=${CONTROLS_AUTO_HIDE_DELAY:-10000}
      - AUTOPLAY_DELAY=${AUTOPLAY_DELAY:-500}
      - QUEUE_AUTOPLAY_DELAY=${QUEUE_AUTOPLAY_DELAY:-1000}
      - TIME_UPDATE_INTERVAL=${TIME_UPDATE_INTERVAL:-2000}
      # Konfiguracja systemu
      - NODE_ENV=production
      - PORT=3000
      - HOSTNAME=0.0.0.0
    restart: zawsze

Po utworzeniu pliku Docker Compose możesz uruchomić usługę Karaoke dla Jellyfin, wpisując polecenie `docker-compose up -d`. Spowoduje to uruchomienie usługi w trybie odłączonym, a możesz uzyskać dostęp do interfejsu webowego, przechodząc do `http://localhost:3967` w swojej przeglądarce internetowej.

Używanie Karaoke dla Jellyfin

Używanie Karaoke dla Jellyfin jest proste. Po skonfigurowaniu systemu możesz uzyskać dostęp do interfejsu webowego z dowolnego urządzenia z przeglądarką internetową. Stąd możesz wyszukiwać piosenki, dodawać je do kolejki i wyświetlać teksty na telewizorze w pełnym ekranie. Możesz również używać interfejsu mobilnego, aby wyszukiwać i dodawać piosenki do kolejki z telefonu, a system będzie aktualizowany w czasie rzeczywistym.

Podsumowanie

Budowanie samoobsługowego systemu karaoke z Jellyfin było fajnym projektem, który przyniósł wiele radości mnie i moim przyjaciołom. System jest łatwy w użyciu, dostosowywalny i co najważniejsze, zabawny! Jeśli jesteś miłośnikiem muzyki, który szuka nowego sposobu na śpiewanie ulubionych piosenek, polecam wypróbowanie Karaoke dla Jellyfin. Dzięki jego otwartej naturze i dostosowywalnym funkcjom możesz stworzyć unikalne doświadczenie karaoke, które jest wyłącznie Twoje.