selfhost.directory

The index of self-hostable projects — ranked, categorized and served with live updates.
Own your data and stop giving it to big tech.

auddly-server logo

Self-host auddly-server

v5.0.1

Self-hosted music streaming server with REST API

ReleaseOpen SourceMIT
Updated4 years ago
LanguageTypescript
Setup difficultyModerate
Stars
305
Port
5000 (HTTP API and music streaming)
Requires
MongoDB
Install with Docker Compose
Auddly Music Server web interface preview

What is auddly-server?

Auddly Music Server is a self-hosted music streaming application written in TypeScript that serves your personal music library over a REST API. It provides endpoints for browsing tracks, albums, artists, and genres; creating and managing playlists; streaming audio with on-the-fly transcoding; and integrating with Last.fm for scrobbling and artist metadata, plus Spotify for artist images. The server requires MongoDB for data storage and uses JWT-based authentication with an admin account. You can deploy it via Docker Compose (which builds the image from the GitHub repo) or build from source with Node.js and npm. The project is licensed under MIT and its latest release is v5.0.1 from August 2022, with the repository last pushed in September 2023.

Should you self-host auddly-server?

auddly-server scores 43/100 on selfhost.directory (how scoring works) and ranks #37 of 59 in Music Streaming. It has 305 GitHub stars.

There was no stable release in the past 12 months, so check the repository's recent activity before you rely on it.

Setup is moderate: expect some configuration beyond a single command. It is MIT-licensed and written mostly in Typescript.

Its closest alternative on selfhost.directory is koel (75/100, 17 320 stars). It scores higher overall, so compare the two before you pick. See auddly-server vs koel side by side.

Features

  • Admin user management

auddly-server README

How to install auddly-server

Install auddly-server with Docker Compose

Environment variables
MONGO_URL, MUSIC_PATH, CACHE_PATH, SPOTIFY_ID, SPOTIFY_SECRET, LAST_FM_API_KEY, LAST_FM_API_SECRET, LAST_FM_USERNAME, LAST_FM_PASSWORD, PORT, HOST, ADMIN_EMAIL, ADMIN_PASSWORD, JWT_SECRET

docker-compose up -d

Builds the app image from the GitHub repository; requires configuring all environment variables

How to configure auddly-server

  • ADMIN_EMAILAdmin account email for login

    Admin account email for login

  • ADMIN_PASSWORDAdmin account password for login

    Admin account password for login

  • CACHE_PATHPath to cache directory for album art and transcoded audio

    Path to cache directory for album art and transcoded audio

  • HOSThttp://127.0.0.1:5000Base URL of the server

    Base URL of the server

  • JWT_SECRETSecret key for JWT token signing

    Secret key for JWT token signing

  • LAST_FM_API_KEYLast.fm API key for artist bio, similar artists, tags and scrobbling

    Last.fm API key for artist bio, similar artists, tags and scrobbling

  • LAST_FM_API_SECRETLast.fm API secret

    Last.fm API secret

  • LAST_FM_PASSWORDLast.fm password for scrobbling

    Last.fm password for scrobbling

  • LAST_FM_USERNAMELast.fm username for scrobbling

    Last.fm username for scrobbling

  • MONGO_URLMongoDB connection string with authentication

    MongoDB connection string with authentication

  • MUSIC_PATHPath to music library inside container

    Path to music library inside container

  • PORT5000Port the server listens on

    Port the server listens on

  • SPOTIFY_IDSpotify Developer application client ID for artist pictures

    Spotify Developer application client ID for artist pictures

  • SPOTIFY_SECRETSpotify Developer application client secret

    Spotify Developer application client secret

More in Music Streaming

Rate this project

Click to rate — no account needed.

0 comments

Posting as guest
Loading comments…