# Obscreen Docs

> Documentation for Obscreen, lean and modern digital signage system.

Obscreen has two parts: the Studio (server-side CMS where contents, playlists and screens are managed) and the Player (client app that displays playlists on screens). The Studio runs on Obscreen Cloud or self-hosted with Docker.

- Every page below is available as Markdown by appending `.md` to its URL.
- The whole technical documentation and the REST API reference in a single file: https://docs.obscreen.io/llms-full.txt
- Product overview, pricing and plans: https://obscreen.io/llms.txt

## Intro

- [What is Obscreen?](https://docs.obscreen.io/index.md): Obscreen is a simple tool helping you to organizes and broadcasts media to your screens through any web browser. It uses a simple approach that avoids bulky…
- [Get Started](https://docs.obscreen.io/install.md): To get started with Obscreen, you need to install the Studio (server) and Player (client). Below are the available installation options.
- [Frequently Asked Questions](https://docs.obscreen.io/faq.md): Please search for your question, or open an issue if you can't find an answer.
- [What's New](https://docs.obscreen.io/releases.md): You can find releases and changelogs on GitHub
- [Demo](https://docs.obscreen.io/demo.md): Demo Server: https://demo.obscreen.io
- [Contact](https://docs.obscreen.io/contact-us.md): You can join our community Discord server to chat with us and other Obscreen users.

## Installation

- [Intro](https://docs.obscreen.io/install/intro.md): To get started with Obscreen, you need to install the Studio (server) and Player (client). Below are the available installation options.
- [Studio (Server)](https://docs.obscreen.io/install/studio-server.md): The Studio serves as the central hub for managing and organizing your content, delivering everything the Player needs to display. In essence, it functions as a…
- [Studio (Server): Obscreen Cloud](https://docs.obscreen.io/install/studio-server/obscreen-cloud.md): Obscreen Cloud is the simplest solution to get started with Obscreen. It's a hosted and managed cloud service that allows you to use Obscreen without having to…
- [Studio (Server): Docker](https://docs.obscreen.io/install/studio-server/docker.md): These scripts are using docker on linux. Adapt them to your OS if needed.
- [Player (Client)](https://docs.obscreen.io/install/player-client.md): The Player is responsible for displaying the content provided by the Studio. Obscreen now ships native player apps for most platforms, while still supporting…
- [Player (Client): Android](https://docs.obscreen.io/install/player-client/android.md): Turn any Android phone, tablet or TV box into a digital signage player using the native Obscreen Player app.
- [Player (Client): Android TV](https://docs.obscreen.io/install/player-client/android-tv.md): Native Obscreen Player app for Android TV devices.
- [Player (Client): Amazon Fire TV](https://docs.obscreen.io/install/player-client/amazon-fire-tv.md): Affordable digital signage with Amazon Fire TV Stick using the native Obscreen Player app.
- [Player (Client): Linux](https://docs.obscreen.io/install/player-client/linux.md): Run Obscreen Player on any Linux distribution as a native app.
- [Player (Client): macOS](https://docs.obscreen.io/install/player-client/macos.md): Native digital signage player for Mac. Optimized for Apple Silicon and Retina displays.
- [Player (Client): Windows](https://docs.obscreen.io/install/player-client/windows.md): Native digital signage app for Windows 10 and 11 PCs.
- [Player (Client): LG webOS](https://docs.obscreen.io/install/player-client/lg-webos.md): Native Obscreen Player app on LG webOS Signage commercial displays.
- [Player (Client): Raspberry Pi](https://docs.obscreen.io/install/player-client/raspberry-pi.md): The DIY digital signage player. Compact, silent and energy-efficient: drives any HDMI screen.
- [Player (Client): Browser](https://docs.obscreen.io/install/player-client/browser.md): You can use any modern web browser to run the Obscreen Player. Simply open the player URL in your preferred browser, no extra software installation is…
- [Player (Client): Generic Smart TV](https://docs.obscreen.io/install/player-client/generic-smart-tv.md): For any Smart TV without a dedicated Obscreen Player app. The TV runs the player through its built-in web browser.
- [Player (Client): iOS (soon)](https://docs.obscreen.io/install/player-client/ios.md): Digital signage on iPad and iPhone for environments that already rely on Apple devices. The iOS player will support the same content types and pairing flow as…
- [Player (Client): Apple TV (soon)](https://docs.obscreen.io/install/player-client/apple-tv.md): Premium signage experience on Apple TV. The tvOS player will run natively on the device with full remote-friendly pairing and 4K HDR output.
- [Player (Client): Samsung Tizen (soon)](https://docs.obscreen.io/install/player-client/samsung-tizen.md): Samsung commercial signage displays run Tizen, Samsung's professional signage operating system. Like the LG webOS app, the Tizen build will run natively on the…
- [Player (Client): Amazon Signage (soon)](https://docs.obscreen.io/install/player-client/amazon-signage.md): Amazon Signage covers professional displays running Amazon's signage stack on certified hardware.

## How does it work?

- [Learn more](https://docs.obscreen.io/learn-more.md): Obscreen is a tool designed to broadcast content from a server (Studio) to a client (Player). The Studio can be installed on Linux, Windows, or macOS and…
- [Deployment Types](https://docs.obscreen.io/deployment-types.md): There are two main deployment types: Standalone and Distributed.
- [Deployment Types: Standalone](https://docs.obscreen.io/deployment-types/standalone.md): In the Single Standalone setup setup, the Studio (server) and Player (client) are both installed on the same device (e.g., a Raspberry Pi) that is connected to…
- [Deployment Types: Distributed](https://docs.obscreen.io/deployment-types/distributed.md): In the Managed Multiple Distributed configuration, a Studio Server distributes content to multiple Players (clients), each connected to a Screen and having its…

## Features

- [Overview](https://docs.obscreen.io/features.md)
- [Basic Content Types](https://docs.obscreen.io/features/basic-content-types.md): Obscreen supports the following basic content types. See each subpage for details on supported formats and display behavior.
- [Basic Content Types: Images](https://docs.obscreen.io/features/basic-content-types/images.md): Import pictures from your computer.
- [Basic Content Types: Videos](https://docs.obscreen.io/features/basic-content-types/videos.md): Import videos from your computer.
- [Basic Content Types: URLs (Iframe Embed)](https://docs.obscreen.io/features/basic-content-types/urls.md): Display an iframe embed of a web page.
- [Advanced Content Types](https://docs.obscreen.io/features/advanced-content-types.md): Obscreen supports the following advanced content types. See each subpage for details and configuration.
- [Advanced Content Types: HTML Editor](https://docs.obscreen.io/features/advanced-content-types/html-editor.md): Display an HTML content. You can use the HTML editor to create your own HTML content.
- [Advanced Content Types: Youtube Embed](https://docs.obscreen.io/features/advanced-content-types/youtube-embed.md): Display a Youtube video. This is not an api integration so you need to manually set a duration for the video in slide settings.
- [Advanced Content Types: Camera & Live Streaming](https://docs.obscreen.io/features/advanced-content-types/camera-live-streaming.md): Display live feeds from IP cameras, NVRs or any web stream. Streams are ingested by an embedded go2rtc engine and re-broadcasted to the player using MSE, HLS…
- [Advanced Content Types: External Storage](https://docs.obscreen.io/features/advanced-content-types/external-storage.md): Let imagine you have a 1000 pictures folder on your USB stick under a specific directory.
- [Advanced Content Types: Composition](https://docs.obscreen.io/features/advanced-content-types/composition.md): A complete content disposition system which can be used to create complex content scenarios.
- [Advanced Content Types: Playlist Embed](https://docs.obscreen.io/features/advanced-content-types/playlist-embed.md): Basically a symbolic link to an existing playlist which can be used to control scheduling at a playlist level.
- [Advanced Content Types: Text](https://docs.obscreen.io/features/advanced-content-types/text.md): Display a text.
- [Virtual Content Types](https://docs.obscreen.io/features/virtual-content-types.md): Virtual content types are not stored as standalone media. Instead, they are decomposed at import time into one or more underlying basic content items (such as…
- [Virtual Content Types: PDF](https://docs.obscreen.io/features/virtual-content-types/pdf.md): Import a PDF document from your computer. Each page of the PDF is automatically extracted and converted into a picture, allowing the document to be played as a…
- [Slide Scheduling](https://docs.obscreen.io/features/slide-scheduling.md): Obscreen allows you to schedule slides in playlists with 3 different modes (loop, datetime and inweek).
- [Players](https://docs.obscreen.io/features/players.md): Everything related to how players display content and how a fleet of screens is managed.
- [Players: Customize Web Player](https://docs.obscreen.io/features/players/customize-web-player.md): Obscreen provides an URL for each playlist.
- [Players: Fleet Screen Management](https://docs.obscreen.io/features/players/fleet-screen-management.md): Fleet screen management allows you to manage multiple Players from a single Studio Server instance.
- [Administration](https://docs.obscreen.io/features/administration.md): Configure how the Studio is managed: users, plugins and languages.
- [Administration: User & Authentication](https://docs.obscreen.io/features/administration/authentication-management.md): Obscreen provides a very simple way to manage authentication for your Studio instance.
- [Administration: Plugin System](https://docs.obscreen.io/features/administration/plugin-system.md): Obscreen is built around a modular plugin system. Almost every feature of the Studio: content types, file storage backends, fleet management, integrations: is…
- [Administration: Internationalization](https://docs.obscreen.io/features/administration/internationalization.md): Obscreen is designed to be used by people from all over the world. The interface is translated into 17 languages and can be easily extended or improved.
- [Advanced](https://docs.obscreen.io/features/advanced.md): Advanced features for power users, integrators and self-hosted deployments.
- [Advanced: API](https://docs.obscreen.io/features/advanced/api.md): Obscreen provides a REST API to manage content, playlists, screens and more.
- [Advanced: Offline Mode](https://docs.obscreen.io/features/advanced/offline.md): To start Obscreen in offline mode, you will need to start an additional server. It acts as a license server but locally runs on your device on port 49495.
- [Advanced: SSL Support](https://docs.obscreen.io/features/advanced/ssl-support.md): Obscreen Studio supports SSL certificates through a dedicated plugin (Core Web SSL). This is particularly useful for companies with strict security…
- [Advanced: N8N Integration](https://docs.obscreen.io/features/advanced/n8n-integration.md): Obscreen offers native integration with n8n, an open-source workflow automation platform. This integration allows you to automate your digital signage content…
- [Advanced: Environment Variables Setup](https://docs.obscreen.io/features/advanced/environment-variables-setup.md): Set the application port for incoming connections.

## Legal

- [License](https://docs.obscreen.io/legal/license.md): By using the Obscreen software, you explicitly agree to all the terms and conditions outlined in this license agreement. Any use of the software not in…
- [Privacy Policy](https://docs.obscreen.io/legal/privacy-policy.md): Obscreen company ("we", "us", or "our") is committed to protecting your privacy while using our software, Obscreen ("the Software"). This Privacy Policy…
- [Terms of Service](https://docs.obscreen.io/legal/terms-of-service.md): Obscreen is a sole proprietorship officially registered in the Lyon Trade and Companies Register (France) under the identification number 789 571 437…
- [Subprocessors](https://docs.obscreen.io/legal/subprocessors.md): We use the following third-party service providers ("Subprocessors") to collect and process information on our behalf. These Subprocessors help us deliver,…

## REST API

- [OpenAPI 2.0 specification](https://demo.obscreen.io/swagger.json): machine-readable spec served by the demo Studio. Each Studio serves its own at `http://<STUDIO_URL>/swagger.json`.
- [Swagger UI](https://demo.obscreen.io/api): interactive API explorer of the demo Studio, available at `http://<STUDIO_URL>/api` on any Studio.

## Optional

- [Business Continuity and Resilience Plan (BCP)](https://docs.obscreen.io/legal/more/business-continuity-plan.md): This document describes the Business Continuity Plan (BCP) of Obscreen and complements the Information Security Policy, the Systems Security and Integrity…
- [Designation of an Information Security Officer (CISO / RSSI)](https://docs.obscreen.io/legal/more/ciso-designation.md): This document formalizes the designation of an Information Security Officer (Chief Information Security Officer, Responsable de la Sécurité des Systèmes…
- [Customer Data Encryption Policy](https://docs.obscreen.io/legal/more/data-encryption-policy.md): This policy describes the encryption measures applied to customer data processed by Obscreen and the Obscreen Cloud platform. It complements the Information…
- [Data Localization](https://docs.obscreen.io/legal/more/data-localization.md): This document provides an overview of the geographical localization of the data and infrastructure operated by Obscreen. It complements the Privacy Policy, the…
- [Designation of a Data Protection Officer (DPO)](https://docs.obscreen.io/legal/more/dpo-designation.md): This document formalizes the designation of a Data Protection Officer (DPO) for Obscreen and complements the Privacy Policy, the Information Security Policy,…
- [Incident Management Plan](https://docs.obscreen.io/legal/more/incident-management-plan.md): This document describes the incident management plan for Obscreen and complements the Information Security Policy, the Systems Security and Integrity Policy,…
- [Risk Analysis on Customer Personal Data](https://docs.obscreen.io/legal/more/risk-analysis.md): This document provides a risk analysis on the personal data processed by Obscreen and complements the Privacy Policy, the Information Security Policy, the…
- [Information Security Policy](https://docs.obscreen.io/legal/more/security-policy.md): Information security is essential for Obscreen, which provides digital signage software through both self-hosted (on-premise) and cloud-hosted deployments, and…
- [Systems Security and Integrity Policy](https://docs.obscreen.io/legal/more/systems-security-policy.md): This policy describes the technical organization put in place to protect the workstations, the servers, and the cloud environments used and operated by…