Documentation Changelog

Latest Beta Version

Added

• (public) Extended control documentation covers Samsung auto source switching on Tizen (primary HDMI input with the signageOS app as the fixed fallback), which the recommended Tizen configuration deploy now also turns on with HDMI1 as the primary source
• Expanded DevSpace synchronization documentation with Sync API, Sync Server, P2P, on-premise Synchronizer, hosted service deprecation, master device, video wall implementation, and monitoring the on-premise Synchronizer through its dashboard, metrics and logs

[9.4.0] - 2026-09-17

Added

• (public) Added "Managing Custom Scripts in Box" article documenting browser-based script creation, Code Mode editor, and version management
• (public) New Linux general provisioning script for Fedora, Ubuntu and rasperry Pi OS
• (public) Event Stream docs describe the selectable delivery format versions: version 1 is the frozen legacy four-field body (the default), version 2 adds dispatchedAt (the ordering key) and attemptNumber

Fixed

• Requirements for the installation script guide have been extended by internet connection requirements.

[9.3.0] - 2026-09-02

Added

• (public) Cisco Vision BrightSign-based models (CV-HD, CV-UHD, CV-HD2, CV-UHD2) in the BrightSign supported devices list, provisioning guide and supervisor guide
• (public) Supra guides for installing Android packages and assigning apps to connected client devices
• (public) Guide for connecting Event Stream Distributor to ServiceNow
• (public) HDMI-CEC guide for professional displays (Devices → General Information): CEC menu name and path for Samsung, LG, Philips, Sony, NEC, Sharp, Panasonic, Vestel, Hisense, BenQ, and TCL
• (public) Event Stream delivery format documents the new dispatchedAt body field (ISO 8601 event time, the ordering key) and X-SOS-Timestamp as the per-attempt delivery time
• (public) Device Force Deprovision company feature entitlement (deviceForceDeprovision) in the Feature Entitlements Reference and the feature-entitlements remark plugin

[9.2.0] - 2026-08-11

Added

• (public) Generated /llms.txt index of all documentation pages (https://llmstxt.org), linking raw markdown page versions and the OpenAPI spec

Fixed

• (public) REST API tag pages now use the real tag description in frontmatter instead of echoing the title (85 pages, affects SEO meta and llms.txt)
• (public) Downloaded changelog pages now get "{Project} Changelog" titles and a real description instead of Keep-a-Changelog boilerplate
• (public) Rewrote 119 truncated, colon-stub, or callout-derived SEO descriptions across all documentation sections
• (public) Fixed platform-build-split announcement title date, homepage Supra product blurb, and assorted typos (Battery, BSN.cloud, BrightSign casing)

[9.1.0] - 2026-08-07

Added

• (public) US Region (US1) customer guide (console, Core App downloads, CLI setup, limitations)
• (public) US1 endpoints in the network requirements article

Added

• (public) Added the Core Library changelog to SignageOS Public Components

Fixed

• (public) Updated REST API changelog source after migration to the core monorepo

[9.0.3] - 2026-07-17

Fixed

• (public) Improved Algolia search configuration

[9.0.2] - 2026-07-03

Fixed

• (public) Updated list of supported BrightSign devices

[9.0.1] - 2026-07-01

Fixed

• (public) Updated list of supported devices

[9.0.0] - 2026-06-30

Added

• (public) Added Hisense FW upgrade documentation

Changed

• (public) Event docs generator now documents payload fields (flattened, with descriptions) instead of the high-level envelope, distinguishes string literals with a _(literal)_ tag, and overrides ESD-guaranteed fields (deviceIdentityHash, owner.organizationUid, owner.parentCompanyUid) to non-null string despite their nullable command-handler typing

[8.4.1] - 2026-06-17

Fixed

• (public) Updated documentation on Shell

[8.4.0] - 2026-06-16

Added

• (public) Added DevSpace guide for defining configuration schemas in single file applets

[8.3.1] - 2026-06-15

Fixed

• (public) Updated documentation

[8.3.0] - 2026-06-02

Added

• (public) Added stream playback guide (sos.stream API) covering low-latency mode, stream options, events, and supported protocols
• (public) Documentation on MFA enrollment
• (public) Added announcement article for Tizen, webOS & BrightSign platform build split (January 2027 effective date)
• (public) Added cross-links between platform build split announcement, Build Targets page, and billing documentation

[8.2.1] - 2026-04-15

[8.2.0] - 2026-04-09

Added

• (public) Added Changelogs landing page with card grid highlighting Announcements, CoreApps, Players, and Services sections
• (public) Added Zendesk redirect from /hc/en-us/categories/4409161425170-Changelogs to the new changelogs landing page
• (public) Added announcement article for plan visibility, feature access alignment, and new DevSpace device plans (Lab & Prod)
• (public) Added Announcements section to the documentation homepage showing latest announcements

[8.1.0] - 2026-03-31

Added

• (public) Added Client Public IP to the collected telemetry list in the telemetry and data reporting frequency article
• (public) Added Supra Telemetry article for cloud-based connection status monitoring of Supra client devices
• (public) Added get-metrics custom script documentation to Supra Server management and monitoring articles
• (public) Added announcement article for upcoming screenshot URL security changes
• (public) Documented sos field with @signageos/front-applet version in .sosconfig.json for plugins, runners and custom scripts
• (public) Added DevSpace User License article explaining license assignment based on DevSpace plan

Fixed

• (public) Improved Supra documentation based on end-user feedback: clarified access request process, added hardware recommendations, added Ubuntu quick-start guide for lab setups, added screenshot of Supra tab, resolved CUSTOM_SCRIPTS TODO in troubleshooting
• (public) Fixed changelog sync to auto-detect each GitLab project's default branch instead of only trying main/master

[8.0.3] - 2026-03-20

Fixed

• (public) Fixed MDX compilation errors in supported video formats page (self-closing <br/> tags, escaped asterisks, JSX style objects)

[8.0.2] - 2026-03-11

[8.0.1] - 2026-03-10

[8.0.0] - 2026-03-09

Added

• (public) Added comprehensive Supra documentation (architecture, setup, configuration, troubleshooting)
• (public) Enabled Supra section in the main navigation bar
• (public) Added signageOS Cloud category to the Getting Started sidebar
• (public) Added legacy redirect table (config/legacy-redirects.json) mapping all old master /docs/ routes to new unified-docs locations
• (public) Added Algolia DocSearch crawler configuration (config/algolia-crawler-config.json) with start URLs for all doc sections
• (public) Added searchPagePath: 'search' to Algolia config for a dedicated search results page
• (public) Added automated changelog sync from 19 GitLab projects into /docs/changelogs/
• (public) Added VideoEmbed MDX component for responsive YouTube and Vimeo video embeds
• (public) Added Steps and Step MDX components for GitBook-style numbered step guides with vertical connecting line
• (public) Added collapsible <details> accordion styling with chevron indicator and accent border
• (public) Added centered breadcrumbs, pagination, doc footer, and ChildArticles to match 960px article reading width
• (public) Added centered generated category index pages to match 960px article reading width
• (public) Restructured Samsung Tizen provisioning page with <details> accordions per device variant and <Steps> components
• (public) Added video link validation test to prevent plain-text video links in markdown
• (public) Added component usage documentation with examples in CONTRIBUTING.md
• (public) Added check-types script (tsc --noEmit) for CI compatibility

Changed

• (public) Rewrote nginx.conf redirect targets from old /docs/ paths to new unified-docs route structure
• (public) Fixed 69 article descriptions across all documentation sections for SEO and search quality (replaced list items, headings, warnings, and missing descriptions with proper prose)
• (public) Replaced 9 plain-text video links with <VideoEmbed> embeds across provisioning and tutorial pages
• (public) Renamed site branding from "Developer Portal" / "Developers" to "Documentation" / "Docs"
• (public) Renamed navbar CTA from "Start Free" to "Sign Up" and pushed it to far-right (after search)
• (public) Fixed ChildArticles component links by normalizing trailing slashes in path comparison
• (public) Added href fallback guard in ChildArticles to prevent broken links on items without href
• (public) Fixed <details> accordion marker removal to use standards-compliant content: none
• (public) Upgraded onBrokenMarkdownImages from 'warn' to 'throw' in build configuration
• (public) Enabled TypeScript type-checking and Prettier formatting in CI pipeline
• (public) Pinned @docusaurus/plugin-client-redirects to exact version for check-deps compliance
• (public) Changelog files now use format: md frontmatter with format: 'detect' in Docusaurus config to avoid MDX parsing issues

Added

• (public) Added multi-instance documentation architecture (Getting Started, CloudControl, DevSpace, ProPlayer, Devices, Supra)
• (public) Added ChildArticles component for automated section exploration on parent pages
• (public) Added tools/create-dummy-docs.js to satisfy build requirements without private registry access
• (public) Added supported device brand images
• (public) Migrated 73 Zendesk Help Center articles into unified Docusaurus portal
• (public) Added 336 URL redirects for legacy Zendesk links
• (public) Added Zendesk link rewriting scripts for internal cross-references
• (public) Added MDX build fix scripts for Zendesk content compatibility
• (public) Added redirect validation test suite and documentation structure test suite
• (public) Added tools/fix-internal-links.js migration script for bulk internal link rewriting
• (public) Added markdowns/docs-devices/device-guides/index.md landing page for device guides category
• (public) Added static/robots.txt for search engine crawling
• (public) Added SEO description frontmatter to all section index pages and key DevSpace pages
• (public) Added custom 404 page with search bar and section navigation links
• (public) Added self-hosted Zendesk CDN assets (downloads, images) replacing external dependencies
• (public) Updated README.md with multi-instance architecture documentation
• (public) Updated CONTRIBUTING.md with section-based contribution guide

Changed

• (public) BREAKING: URL structure changed from monolithic /docs/ to multi-instance routes (/getting-started, /cloudcontrol, /devspace, /proplayer, /devices, /supra)
• (public) Hardened tools/create-dummy-docs.js with fallback version resolution from existing JSON files
• (public) Migrated onBrokenMarkdownLinks config to markdown.hooks for Docusaurus 3.9 compatibility
• (public) Switched onBrokenLinks and onBrokenAnchors to 'throw' for strict CI enforcement
• (public) Hidden Supra section from navbar until content is ready (plugin remains active)
• (public) Removed unused path import from docusaurus.config.js
• (public) Added build log patterns to .gitignore; removed tracked build_output.log and orphan docs/.gitkeep
• (public) Visual alignment with signageos.io: darkened hero gradient, glass-morphism dark-mode cards, navbar CTA button, gold glow on button hover, refined typography/spacing/radii, deeper footer
• (public) Added "Start Free" CTA button in navbar linking to box.signageos.io/signup

Fixed

• (public) Fixed directory structure flattening to resolve double-pathing (e.g. /supra/supra/)
• (public) Fixed TypeScript JSX namespace ambiguities in core components (DeviceCard, HeroSearch, etc.)
• (public) Fixed 482 broken internal links across 142 files referencing legacy /docs/ routes
• (public) Fixed cross-plugin relative links that fail across Docusaurus plugin instance boundaries
• (public) Fixed stale footer links and HeroSearch trending topic links to device provisioning routes
• (public) Fixed Zendesk-style anchors (#h_01H...) converted to Docusaurus heading slug format
• (public) Fixed mobile navbar sidebar hidden behind page content (z-index stacking context from backdrop-filter)
• (public) Fixed broken Zendesk image references in devices index page (commented out unmigrated attachments)
• (public) Fixed broken redirect and internal links to non-existent introduction-to-device-provisioning page
• (public) Modernized tools/fix-redirects.js for robust mapping of flattened paths
• (public) Fixed Object.groupBy compatibility issue in generate-sdk-versions.ts for Node 20
• (public) Fixed MDX compilation errors in migrated Zendesk articles (unclosed HTML tags, inline styles, unescaped characters)
• (public) Fixed invalid redirect destinations for alerts and whitelabel sections
• (public) Updated documentation for REST API and visual look and feel
• (public) Fixed stale file paths in tools/fix-all.js after multi-instance restructuring
• (public) Fixed 70 broken SEO description frontmatter values containing admonition syntax
• (public) Fixed 77 un-migrated Zendesk Help Center links across 35 files
• (public) Fixed 54 api.docs.signageos.io Postman links rewritten to /api/ portal routes
• (public) Fixed 3 double-protocol (https://https://) URLs
• (public) Fixed 5 docs.signageos.io/tickets links rewritten to box.signageos.io/support
• (public) Fixed 3 docs.signageos.io/knowledge-base links mapped to correct portal pages
• (public) Fixed concatenated URL in organization creation documentation
• (public) Fixed 29 bare /api/ links rewritten to /api/signageos-rest-api
• (public) Fixed 17 stale /getting-started/supported-devices/ links redirected to /devices/device-guides
• (public) Fixed 14 category links using correct Docusaurus /category/ URL prefix
• (public) Added generated-index link to Support sidebar category and Provisioning Guides category

Security

• (public) Addressed CVE-2025-15467: resolved dependency vulnerability in transitive packages via upgrades

[7.0.1] - 2026-02-13

[7.0.0] - 2025-11-21

Fixed

• (public) Updated docs for scripts, plugins and runners

Removed

• Old redirects for api.docs.signageos.io and sdk.docs.signageos.io

Changed

• Pack only static files into Docker image

[6.5.1] - 2025-09-16

[6.5.0] - 2025-09-15

Added

• (public) Added fetch and generator logic for CLI Documentation
• (public) Developers documentation for Plugins and Runners
• (public) Download link for Postman collection

[6.4.2] - 2025-06-01

Fixed

• (public) (Custom Scripts guide) Typo in the file name

[6.4.1] - 2025-03-04

Fixed

• (public) Updated Custom Scripts documentation with it's own category and sample for Scripts outputs

[6.4.0] - 2025-02-28

Added

• (public) New guide describing usage of sos CLI for developing custom scripts

[6.3.0] - 2024-11-13

Added

• (public) New guide describing usage of signageOS JS SDK with existing application
• (public) New guide describing usage of signageOS JS SDK with Angular application

[6.2.2] - 2024-09-24

Fixed

• (public) Documentation patch: Use npm run connect to initiate Applet hot reload on device connected over sos device connect
• (public) More specific information about sos device connect
• (public) Improved links to CLI and footer menu

[6.2.1] - 2024-05-24

Fixed

• (public) Documentation patch: clarify on the ENV variables (timing configuration) and document min and max options
• (public) Documentation patch: New Limiting supported platforms for your Applet page

[6.2.0] - 2024-05-15

Added

• (public) New article "Using sos.authHash for Device Identification and Pairing"

[6.1.1] - 2024-04-04

Fixed

• (public) Gave our sos device connect documentation a clarity boost. Now it's so straightforward, even your pet could almost get the gist of it!

[6.1.0] - 2024-02-14

Added

• (public) Site search functionality
• (public) Mermaid diagram support

[6.0.1] - 2024-01-23

Fixed

• (public) New social baner with signageOS branding replacing the Docusaurus original

[6.0.0] - 2024-01-22

Changed

• (public) New design for documentation

[5.0.5]

Fixed

• (public) Won't start in Standalone environment
• (public) Formatted repository

[5.0.4] - 2023-12-18

Security

• (public) Upgrade to Node 20

[5.0.3] - 2023-11-16

Fixed

• (public) Building Javascript SDK Docs with new NPM

[5.0.2] - 2023-06-02

Fixed

• (public) Issue when URL contains invalid or old version of JS API

[5.0.1] - 2022-03-23

Fixed

• (public) Fixed links for Javascript SDK page

[5.0.0] - 2022-01-26

Changed

• (public) Reduce documentation only to SDK JS docs (former JS API for applet)

[4.10.1] - 2021-12-15

Fixed

• (public) Rewrite Android Native Device Debug docs

[4.10.0] - 2021-09-22

Added

• (public) Windows Installer provisioning
• (public) One line command for Windows Kiosk Credential retrieval
• (public) Windows Release Candidates Changelog

[4.9.0] - 2021-05-24

Added

• (public) Release Candidates Changelogs for Core Apps

Fixed

• (public) Updated list of FWs for Philips devices

[4.8.2] - 2021-05-10

Fixed

• (public) Device Policy guide

[4.8.1] - 2021-04-14

Fixed

• (public) Missing documentation for sos.display.supports()
• (public) Fixed warning in Serial API - suggest using sos.display.supports() instead of sos.management.supports()

[4.8.0] - 2021-03-30

Added

• (public) SMIL keyboard triggers documentation
• (public) section for api authentication with organization tokens per each member
• (public) Release date for every version in changelogs
• (public) Automatic redirects from old to new URL type for API Docs
• (public) Docs section for new CLI command device connect
• (public) Documentation now downloads only latest minor versions of front-applet
• (public) Prerendering pages with Prerender.io
• (public) Sidebar with main categories

Fixed

• (public) Missing documentation for sos.browser.close()
• (public) Missing examples for applet commands
• (public) Fixed selecting JS API versions
• (public) Content resolution on big screens

[4.7.0] - 2020-12-16

Added

• (public) new REST API Reference in Postman
• (public) Generating sitemap.xml
• (public) Versioned JS API
• (public) CCs emails on Zendesk tickets
• (public) Descriptions in search results

[4.6.0] - 2020-10-28

Added

• (public) SMIL Sensors and Triggers documentation
• (public) Vestel provisioning
• (public) Using React JS in Applet example
• (public) Using Vue JS in Applet example
• (public) Using Angular in Applet example

Fixed

• (public) Better Table of Content position and scrolling
• (public) New structure for device-related information
• (public) Better search results
• (public) Updated SMIL documentation

[4.5.0] - 2020-09-29

Fixed

• (public) Hardware API wording
• (public) Offline Cache for media files - missing methods in methods list
• (public) Correct link to Input API on JS API introduction page
• (public) Replace all links to example applets to reflect changes in directory structure

Added

• (public) New Sensors API and related documentation

[4.4.1] - 2020-09-24

Fixed

• (public) Wi-Fi API wording and typos

[4.4.0] - 2020-09-07

Added

• (public) Guide for Cloud Control
• (public) Management Wi-Fi API

[4.3.0] - 2020-08-12

Added

• (public) Windows provisioning guide

[4.2.0] - 2020-08-06

Added

• (public) Added raw content pages
• (public) FontAwesome in tables
• (public) Check access in tickets

Fixed

• (public) Category pages on mobile
• (public) Opening sidebar on api pages
• (public) Wrapping tables on mobile

[4.1.0] - 2020-07-08

Added

• (public) new SMIL deployment tutorial
• (public) Complete SMIL XML documentation
• (public) More fields when user creating a ticket
• (public) Support for importing markdowns
• (public) Added subcategories

Fixed

• (public) updated list of supported Philips displays
• (public) Changelogs for Android 3.x

[4.0.0] - 2020-07-01

Added

• (public) New category pages
• (public) Support for uploading files in Zendesk Tickets

Changed

• (public) updated list of features supported by Emulator

[3.0.0] - 2020-06-09

Added

• (public) JS management API for security PIN code

Changed

• (public) added new Samsung OHF, OHF-V as supported displays
• (public) added new NEC models as supported displays
• (public) updated link to RPi3 image

[2.0.0] - 2020-05-04

Changed

• (public) new provisioning guide for the Raspberry Pi

[1.8.0] - 2020-04-15

Added

• (public) Integration Guide
• (public) SMIL Player App tutorial

[1.7.0] - 2020-03-25

Added

• (public) Integration with Zendesk tickets

Fixed

• (public) Search by platform
• (public) Latest changes in changelog are now in table

[1.6.0] - 2020-03-02

Added

• (public) Company detail and billing plan settings, Organization subscription type settings
• (public) Device Package Start REST API
• (public) Updated description of the Applet page

[1.5.0] - 2020-01-28

Added

• (public) How use signageOS with existing application
• (public) Better description of the Verification process
• (public) added new FW versions for webOS

[1.4.0] - 2020-01-14

Added

• (public) Standalone CLI Emulator info in deploy guide

[1.3.2] - 2019-12-18

Fixed

• (public) new supported FW for SSSP 4 / Tizen 2.4

[1.3.1] - 2019-12-06

Fixed

• (public) new icons on API Reference page
• (public) added information about default webOS NTP servers
• (public) added applet origins by platform
• (public) updated provisioning pages for Panasonic and Android
• (public) updated Android provisioning
• (public) updated Philips provisioning

[1.3.0] - 2019-09-25

Added

• (public) new API Reference page

Fixed

• (public) new charts and images through out the documentation
• (public) new Open Core App provisioning details
• (public) new Setup Dev Environment and Build & Deploy pages

[1.2.0] - 2019-09-17

Added

• (public) Do not include API in latest changes in knowledge base

Fixed

• (public) Extend documentation of sos.fileSystem.getFile() method
• (public) Prevent enter in search box when props are empty

[1.1.0] - 2019-08-12

Fixed

• (public) updated Supported devices list for Samsung with FW full names
• (public) missing seconds in setTimer power management method
• (public) responsive menu fix for iphone devices
• (public) responsive images fix for mobile devices

Added

• (public) Enabling full text search through docs from url address

[1.0.1] - 2019-08-08

Fixed

• (public) improved Samsung Tizen Provisioning manual
• (public) added information about "How to check Samsung FW version"

[1.0.0] - 2019-08-07

Changed

• (public) Use PrismJS for coloring code in code blocks

[0.8.0] - 2019-07-24

Added

• (public) Working links in titles (hashtags)

Fixed

• (public) updated JS File System API docs
• (public) added Kubernetes Tag
• (public) added example for Offline Cache for storing data
• (public) updated description of JS API for Offline Cache

[0.7.0] - 2019-07-18

Added

• (public) Cloud Architecture description

[0.6.0] - 2019-07-10

Added

• (public) Status endpoint for health checking
• (public) Added information about Remote Control Lock (Kiosk mode) for Android
• (public) Added Giada provisioning screenshots

Fixed

• (public) Fixed names in changelog pages
• (public) Fixed headers api reference of cache

[0.5.3] - 2019-06-19

Fixed

• (public) Show NotFound page if API documentation does not exists
• (public) Fixed errors on missing keys in tables
• (public) Sorting table of latest changes

[0.5.1] - 2019-05-29

Fixed

• (public) additional Giada provisioning details
• (public) JS API for streams does not support format parameter

[0.5.0] - 2019-05-27

Added

• (public) supported Samsung SSB

[0.4.1] - 2019-05-16

Added

• (public) KB about Android Demo Mode
• (public) KB about IoT Gateway
• (public) new Tags
• (public) image describing video lifecycle

Changed

• (public) separated JC Commands and JS Monitoring Commands into separate pages
• (public) Architecture images

Fixed

• (public) fix broken links from prev. version of documentation

[0.4.0] - 2019-05-01

Added

• (public) New resources and little changes in JS Management API
• (public) Added detailed descriptions of all errors which can be thrown from JS API (sos)

[0.3.1] - 2019-04-26

Fixed

• (public) ENTER can be used for fulltext search again

[0.3.0] - 2019-04-25

Added

• (public) Added better search with categories
• (public) Added new search on home page

[0.2.1] - 2019-04-10

Fixed

• (public) Info about current RC applications to install

[0.2.0] - 2019-04-05

Added

• (public) On Provisioning page added device images
• (public) Added JS Management API
• (public) Added automatic changelogs of platforms

Fixed

• (public) Menu for mobile devices
• (public) Added back to box link
• (public) Many changes according to signageOS Open (provisioning etc.)
• (public) Added GA traking
• (public) Link to RPi changelog from left menu
• (public) Changed download link for RPi image to new version 0.4.0

[0.1.1] - 2019-03-23

Fixed

• (public) Content fixes of whole documentation

[0.1.0] - 2019-03-21

Added

• (public) New service Documentation