├── .github └── workflows │ └── docker-publish.yml ├── Dockerfile ├── LICENSE ├── README.md ├── config.toml ├── docker-compose.yml └── source.Dockerfile /.github/workflows/docker-publish.yml: -------------------------------------------------------------------------------- 1 | name: Publish Docker image 2 | 3 | on: 4 | push: 5 | branches: 6 | - master 7 | - testing 8 | pull_request: 9 | branches: 10 | - master 11 | 12 | env: 13 | REGISTRY: docker.io 14 | IMAGE_NAME: librespot-java 15 | 16 | jobs: 17 | build: 18 | 19 | runs-on: ubuntu-latest 20 | permissions: 21 | contents: read 22 | packages: write 23 | 24 | steps: 25 | - name: Checkout repository 26 | uses: actions/checkout@v3 27 | with: 28 | fetch-depth: 0 29 | 30 | - name: Set up QEMU 31 | uses: docker/setup-qemu-action@v1 32 | 33 | - name: Setup Docker Buildx 34 | uses: docker/setup-buildx-action@v2 35 | 36 | - name: Log into Docker Hub 37 | uses: docker/login-action@v2 38 | with: 39 | username: ${{ secrets.DH_USER }} 40 | password: ${{ secrets.DH_TOKEN }} 41 | 42 | - name: Extract Docker metadata 43 | id: meta 44 | uses: docker/metadata-action@v4 45 | with: 46 | images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }} 47 | 48 | - name: Build and push Docker image 49 | id: build-and-push 50 | uses: docker/build-push-action@v3 51 | with: 52 | context: . 53 | push: ${{ github.event_name != 'pull_request' }} 54 | platforms: linux/amd64,linux/arm64 55 | tags: docker.io/${{ secrets.DH_USER }}/${{ env.IMAGE_NAME }}:latest 56 | labels: ${{ steps.meta.outputs.labels }} -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM maven:latest as builder 2 | 3 | ARG LIBRESPOT_JAVA_VERSION=1.6.5 4 | 5 | RUN apt-get update \ 6 | && apt-get install -yq wget unzip 7 | 8 | WORKDIR /root 9 | RUN wget https://github.com/librespot-org/librespot-java/archive/refs/tags/v$LIBRESPOT_JAVA_VERSION.zip \ 10 | && unzip v*.zip \ 11 | && cd librespot* \ 12 | && mvn clean package 13 | 14 | FROM alpine:latest as final 15 | 16 | RUN apk -U add dumb-init openjdk17-jre alsa-utils 17 | 18 | COPY --from=builder /root/librespot*/player/target/librespot-player-*.jar /librespot 19 | COPY config.toml /config/ 20 | 21 | VOLUME /config 22 | WORKDIR /config 23 | 24 | ENTRYPOINT ["dumb-init", "java", "-jar", "/librespot"] 25 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright 2022 Agneev Mukherjee 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # librespot-java-docker 2 | 3 | Dockerfiles and image for [librespot-java](https://github.com/librespot-org/librespot-java) with alsa backend. 4 | 5 | > librespot-java is a port of [librespot](https://github.com/librespot-org/librespot), originally written in Rust, which has evolved into the most up-to-date open-source Spotify client. 6 | 7 | ## Deploy image 8 | 9 | Pull and deploy (multiarch) image in a Docker container: 10 | 11 | ```text 12 | docker run -d --network host agneev/librespot-java 13 | ``` 14 | 15 | ### Using Docker Compose 16 | 17 | ```sh 18 | git clone https://github.com/agneevX/librespot-java-docker 19 | 20 | cd librespot-java-docker 21 | docker compose up -d 22 | ``` 23 | 24 | To pull the image only, run: 25 | 26 | ```text 27 | docker pull agneev/librespot-java 28 | ``` 29 | 30 | ### Build from source 31 | 32 | This compiles from the latest code in the `master` branch of `librespot-java`. 33 | 34 | ```sh 35 | git clone https://github.com/agneevX/librespot-java-docker 36 | 37 | docker build . -f ./source.Dockerfile -t librespot-java:master 38 | 39 | docker run -d --network host librespot-java:master 40 | ``` 41 | 42 | ## Configuration 43 | 44 | The main config file is available in `./user-data/config.toml`. Settings such as device name or sound quality can be customized here. 45 | 46 | librespot-java documentation available [here](https://github.com/librespot-org/librespot-java/blob/dev/player/README.md). 47 | 48 | For audio output, I've set `player.mixerSearchKeywords` to `plughw:0,0` on the Raspberry Pi 4, so it's able to output properly. 49 | 50 | ## Network mode and auth 51 | 52 | By default, the compose files use host networking (not available on Windows) so that devices in the LAN are able to connect (although there's a delay). 53 | 54 | Connecting to a Spotify Premium account is recommended. The docs is linked above. 55 | 56 | When connected, `network_mode: host` can be removed in the compose file and brought up. 57 | 58 | -------------------------------------------------------------------------------- /config.toml: -------------------------------------------------------------------------------- 1 | deviceId = "" ### Device ID (40 chars, leave empty for random) ### 2 | deviceName = "librespot-java" ### Device name ### 3 | deviceType = "SPEAKER" ### Device type (COMPUTER, TABLET, SMARTPHONE, SPEAKER, TV, AVR, STB, AUDIO_DONGLE, GAME_CONSOLE, CAST_VIDEO, CAST_AUDIO, AUTOMOBILE, WEARABLE, UNKNOWN_SPOTIFY, CAR_THING, UNKNOWN) ### 4 | preferredLocale = "en" ### Preferred locale ### 5 | logLevel = "INFO" ### Log level (OFF, FATAL, ERROR, WARN, INFO, DEBUG, TRACE, ALL) ### 6 | 7 | [auth] ### Authentication ### 8 | strategy = "ZEROCONF" # Strategy (USER_PASS, ZEROCONF, BLOB, FACEBOOK, STORED) 9 | username = "" # Spotify username (BLOB, USER_PASS only) 10 | password = "" # Spotify password (USER_PASS only) 11 | blob = "" # Spotify authentication blob Base64-encoded (BLOB only) 12 | storeCredentials = false # Whether to store reusable credentials on disk (not a plain password) 13 | credentialsFile = "credentials.json" # Credentials file (JSON) 14 | 15 | [zeroconf] ### Zeroconf ### 16 | listenPort = -1 # Listen on this TCP port (`-1` for random) 17 | listenAll = true # Listen on all interfaces (overrides `zeroconf.interfaces`) 18 | interfaces = "" # Listen on these interfaces (comma separated list of names) 19 | 20 | [cache] ### Cache ### 21 | enabled = false 22 | dir = "./cache/" 23 | doCleanUp = true 24 | 25 | [network] ### Network ### 26 | connectionTimeout = 10 # If ping isn't received within this amount of seconds, reconnect 27 | 28 | [preload] ### Preload ### 29 | enabled = true # Preload enabled 30 | 31 | [time] ### Time correction ### 32 | synchronizationMethod = "NTP" # Time synchronization method (NTP, PING, MELODY, MANUAL) 33 | manualCorrection = 0 # Manual time correction in millis 34 | 35 | [player] ### Player ### 36 | autoplayEnabled = true # Autoplay similar songs when your music ends 37 | preferredAudioQuality = "VERY_HIGH" # Preferred audio quality (NORMAL, HIGH, VERY_HIGH) 38 | enableNormalisation = true # Whether to apply the Spotify loudness normalisation 39 | normalisationPregain = +3.0 # Normalisation pregain in decibels (loud at +6, normal at +3, quiet at -5) 40 | initialVolume = 24576 # Initial volume (0-65536) 41 | volumeSteps = 16 # Number of volume notches 42 | logAvailableMixers = true # Log available mixers 43 | mixerSearchKeywords = "" # Mixer/backend search keywords (semicolon separated) 44 | crossfadeDuration = 0 # Crossfade overlap time (in milliseconds) 45 | output = "MIXER" # Audio output device (MIXER, PIPE, STDOUT, CUSTOM) 46 | outputClass = "" # Audio output Java class name 47 | releaseLineDelay = 20 # Release mixer line after set delay (in seconds) 48 | pipe = "" # Output raw (signed) PCM to this file (`player.output` must be PIPE) 49 | retryOnChunkError = true # Whether the player should retry fetching a chuck if it fails 50 | metadataPipe = "" # Output metadata in Shairport Sync format (https://github.com/mikebrady/shairport-sync-metadata-reader) 51 | bypassSinkVolume = false # Whether librespot-java should ignore volume events, sink volume is set to the max 52 | localFilesPath = "" # Where librespot-java should search for local files 53 | 54 | [api] ### API ### 55 | port = 24879 # API port (`api` module only) 56 | host = "0.0.0.0" # API listen interface (`api` module only) 57 | 58 | [proxy] ### Proxy ### 59 | enabled = false # Whether the proxy is enabled 60 | type = "HTTP" # The proxy type (HTTP, SOCKS) 61 | ssl = false # Connect to proxy using SSL (HTTP only) 62 | address = "" # The proxy hostname 63 | port = 0 # The proxy port 64 | auth = false # Whether authentication is enabled on the server 65 | username = "" # Basic auth username 66 | password = "" # Basic auth password 67 | 68 | [shell] ### Shell ### 69 | enabled = false # Shell events enabled 70 | executeWithBash = false # Execute the command with `bash -c` 71 | onContextChanged = "" 72 | onTrackChanged = "" 73 | onPlaybackEnded = "" 74 | onPlaybackPaused = "" 75 | onPlaybackResumed = "" 76 | onTrackSeeked = "" 77 | onMetadataAvailable = "" 78 | onVolumeChanged = "" 79 | onInactiveSession = "" 80 | onPanicState = "" 81 | onConnectionDropped = "" 82 | onConnectionEstablished = "" 83 | onStartedLoading = "" 84 | onFinishedLoading = "" -------------------------------------------------------------------------------- /docker-compose.yml: -------------------------------------------------------------------------------- 1 | version: '2.1' 2 | 3 | services: 4 | 5 | librespot: 6 | container_name: librespot 7 | image: agneev/librespot-java 8 | restart: unless-stopped 9 | network_mode: host 10 | volumes: 11 | - ./user-data:/config 12 | devices: 13 | - /dev/snd:/dev/snd 14 | -------------------------------------------------------------------------------- /source.Dockerfile: -------------------------------------------------------------------------------- 1 | FROM maven:latest as builder 2 | 3 | RUN cd /root \ 4 | && git clone https://github.com/librespot-org/librespot-java \ 5 | && cd librespot-java \ 6 | && mvn clean package 7 | 8 | FROM alpine:latest as final 9 | 10 | RUN apk -U add \ 11 | dumb-init \ 12 | openjdk17-jre \ 13 | alsa-utils 14 | 15 | COPY --from=builder /root/librespot-java/player/target/librespot-player-*.jar /app/player.jar 16 | COPY config.toml /config/ 17 | 18 | VOLUME /config 19 | WORKDIR /config 20 | 21 | ENTRYPOINT ["dumb-init", "java", "-jar", "/app/player.jar"] 22 | --------------------------------------------------------------------------------