MMS - My Music Server

Overview

MMS is a web-based local music player that allows you to manage and play your music collection from your browser.

Status: Work in progress, but fully functional for basic music playback.

Installation

Nix/home-manager users

You can use the home-manager module in this repo to install:

# in your flake input
{
    inputs = {
        mms = {
            url = "github:ony-boom/mms";
            inputs.nixpkgs.follows = "nixpkgs";
       };
    };
}

# then somewhere in your config:
{
     services.mms = {
        enable = true;
        sessionSecretFile = "<path to session secret file>";
        # see /nix/modules/home-manager.nix for the other options
    };
}

And optional but useful, add this to your flake or any method you prefer for extra subtituters, this way you avoid re-building the package:

  nixConfig = {
    extra-substituters = [
      "https://ony-boom.cachix.org"
    ];
    extra-trusted-public-keys = [
      "ony-boom.cachix.org-1:rPOTyyOCiAhLarertCrNnZLxsBFpcirEekoohcCZt10="
    ];
  };

Note

For other installation methods, I haven't done anything with them yet.

Manual Installation

1. Clone the repository:

   git clone https://github.com/ony-boom/mms.git
   cd mms

2. Install dependencies (requires Node.js ≥ 20 and pnpm):

   pnpm install

3. Set up the project:

   pnpm run setup

4. Start the development server:

   pnpm run dev

For more detailed information about the components:

• Client Documentation
• Server Documentation

Note

The client should support using other servers, but the server is only compatible with the client. If you want to use the client with another server, you can implement the same API as the server. See apps/client/src/clients/rest for an example.

Roadmap

• Improve the way the client handle playback and loading the playlist (currently verry bad)
• Add more advanced music library management features
• Optimize server performance for larger music libraries