Skip to content

Commit

Permalink
chore: add Docker image
Browse files Browse the repository at this point in the history
See #156, thanks @odiroot
  • Loading branch information
devgianlu committed Jan 1, 2025
1 parent 4952771 commit 2ec7994
Show file tree
Hide file tree
Showing 4 changed files with 111 additions and 0 deletions.
72 changes: 72 additions & 0 deletions .github/workflows/docker.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
name: Publish Docker image

on:
push:
tags: [ 'v*' ]
branches: [ "master" ]
pull_request:
branches: [ 'master' ]

env:
REGISTRY: ghcr.io
IMAGE_NAME: ${{ github.repository }}

jobs:
build:
runs-on: ubuntu-latest
permissions:
contents: read
packages: write
id-token: write

steps:
- name: Checkout repository
uses: actions/checkout@v4

# Install the cosign tool except on PR
- name: Install cosign
if: github.event_name != 'pull_request'
uses: sigstore/cosign-installer@59acb6260d9c0ba8f4a2f9d9b48431a222b68e20 #v3.5.0
with:
cosign-release: 'v2.2.4'

# Set up BuildKit Docker container builder to be able to build
# multi-platform images and export cache
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@f95db51fddba0c2d1ec667646a06c2ce06100226 # v3.0.0

# Login against a Docker registry except on PR
- name: Log into registry ${{ env.REGISTRY }}
if: github.event_name != 'pull_request'
uses: docker/login-action@343f7c4344506bcbf9b4de18042ae17996df046d # v3.0.0
with:
registry: ${{ env.REGISTRY }}
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}

# Extract metadata (tags, labels) for Docker
- name: Extract Docker metadata
id: meta
uses: docker/metadata-action@96383f45573cb7f253c731d3b3ab81c87ef81934 # v5.0.0
with:
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}

# Build and push Docker image with Buildx (don't push on PR)
- name: Build and push Docker image
id: build-and-push
uses: docker/build-push-action@0565240e2d4ab88bba5387d719585280857ece09 # v5.0.0
with:
context: .
push: ${{ github.event_name != 'pull_request' }}
tags: ${{ steps.meta.outputs.tags }}
labels: ${{ steps.meta.outputs.labels }}
cache-from: type=gha
cache-to: type=gha,mode=max

# Sign the resulting Docker image digest except on PRs.
- name: Sign the published Docker image
if: ${{ github.event_name != 'pull_request' }}
env:
TAGS: ${{ steps.meta.outputs.tags }}
DIGEST: ${{ steps.build-and-push.outputs.digest }}
run: echo "${TAGS}" | xargs -I {} cosign sign --yes {}@${DIGEST}
19 changes: 19 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
FROM alpine:3.20 AS build

RUN apk -U --no-cache add go alsa-lib-dev libogg-dev libvorbis-dev

WORKDIR /src

COPY go.mod go.sum ./
RUN go mod download

COPY . .
RUN go build -v ./cmd/daemon

FROM alpine:3.20

RUN apk -U --no-cache add libpulse avahi libgcc gcompat alsa-lib

COPY --from=build /src/daemon /usr/bin/go-librespot

CMD ["/usr/bin/go-librespot", "--config_dir", "/config"]
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,13 @@ the [latest release](https://github.com/devgianlu/go-librespot/releases/latest).
Development prebuilt binaries are also available
as [GitHub Actions artifacts](https://github.com/devgianlu/go-librespot/blob/249b8fee709e2d08fe9c39a16ad0fc4b737cb967/.github/workflows/release.yml#L62).

### Using Docker

A lightweight Docker image for go-librespot is available
on the [GitHub Container Registry](https://github.com/devgianlu/go-fileshare/pkgs/container/go-fileshare).

An example Docker Compose configuration for PulseAudio is available [here](/docker-compose.pulse.yml).

### Building from source

To build from source the following prerequisites are necessary:
Expand Down
13 changes: 13 additions & 0 deletions docker-compose.pulse.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
services:
daemon:
image: ghcr.io/devgianlu/go-librespot
build: .
network_mode: host
userns_mode: keep-id
volumes:
- ~/.config/go-librespot:/config
- ~/.config/pulse/cookie:/pulse_cookie:ro
- /run/user/1000/pulse/native:/pulse_native # Replace 1000 with your UID
environment:
PULSE_SERVER: "unix:/pulse_native"
PULSE_COOKIE: "/pulse_cookie"

0 comments on commit 2ec7994

Please sign in to comment.