mitchellsingleton/docker-airconnect

How to use this image

This image can be used by running a docker compose file or a docker run command.

Sample docker compose file (includes environment variable so the aircast executable is never started and custom parameters for the airupnp executable):

version: '3.9'
services:
    airconnect:
        network_mode: host
        image: mitchellsingleton/docker-airconnect
        environment:
            - "AIRCAST_VAR=kill" #this prevents the aircast executable from starting
            - "AIRUPNP_VAR=-x /config/airconnect-airupnp.xml -l 1000:2000" #custom parameters for the airupnp executable, the -x parameter loads a config file
            - "PATH_VAR=/config" #variable of where to store executables
            #- "VERSION_VAR=" #variable for a specific version, default is latest.
            - "MAXTOKEEP_VAR=10" #variable to only keep the most recent number of versions (uses modification date)

        volumes:
            - /mnt/docker_airconnect_data:/config
        networks:
            - outside

networks:
    outside:
      name: "host"
      external: true`

Sample docker run command: sudo docker run --net=host --pull always -v /mnt/docker_airconnect_data/:/config/ -e PATH_VAR=/config -e AIRCAST_VAR=kill -e MAXTOKEEP_VAR=10 --rm mitchellsingleton/docker-airconnect

Bare minimum Docker run command (will run both aircast and airupnp executables as services):

docker run -d --net=host mitchellsingleton/docker-airconnect

If you would like to run a specific version of AirConnect you can now specify the Release Version corresponding to the releases from the original developer of the application as found here: https://github.com/philippe44/AirConnect/releases. This can be done by using an evironment variable named "VERSION_VAR". For example, to run release 1.6.1 use:

docker run -d --net=host -e VERSION_VAR=1.6.1 mitchellsingleton/docker-airconnect

Environment variables that can be set when the container is ran:

• AIRCAST_VAR - This variable allows passing command line parameters to the aircast executable or using the special case of 'kill' to disable the aircast service. Note: do not add -z or -Z to deamonize or the s6 overlay will think the service died and will start it again.
• AIRUPNP_VAR - This variable allows passing command line parameters to the airupnp executable or using the special case of 'kill' to disable the airupnp service. Note: do not add -z or -Z to deamonize or the s6 overlay will think the service died and will start it again. Note: add in -l 1000:2000 per the AirConnect notes for Sonos/Heos players. This is part of the current default string.
• PATH_VAR - allows specifying a persistant storage path
• VERSION_VAR - allows specifying a specific version of airconnect
• MAXTOKEEP_VAR - allows specifying how many previous version in the path (if it isn't persistent, only the most recent one will be there)

If you only need one service, you can choose to kill the unneeded service on startup so that it does not run. To do this, use the appropriate variable from above (AIRCAST_VAR/AIRUPNP_VAR) and set it equal to kill. This will prevent the service from starting up