Getting Started
Installing Swing Music
Swing Music is available as precompiled binaries for both Windows and Linux.
Download the latest binary file from the download page and run it. That's all of it.
For Linux users, you need to make the file executable using chmod
to run it.
Something like this.
sh
chmod +x ./swingmusic
chmod +x ./swingmusic
Docker
Pull the Docker image and run it.
sh
docker pull ghcr.io/swingmx/swingmusic:latest
docker pull ghcr.io/swingmx/swingmusic:latest
Replace /path/to/music
with your music location and /path/to/config
with the path you want the config to be created.
sh
docker run --name swingmusic -p 1971:1970 \
-v /path/to/music:/music -v /path/to/config:/config \
--restart unless-stopped ghcr.io/swingmx/swingmusic
docker run --name swingmusic -p 1971:1970 \
-v /path/to/music:/music -v /path/to/config:/config \
--restart unless-stopped ghcr.io/swingmx/swingmusic
You can use multiple music folders by mounting them to /music
.
sh
-v /path/1:/music -v /path/2:/music
-v /path/1:/music -v /path/2:/music
You can pass Swing Music options at the end of the docker run
command.
sh
--restart unless-stopped ghcr.io/swingmx/swingmusic --help # print help text
--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 | |
--no-periodic-scan | -nps | Disable periodic scan |
--scan-interval | -psi | Set the periodic scan interval in seconds. Default: 600 seconds (10 minutes) |
--build | Build the application (in development) |