What is Swing Music?

Swing music is a music player and streaming server for your audio files. It is designed to be beautiful, fast, and feature-rich. It has a sleek and modern interface that is easy to use.

Installing Swing Music

On Linux or MacOS run the command below to install Swing Music:

curl -fsSL https://setup.swingmx.com | bash

The script will install and launch Swing Music for you. You can start using it by opening http://localhost:1970.

Swing Music is also available as precompiled binaries. You can download the latest binary file from the download page and run it. On Linux and Mac, you need to make the file executable before running it.

chmod +x ./path/to/swingmusic

# then
./path/to/swingmusic

Installing using Docker Compose

Create a docker-compose.yml in your desired path:

services:
  swingmusic:
    image: ghcr.io/swingmx/swingmusic:latest
    container_name: swingmusic
    ports:
      - "1970:1970"
    volumes:
      - /path/to/music:/music
      - /path/to/config:/config
    environment:
      - SWINGMUSIC_PORT=1970
      - SWINGMUSIC_DEVICE_NAME=Host name here
    restart: unless-stopped

Replace /path/to/music with your music location and /path/to/config with the path you want the config to be created. Also replace Host Name Here with a name to identify your server or computer.

Then run:

docker compose up

The server will be accessible at http://localhost:1970

Installing using Docker CLI

Pull the Docker image and run it.

docker pull ghcr.io/swingmx/swingmusic:latest

docker run --name swingmusic -p 1970:1970 \
-v /path/to/music:/music -v /path/to/config:/config \
-e SWINGMUSIC_PORT=1970 \
-e SWINGMUSIC_DEVICE_NAME="Host name here" \
--restart unless-stopped ghcr.io/swingmx/swingmusic

Replace /path/to/music with your music location and /path/to/config with the path you want the config to be created. Also replace Host Name Here with a name to identify your server or computer.

You can use multiple music folders by mounting them to /music.

-v /path/1:/music -v /path/2:/music

You can pass Swing Music options at the end of the docker run command.

--restart unless-stopped ghcr.io/swingmx/swingmusic --help # print help text

Options

Options are flags that can be passed when starting the app in the terminal to tweak runtime settings or perform tasks.

Option	Short	Description
--help	-h	Show this help message
--version	-v	Show the app version
--host		Set the host
--port		Set the port
--config		Set the path to create the config folder