Documentation
Getting Started
Learn how to set up WeDisplay, pair your first screen, and start managing content in minutes.
Quick Start
1. Register an account
Head to the registration page and create your account. Once confirmed you will be taken straight to the dashboard.
2. Pair a screen
Open the player URL (/player) on the device you want to use as a display. A 6-digit pairing code will appear. Enter that code in the dashboard under "Screens" to pair the device.
3. Create a playlist
Navigate to Playlists and create a new playlist. Add media items — images, videos, or web URLs — and arrange them in the order you want.
4. Assign content
Go back to Screens, select the screen you paired, and assign the playlist. The content will begin playing on the device within seconds.
Screen Pairing
WeDisplay uses a simple code-based pairing flow. When a device loads the /player page for the first time, it generates a unique device ID stored in the browser and requests a 6-digit pairing code from the server.
In the dashboard, navigate to Screens and click Pair Screen. Enter the 6-digit code along with a friendly name for the screen. The server clears the pairing code and associates the device with your account. The player detects the change within a few seconds and starts displaying assigned content.
If a screen is unpaired or the code expires, simply refresh the player page to generate a new code.
Content Management
The Media Library is where all your assets live. Upload images (JPEG, PNG, WebP, GIF) and videos (MP4, WebM) directly from the dashboard. Each file is stored locally and served through a secure API route that prevents directory traversal.
Playlists group media items together and define the playback order and duration for each item. You can create as many playlists as your plan allows and reuse the same media across multiple playlists.
Schedules let you control when a playlist is active on a given screen. Set start and end times, choose days of the week, and the player will automatically switch content based on the schedule.
API Reference
WeDisplay exposes a RESTful API under /api for programmatic access. Detailed endpoint documentation is coming soon. In the meantime, the key resource routes are:
- GET / POST /api/sources — list and create content sources
- GET / PUT / DELETE /api/sources/:id — manage a single source
- GET / POST /api/playlists — list and create playlists
- GET / PUT / DELETE /api/playlists/:id — manage a single playlist
- GET / POST /api/layouts — list and create layouts
- GET / PUT / DELETE /api/layouts/:id — manage a single layout
- GET / POST /api/schedules — list and create schedules
- GET / PUT / DELETE /api/schedules/:id — manage a single schedule
- GET / POST /api/player/pair — pairing flow for screens