bun installCreate and deploy the Edge App:
screenly edge-app create --name welcome-app --in-place
bun run deploy
screenly edge-app instance createPushes to main start a stage deploy, which waits for approval. To release to production, tag a commit on main and push the tag (the workflow refuses tags not on main); the production deploy also waits for approval:
git checkout main && git pull
git tag v26.10.0
git push origin v26.10.0Then publish a GitHub Release whose notes list the pull requests merged since the previous release. Add --draft to review the notes before publishing:
gh release create v26.10.0 --verify-tag --generate-notes --title v26.10.0The app accepts the following settings via screenly.yml:
| Setting | Description | Type | Default |
|---|---|---|---|
enable_analytics |
Enable or disable Sentry and Google Analytics integrations | optional | true |
mode |
Layout for where the screen is placed: lobby (logo and date header) or poster (message only) |
optional | lobby |
override_locale |
Override the default locale with a supported language code (e.g., en_US, fr_FR, de_DE) |
optional | en |
override_timezone |
Override the default timezone with a supported timezone identifier (e.g., Europe/London, America/New_York). Defaults to the system timezone if left blank |
optional | - |
tag_manager_id |
Google Tag Manager container ID to enable tracking and analytics | optional | GTM-P98SPZ9Z |
welcome_heading |
Heading text displayed as the welcome message title | required | Welcome |
welcome_message |
Body text displayed as the welcome message content | required | to the team |
bun install # Install dependencies
bun run dev # Start development serverbun run build # Build for productionbun run lint # Lint and auto-fix
bun run format # Format source filesbun test # Run unit testsGenerate screenshots at all supported resolutions:
bun run screenshotsScreenshots are saved to the screenshots/ directory.
