|
| 1 | +--- |
| 2 | +title: airsonic |
| 3 | +--- |
| 4 | +<!-- DO NOT EDIT THIS FILE MANUALLY --> |
| 5 | +<!-- Please read the https://github.com/linuxserver/docker-airsonic/blob/master/.github/CONTRIBUTING.md --> |
| 6 | + |
| 7 | +# DEPRECATION NOTICE |
| 8 | + |
| 9 | +This image is deprecated. We will not offer support for this image and it will not be updated. |
| 10 | +We recommend our airsonic-advanced image instead: |
| 11 | +https://github.com/linuxserver/docker-airsonic-advanced |
| 12 | + |
| 13 | +# [linuxserver/airsonic](https://github.com/linuxserver/docker-airsonic) |
| 14 | + |
| 15 | +[](https://scarf.sh/gateway/linuxserver-ci/docker/linuxserver%2Fairsonic) |
| 16 | +[](https://github.com/linuxserver/docker-airsonic) |
| 17 | +[](https://github.com/linuxserver/docker-airsonic/releases) |
| 18 | +[](https://github.com/linuxserver/docker-airsonic/packages) |
| 19 | +[](https://gitlab.com/linuxserver.io/docker-airsonic/container_registry) |
| 20 | +[](https://quay.io/repository/linuxserver.io/airsonic) |
| 21 | +[](https://hub.docker.com/r/linuxserver/airsonic) |
| 22 | +[](https://hub.docker.com/r/linuxserver/airsonic) |
| 23 | +[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-airsonic/job/master/) |
| 24 | +[](https://ci-tests.linuxserver.io/linuxserver/airsonic/latest/index.html) |
| 25 | + |
| 26 | +[Airsonic](https://github.com/airsonic/airsonic) is a free, web-based media streamer, providing ubiquitious access to your music. Use it to share your music with friends, or to listen to your own music while at work. You can stream to multiple players simultaneously, for instance to one player in your kitchen and another in your living room. |
| 27 | + |
| 28 | +## Supported Architectures |
| 29 | + |
| 30 | +Our images support multiple architectures such as `x86-64`, `arm64` and `armhf`. We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/). |
| 31 | + |
| 32 | +Simply pulling `lscr.io/linuxserver/airsonic` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. |
| 33 | + |
| 34 | +The architectures supported by this image are: |
| 35 | + |
| 36 | +| Architecture | Tag | |
| 37 | +| :----: | --- | |
| 38 | +| x86-64 | amd64-latest | |
| 39 | +| arm64 | arm64v8-latest | |
| 40 | +| armhf | arm32v7-latest | |
| 41 | + |
| 42 | +## Application Setup |
| 43 | + |
| 44 | +Access WebUI at `<your-ip>:4040`. |
| 45 | + |
| 46 | +Default user/pass is admin/admin |
| 47 | + |
| 48 | +Extra java options can be passed with the JAVA_OPTS environment variable, eg `-e JAVA_OPTS="-Xmx256m -Xms256m"`. For some reverse proxies, you may need to pass `JAVA_OPTS=-Dserver.use-forward-headers=true` for airsonic to generate the proper URL schemes. |
| 49 | + |
| 50 | +Note that if you want to use [Airsonic's Java jukebox player](https://airsonic.github.io/docs/jukebox/), then `PGID` will need to match the group of your sound device (e.g. `/dev/snd`). |
| 51 | + |
| 52 | +## Usage |
| 53 | + |
| 54 | +To help you get started creating a container from this image you can either use docker-compose or the docker cli. |
| 55 | + |
| 56 | +### docker-compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose)) |
| 57 | + |
| 58 | +```yaml |
| 59 | +--- |
| 60 | +version: "2.1" |
| 61 | +services: |
| 62 | + airsonic: |
| 63 | + image: lscr.io/linuxserver/airsonic |
| 64 | + container_name: airsonic |
| 65 | + environment: |
| 66 | + - PUID=1000 |
| 67 | + - PGID=1000 |
| 68 | + - TZ=Europe/London |
| 69 | + - CONTEXT_PATH=<URL_BASE> #optional |
| 70 | + - JAVA_OPTS=<options> #optional |
| 71 | + volumes: |
| 72 | + - </path/to/config>:/config |
| 73 | + - </path/to/music>:/music |
| 74 | + - </path/to/playlists>:/playlists |
| 75 | + - </path/to/podcasts>:/podcasts |
| 76 | + - </path/to/other media>:/media #optional |
| 77 | + ports: |
| 78 | + - 4040:4040 |
| 79 | + devices: |
| 80 | + - /dev/snd:/dev/snd #optional |
| 81 | + restart: unless-stopped |
| 82 | +``` |
| 83 | +
|
| 84 | +### docker cli ([click here for more info](https://docs.docker.com/engine/reference/commandline/cli/)) |
| 85 | +
|
| 86 | +```bash |
| 87 | +docker run -d \ |
| 88 | + --name=airsonic \ |
| 89 | + -e PUID=1000 \ |
| 90 | + -e PGID=1000 \ |
| 91 | + -e TZ=Europe/London \ |
| 92 | + -e CONTEXT_PATH=<URL_BASE> `#optional` \ |
| 93 | + -e JAVA_OPTS=<options> `#optional` \ |
| 94 | + -p 4040:4040 \ |
| 95 | + -v </path/to/config>:/config \ |
| 96 | + -v </path/to/music>:/music \ |
| 97 | + -v </path/to/playlists>:/playlists \ |
| 98 | + -v </path/to/podcasts>:/podcasts \ |
| 99 | + -v </path/to/other media>:/media `#optional` \ |
| 100 | + --device /dev/snd:/dev/snd `#optional` \ |
| 101 | + --restart unless-stopped \ |
| 102 | + lscr.io/linuxserver/airsonic |
| 103 | +``` |
| 104 | + |
| 105 | +## Parameters |
| 106 | + |
| 107 | +Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container. |
| 108 | + |
| 109 | +### Ports (`-p`) |
| 110 | + |
| 111 | +| Parameter | Function | |
| 112 | +| :----: | --- | |
| 113 | +| `4040` | WebUI | |
| 114 | + |
| 115 | +### Environment Variables (`-e`) |
| 116 | + |
| 117 | +| Env | Function | |
| 118 | +| :----: | --- | |
| 119 | +| `PUID=1000` | for UserID - see below for explanation | |
| 120 | +| `PGID=1000` | for GroupID - see below for explanation | |
| 121 | +| `TZ=Europe/London` | Specify a timezone to use EG Europe/London. | |
| 122 | +| `CONTEXT_PATH=<URL_BASE>` | For setting url-base in reverse proxy setups. | |
| 123 | +| `JAVA_OPTS=<options>` | For passing additional java options. | |
| 124 | + |
| 125 | +### Volume Mappings (`-v`) |
| 126 | + |
| 127 | +| Volume | Function | |
| 128 | +| :----: | --- | |
| 129 | +| `/config` | Configuration file location. | |
| 130 | +| `/music` | Location of music. | |
| 131 | +| `/playlists` | Location for playlists to be saved to. | |
| 132 | +| `/podcasts` | Location of podcasts. | |
| 133 | +| `/media` | Location of other media. | |
| 134 | + |
| 135 | +### Device Mappings (`--device`) |
| 136 | + |
| 137 | +| Parameter | Function | |
| 138 | +| :-----: | --- | |
| 139 | +| `/dev/snd` | Only needed to pass your host sound device to Airsonic's Java jukebox player. | |
| 140 | + |
| 141 | +#### Miscellaneous Options |
| 142 | + |
| 143 | +| Parameter | Function | |
| 144 | +| :-----: | --- | |
| 145 | + |
| 146 | +## Environment variables from files (Docker secrets) |
| 147 | + |
| 148 | +You can set any environment variable from a file by using a special prepend `FILE__`. |
| 149 | + |
| 150 | +As an example: |
| 151 | + |
| 152 | +```bash |
| 153 | +-e FILE__PASSWORD=/run/secrets/mysecretpassword |
| 154 | +``` |
| 155 | + |
| 156 | +Will set the environment variable `PASSWORD` based on the contents of the `/run/secrets/mysecretpassword` file. |
| 157 | + |
| 158 | +## Umask for running applications |
| 159 | + |
| 160 | +For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional `-e UMASK=022` setting. |
| 161 | +Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up [here](https://en.wikipedia.org/wiki/Umask) before asking for support. |
| 162 | + |
| 163 | +## User / Group Identifiers |
| 164 | + |
| 165 | +When using volumes (`-v` flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user `PUID` and group `PGID`. |
| 166 | + |
| 167 | +Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic. |
| 168 | + |
| 169 | +In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below: |
| 170 | + |
| 171 | +```bash |
| 172 | + $ id username |
| 173 | + uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup) |
| 174 | +``` |
| 175 | + |
| 176 | +## Docker Mods |
| 177 | + |
| 178 | +[](https://mods.linuxserver.io/?mod=airsonic "view available mods for this container.") [](https://mods.linuxserver.io/?mod=universal "view available universal mods.") |
| 179 | + |
| 180 | +We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above. |
| 181 | + |
| 182 | +## Support Info |
| 183 | + |
| 184 | +* Shell access whilst the container is running: |
| 185 | + * `docker exec -it airsonic /bin/bash` |
| 186 | +* To monitor the logs of the container in realtime: |
| 187 | + * `docker logs -f airsonic` |
| 188 | +* Container version number |
| 189 | + * `docker inspect -f '{{ index .Config.Labels "build_version" }}' airsonic` |
| 190 | +* Image version number |
| 191 | + * `docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/airsonic` |
| 192 | + |
| 193 | +## Versions |
| 194 | + |
| 195 | +* **13.01.22:** - Deprecate in favor of airsonic-advanced. |
| 196 | +* **24.03.19:** - Switching to new Base images, shift to arm32v7 tag. |
| 197 | +* **26.01.19:** - Add pipeline logic and multi arch. |
| 198 | +* **05.01.19:** - Linting fixes. |
| 199 | +* **27.08.18:** - Use new inhouse java baseimage for quicker builds. |
| 200 | +* **23.08.18:** - Rebase to ubuntu bionic for increased performance across all arch's. |
| 201 | +* **22.04.18:** - Add the forgotten JAVA_OPTS to the run command. |
| 202 | +* **29.12.17:** - Initial Release. |
0 commit comments