Home
XtreamUIPro

Setup guide

Residential Communities setup guide

Configure the platform as the television service of a residential community: a line-up per kind of home, a node per building, a line per apartment and an information channel of the management company.

These guides map an industry's concepts onto the objects the platform has today (bouquets, lines, packages, partner accounts, nodes, the API). They are conceptual mappings, not industry-specific features, and a partner account is a delegated account, not an isolated tenant.

Conceptual mapping

Nothing in the panel is called an apartment or a resident. The table says which object plays which role; the chapters below set them up in that order.

In your industryOn the platformWhere in the panel
Property manager accountPartner account (reseller): a delegated dashboard with credits, permissions and its own linesUsers → add a reseller; Groups for its permissions
Channel line-upBouquet: a named set of channels, films or series that a package grantsBouquets, from Streams and Movies / Series
Channel or information channelLive channel: a stream with its sources, EPG and output formatsStreams → add a live stream (source URL or RTMP push)
Welcome and notice videosVOD catalogue: movies and series with seasons and episodes, categories and metadataMovies and Series, or the VOD ingest job
Apartment accessLine: one access with its package, bouquets, expiry, connection limit and outputsLines → add, or activation codes, or the Reseller API
Lease or occupancy periodExpiry date of the line, renewed by a package, a credit or the APIThe line's expiry date and the package's duration
Building nodeStreaming nodes: edge servers enrolled from the panel, one per site or buildingServers → add a node, installed over SSH

Prerequisites

What to have before installing.

  1. A server for the management company (Ubuntu 22.04 or 24.04), the installer, and a server for each building that can reach the residents' network.
  2. The channel feeds the community may retransmit (pull URLs or RTMP), the management company's notices and welcome videos, and the residents' devices (set-top boxes, smart TVs with a player app, or a browser).
  3. A decision on the kinds of home (standard, senior, student), and who in the management company opens and renews the lines.

Infrastructure deployment

The central server, then a node per building.

  1. Run the installer on the central server and set the playback base URL to an address the buildings can reach.
  2. Add the channel feeds under Streams and the notices under Movies, and check them in the web player.
  3. Enrol a node per building from Servers; the panel installs it over SSH, or the node enrols with a one-time code, and routes that building's residents to it.
  4. Add the property manager under Users → add a reseller, with a group that allows lines and no catalogue changes.

Content organisation

Line-ups per kind of home.

  1. Create one bouquet per line-up from the channels of each kind of home, and a bouquet for the management company's information.
  2. Add the information bouquet to every package so each resident receives the notices.
  3. Create one package per kind of home with its bouquets and a duration that matches the lease or the occupancy period.
  4. Order the channels and give them logos so the menu on the television reads well.

Partner (reseller) configuration

The property manager as a delegated account.

  1. Create a group with permissions limited to lines, with no access to the catalogue or the servers.
  2. Add each property manager as a reseller with that group, the packages of their homes and a credit balance.
  3. A manager of several buildings can add a sub-reseller per building, each with its own homes and credits.

Apartment (line) configuration

One line per apartment, named by its number.

  1. Create one line per apartment under Lines → add, with the apartment number as its name and the package of that kind of home.
  2. Set max connections to the number of televisions in the home.
  3. Use an activation code instead of a password when the resident should enter a short code on the device.
  4. Configure the device once (Xtream Codes API or M3U with the line's credentials, or the MAG or Enigma2 portal); the credentials stay with the apartment until the line is given new ones.

Welcome and notice videos

The management company's videos on demand.

  1. Upload the welcome video, the house rules and the maintenance guides as movies, with a category per topic.
  2. Put them in the information bouquet so every package includes them.
  3. Replace a video from the panel when the information changes; the residents see the new version at once.

Channels and the information channel

The line-up and the notice channel as live streams.

  1. Add each licensed channel under Streams with its feed, and an EPG source so the guide on the television shows the programmes.
  2. Add the information channel as a live stream, fed by an encoder over RTMP or by a looping source, and place it in the information bouquet.
  3. Keep channels with territory limits in bouquets that only the right packages grant.

Move-in, move-out and expiry

The occupancy as the line's validity.

  1. A line expires at the end of its package's period; renew it with the package or a credit for each new period of the lease.
  2. When a resident leaves, disable the line; the next resident enables it again with new credentials, so nothing stays with the old household.
  3. Subscribe the housing system or the manager to the webhooks to see lines that are about to expire or already expired.

Integration with a housing or billing system

Systems open the access; the player plays.

  1. Create a Reseller API key for the housing or billing system; it calls create_line, renew_line, enable_line and disable_line, and sends a request id with each write.
  2. Use a commerce connector when residents buy extra packages online; any other system uses the Reseller API and webhooks.
  3. There is no single sign-on for viewers: a resident signs in to the player with the line's credentials.

Security considerations

Keep the service inside the community.

  1. Serve the panel behind a reverse proxy with TLS and set TRUSTED_PROXIES so the audit log and the IP rules see real addresses.
  2. Two-factor sign-in for every management account; the property managers get a permission group limited to lines.
  3. A connection limit per line, signed and expiring playback links, and address binding where the devices have fixed addresses.
  4. Enable the encrypted database backup with an off-site copy; the lines' credentials live in it.

Troubleshooting

The usual first checks.

  1. An apartment has no television: check that its line is enabled and not expired, then the device's credentials and the playback address.
  2. A building buffers in the evening: check the building node's heartbeat and that its residents are routed to it.
  3. A channel is missing for one kind of home: check the bouquets of that package.
  4. A manager cannot create lines: check the reseller's credit balance, its group permissions and the packages assigned to it.
Start free Help centre Contact