Feature: Dockerize project

* Added Dockerfile to build project
* Added docker-compose.yml for easy container orchestration
* Added helper shell script docker_start.sh to easily start and attach the container.
* Added dockerignore file to avoid over-including files.
* Minor update to README to include docker information.

.dockerignore

@@ -0,0 +1,2 @@
+docker-compose.yml
+Dockerfile

.editorconfig

@@ -8,3 +8,7 @@ indent_size = 4
 
 [*.rs]
 indent_size = 2
+
+[*.yml]
+indent_size = 2
+indent_style = space

Dockerfile

@@ -0,0 +1,18 @@
+FROM rust:1.76-bookworm
+
+RUN \
+	apt update && \
+	apt install -y pulseaudio && \
+	apt-get clean autoclean && \
+	rm -rf /var/lib/{apt,dpkg,cache,log}/ && \
+	mkdir /app && chown 1000:1000 /app
+
+WORKDIR /app
+USER 1000
+
+COPY --chown=1000:1000 . /app
+
+RUN cargo build
+
+ENTRYPOINT ["/app/target/release/scope-tui"]
+CMD ["pulse"]

README.md

@@ -60,6 +60,22 @@ The audio buffer size directly impacts resource usage, latency and refresh rate
 
 To change audio buffer size, the PulseAudio client must be restarted. Because of this, such option is configurable only at startup.
 
+## Docker Compose
+
+Included is a simple `Dockerfile` to build the project, and an accompanying `docker-compose.yml` to orchestrate starting the container with the proper volume mounts and environment variables.
+
+Also included is a helper shell script to launch the container, attach to the container instance, and destroy the container on exiting.
+
+```sh
+docker compose up -d
+docker attach scope_tui
+docker compose down
+
+# OR
+
+./docker_start.sh
+```
+
 ## Controls
 * Use `q` or `CTRL+C` to exit
 * Use `s` to toggle scatter mode
@@ -104,6 +120,7 @@ Some features I plan to work on and would like to add:
  * [x] Multiple channels
  * [x] Spectroscope
  * [x] File source
+ * [x] Dockerize
  * [ ] Mac audio sources
  * [ ] Windows audio sources
  * [ ] Improve file audio source

docker-compose.yml

@@ -0,0 +1,15 @@
+version: "3.8"
+
+services:
+  scope_tui:
+    container_name: scope_tui
+    # command: ["--scatter", "pulse"] # Example of customizing options
+    image: scope_tui
+    build: .
+    stdin_open: true
+    tty: true
+    environment:
+      - PULSE_SERVER=unix:${XDG_RUNTIME_DIR}/pulse/native
+    volumes:
+      - ${XDG_RUNTIME_DIR}/pulse/native:${XDG_RUNTIME_DIR}/pulse/native
+      - ~/.config/pulse/cookie:/.config/pulse/cookie

docker_start.sh

@@ -0,0 +1,7 @@
+#!/bin/sh
+
+docker compose up -d
+
+docker attach scope_tui
+
+docker compose down