mirror of
https://github.com/usetrmnl/byos_laravel.git
synced 2026-01-13 15:07:49 +00:00
DIY server in PHP/Laravel for self hosted screen generation.
715e6a2562
* feat: autojoin toggle * feat: auto add devices * feat: proxy feature * feat: support puppeteer in docker * feat: toggle to activate cloud proxy * feat: relay device information * feat: relay logs to cloud * feat: migrate on start * feat: calculate battery state, wifi signal * feat: eye candy for configure view * feat: update via api |
||
|---|---|---|
| .github | ||
| app | ||
| bootstrap | ||
| config | ||
| database | ||
| docker | ||
| public | ||
| resources | ||
| routes | ||
| storage | ||
| tests | ||
| .dockerignore | ||
| .editorconfig | ||
| .env.example | ||
| .gitattributes | ||
| .gitignore | ||
| artisan | ||
| composer.json | ||
| composer.lock | ||
| docker-compose.yml | ||
| Dockerfile | ||
| example.png | ||
| LICENSE.md | ||
| package-lock.json | ||
| package.json | ||
| phpunit.xml | ||
| README.md | ||
| README_byos-screenshot.png | ||
| vite.config.js | ||
Laravel Trmnl Server
This is a PoC of a TRMNL server, written in Laravel. Inspired by https://github.com/usetrmnl/byos_sinatra
Requirements
- PHP >= 8.2
- ext-imagick
- puppeteer see Browsershot docs
Installation
Clone the repository
git clone git@github.com:bnussbau/laravel-trmnl-server.git
Copy environment file
cp .env.example .env
php artisan key:generate
Install dependencies
composer install
npm i
Run migrations
php artisan migrate --seed
Run the server
To make your server accessible in the network, you can run the following command:
php artisan serve --host=0.0.0.0 --port 4567
Usage
If your environment is local, you can access the server at http://localhost:4567 and login with user / password
admin@example.com / admin@example.com
Add your TRMNL Device
- Add new device
- You can grab the TRMNL Mac Address and API Key from the TRMNL Dashboard. Or debug the incoming request to
/api/setupto determine.
Flash Firmware to point Device to your server
See this YouTube guide: https://www.youtube.com/watch?v=3xehPW-PCOM
Generate Screen
- Edit resources/views/trmnl.blade.php
- To generate the screen, run
php artisan trmnl:screen:generate
License
MIT