readme-vars.yml

---

# project information
project_name: airsonic
project_url: "https://github.com/airsonic/airsonic"
project_logo: "https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/airsonic-banner.png"
project_blurb: "[{{ project_name|capitalize }}]({{ project_url }}) 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."
project_lsio_github_repo_url: "https://github.com/linuxserver/docker-{{ project_name }}"
project_blurb_optional_extras_enabled: false

project_deprecation_status: true
project_deprecation_message: |
  We recommend our airsonic-advanced image instead:
  https://github.com/linuxserver/docker-airsonic-advanced

# supported architectures
available_architectures:
  - { arch: "{{ arch_x86_64 }}", tag: "amd64-latest"}
  - { arch: "{{ arch_arm64 }}", tag: "arm64v8-latest"}
  - { arch: "{{ arch_armhf }}", tag: "arm32v7-latest"}

# development version
development_versions: false

# container parameters
common_param_env_vars_enabled: true
param_container_name: "{{ project_name }}"
param_usage_include_net: false
param_usage_include_env: true
param_env_vars:
  - { env_var: "TZ", env_value: "Europe/London", desc: "Specify a timezone to use EG Europe/London." }
param_usage_include_vols: true
param_volumes:
  - { vol_path: "/config", vol_host_path: "</path/to/config>", desc: "Configuration file location." }
  - { vol_path: "/music", vol_host_path: "</path/to/music>", desc: "Location of music." }
  - { vol_path: "/playlists", vol_host_path: "</path/to/playlists>", desc: "Location for playlists to be saved to." }
  - { vol_path: "/podcasts", vol_host_path: "</path/to/podcasts>", desc: "Location of podcasts." }
param_usage_include_ports: true
param_ports:
  - { external_port: "4040", internal_port: "4040", port_desc: "WebUI" }
param_device_map: false
cap_add_param: false

# optional container parameters
opt_param_usage_include_env: true
opt_param_env_vars:
  - { env_var: "CONTEXT_PATH", env_value: "<URL_BASE>", desc: "For setting url-base in reverse proxy setups." }
  - { env_var: "JAVA_OPTS", env_value: "<options>", desc: "For passing additional java options." }
opt_param_usage_include_vols: true
opt_param_volumes:
  - { vol_path: "/media", vol_host_path: "</path/to/other media>", desc: "Location of other media." }
opt_param_usage_include_ports: false
opt_param_device_map: true
opt_param_devices:
  - { device_path: "/dev/snd", device_host_path: "/dev/snd", desc: "Only needed to pass your host sound device to Airsonic's Java jukebox player." }
opt_cap_add_param: false
optional_block_1: false

# application setup block
app_setup_block_enabled: true
app_setup_block: |
  Access WebUI at `<your-ip>:4040`.

  Default user/pass is admin/admin

  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.

  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`).

# changelog
changelogs:
  - { date: "13.01.22:", desc: "Deprecate in favor of airsonic-advanced." }
  - { date: "24.03.19:", desc: "Switching to new Base images, shift to arm32v7 tag." }
  - { date: "26.01.19:", desc: "Add pipeline logic and multi arch." }
  - { date: "05.01.19:", desc: "Linting fixes." }
  - { date: "27.08.18:", desc: "Use new inhouse java baseimage for quicker builds." }
  - { date: "23.08.18:", desc: "Rebase to ubuntu bionic for increased performance across all arch's." }
  - { date: "22.04.18:", desc: "Add the forgotten JAVA_OPTS to the run command." }
  - { date: "29.12.17:", desc: "Initial Release." }