grundic / jamulus-docker

Docker image for online jamming software Jamulus

Jamulus 🎶

Docker configuration for Jamulus music server.

The Jamulus software enables musicians to perform real-time jam sessions over the internet. There is one server running the Jamulus server software which collects the audio data from each Jamulus client, mixes the audio data and sends the mix back to each client.

Usage

Here are some example snippets to help you get started creating a container.

docker

docker run \
  -e TZ=America/Los_Angeles \
  --name jamulus \
  -d --rm \
  -p 22124:22124/udp \
  -v $(pwd)/jam:/jam \
  grundic/jamulus \
  -n -s -p 22124 -l /jam/jamulus.log -w "Welcome to Jamulus docker server."

docker-compose

---
version: "3.7"
services:
  jamulus:
    container_name: jamulus 
    image: grundic/jamulus
    restart: always
    ports:
      - "22124:22124/udp"
    environment:
      TZ: "America/Los_Angeles"  
    entrypoint:
      - "Jamulus"
      - "--server"
      - "--nogui"
      - "--welcomemessage"
      - "Welcome to the Jamulus rehearsal room"
      - "--numchannels"
      - "16"

You can monitor output with docker logs -f jamulus

⚠️ To improve performance, please consider using docker's realtime scheduler

Parameters

Parameter	Description
-a, --servername	server name, required for HTML status
-d, --discononquit	disconnect all clients on quit
-e, --centralserver	address of the central server (or 'localhost' to be a central server)
-f, --listfilter	server list whitelist filter in the format: [IP address 1];[IP address 2];[IP address 3]; ...
-F, --fastupdate	use 64 samples frame size mode
-g, --pingservers	ping servers in list to keep NAT port open (central server only)
-l, --log	enable logging, set file name
-L, --licence	a licence must be accepted on a new connection
-m, --htmlstatus	enable HTML status file, set file name
-n, --nogui	disable GUI
-o, --serverinfo	infos of the server(s) in the format: [name];[city];[country as QLocale ID]; ... [server1 address];[server1 name]; ... [server1 city]; ... [server1 country as QLocale ID]; ... [server2 address]; ...
-R, --recording	sets directory to contain recorded jams
--norecord	disables recording (when enabled by default by -R)
-p, --port	local port number
-s, --server	start server
-T, --multithreading	use multithreading to make better use of multi-core CPUs and support more clients
-u, --numchannels	maximum number of channels
-w, --welcomemessage	welcome message on connect
-z, --startminimized	start minimizied