Skip to content

Latest commit

 

History

History
35 lines (24 loc) · 1.23 KB

README.md

File metadata and controls

35 lines (24 loc) · 1.23 KB
Raw

KlipperScreen Remote

Based on mkuf's brilliant prind project.

KlipperScreen for headless environments.

What is it?

This container image allows you to easily run KlipperScreen in a headless environment, while being able to connect to it remotely using X11 forwarding.

What's the difference between this and prind?

While this project is technically a fork of prind's KlipperScreen implementation, there are a few key differences:

  • Designed specifically for headless environments, rendering KlipperScreen on a remote X11 server (such as XServer XSDL on Android)
  • Automatic restarting of KlipperScreen on failure (user configurable)
  • (more changes are planned for future releases)

How do I use this?

docker \
  run \
    -it \
    --rm \
    --name klipperscreen-remote \
    -v $(PWD)/klipperscreen.sample.conf:/opt/klipperscreen/config/klipperscreen.conf \
    -e DISPLAY="192.168.0.221:0" \
    -e PULSE_SERVER="tcp:192.168.0.221:4713" \
  didstopia/klipperscreen-remote:latest

License

See LICENSE.