LocalPaper

Illustration

Simple local server for eInk display devices. Most specifically, anything compatible with TRMNL firmware.

Intention of the project is to have fully locally controlled setup with no direct connection to the external world. Thus, no integration with Google calendar, or any other data source that requires authentication is planned. That said, since files are plain, you can build that integration yourself if you so desire.

Screen is updated every 5 minutes (configurable) so you also don’t want to rely on it for any real-time data.

Running

You can then run it locally using something like this:

docker run --rm -it -v ./example:/config --network=host medo64/localpaper:latest

Alternatively, you can use compose.yaml

Configuration

The following environment variables can further configure the system:

VariableDefaultDescription
DEFAULT_TTL90Default TTL to use when sending responses
IPanyList of comma-separated IP addresses to bind to
MINIMUM_TTL60Minimum TTL when learning hosts from responses; will apply even for 0 TTLs
NO_HOSTSfalseIf set to true, mDNS will not read /etc/hosts file
NO_LEARNfalseIf set to true, mDNS will not learn from observed network responses
PREFER_LEARNEDfalseIf set to true, IP response will be ordered to prefer learned addresses

The following environment variables are for troubleshooting purposes and usually require no configuration:

VariableDefaultDescription
LOG_LEVELInformationOne of log levels: Verbose, Debug, Information, Warning, Error, Fatal
USE_INOPERABLE_INTERFACESfalseIf true, engine will also use interfaces that are reported inoperable
USE_UNSUPPORTED_INTERFACESfalseIf true, engine will also use interfaces that don’t support multicast
Dockerhub

Docker pull command:
docker pull medo64/localpaper
GitHub Repository (MIT License)

Clone repository:
git clone https://github.com/Medo64/LocalPaper.git