39 lines
2.0 KiB
Markdown
39 lines
2.0 KiB
Markdown
# Pulse Signage
|
|
|
|
Pulse Signage is a self-hosted digital signage platform for teams that want clear, reliable control over the content on every screen.
|
|
|
|
It gives you one place to publish playlists, slides, announcements, and live updates without handing the workflow to a third-party service.
|
|
|
|
## What It Can Do
|
|
|
|
- Run polished screen experiences with playlists, slides, and reusable templates.
|
|
- Keep announcements, schedules, RSS feeds, API content, and other live data in sync.
|
|
- Manage many screens from a single dashboard.
|
|
- Support everyday signage, event messages, lobbies, dashboards, and other always-on displays.
|
|
- Keep the player, dashboard, and bridge connected so updates move quickly and consistently.
|
|
|
|
## Why It Fits
|
|
|
|
- It keeps signage under your own control.
|
|
- It is built for teams that need screens to stay current without extra manual work.
|
|
- It works well for offices, venues, campuses, and operations teams.
|
|
- It stays focused on display management instead of trying to be a general-purpose CMS.
|
|
|
|
## Deploying
|
|
|
|
Docker Compose is the recommended way to deploy Pulse Signage. It keeps the web app, player, bridge, and database together in a predictable setup.
|
|
|
|
If you want the details, start with the [Compose guide](docker-compose/README.md).
|
|
|
|
## Docs
|
|
|
|
- [Documentation home](docs/README.md) - the technical reference index.
|
|
- [API reference](docs/api.md) - the player HTTP surface and onboarding endpoints.
|
|
- [Database schema](docs/schema.md) - the tables and data model the app maintains.
|
|
- [WebSocket reference](docs/websocket.md) - the live player and snapshot channels.
|
|
- [Compose guide](docker-compose/README.md) - deployment options and service layout.
|
|
- [Changelog](CHANGELOG.md) - release history and notable changes.
|
|
|
|
## Explore The Docs
|
|
|
|
The project includes a dashboard for managing content, a player runtime for rendering screens, an onboarding flow for connecting devices, and a bridge layer for remote screens. If you want to understand how the pieces fit together, the docs above cover the technical details without repeating the project overview. |