with this project you can point a TRMNL (https://usetrmnl.com) device to your own server, either in the cloud or on your local network.
requirements
- TRMNL device
- TRMNL firmware (forked with new base url - your server)
- Ruby installed on your machine (or Docker)
quickstart
cp dotenv-sample .env # (and edit to set the appropriate variables)
bundle # installs gems/libs
rake db:setup # creates db + Devices table
ruby app.rb # runs server, visit http://localhost:4567/devices/new
docker-based setup You may optionally edit the Dockerfile to enable sqlite.
cp dotenv-sample .env # (and edit to set the appropriate variables)
docker build -t trmnl_byos -f Dockerfile .
docker run --name trmnl -p 4567:4567 trmnl_byos
debugging / building
first access the console: rake console
Device.count # => 0 (interact with db object via ActiveRecord ORM)
ScreenFetcher.call # fetches upcoming render, sorts desc by created timestamp
ScreenGenerator.new("<p>Some HTML here</p>").process # => creates img in /public/images/generated
deploying
on your local network:
- set
BASE_URLinside the file.envto where this is hosted (eghttp://192.168.x.x:4567, no trailing slash) - run app in production mode (
ruby app.rb) - retrieve your machine's local IP, ex 192.168.x.x (Mac:
ifconfig | grep "inet " | grep -Fv 127.0.0.1 | awk '{print $2}') - confirm it works by visiting
http://192.168.x.x:4567/devicesfrom any device also on the network - point your forked FW's
API_BASE_URL(source) to same value asBASE_URL
in the cloud:
TBD