--- source: "https://docs.lumora.live/overview/controller" url: /overview/controller.md description: >- Install and use the Lumora Controller desktop app on Windows: sign-in, choosing a workspace, local data files, tally, the Client API, preview screenshots, pop-outs, logs and reporting problems. --- # The desktop Controller **Lumora Controller** is a Windows desktop app that runs the same control panel you use in the browser, plus a few things a browser can't do: read data files on your computer, take tally from your vision mixer, and accept button presses from Stream Deck or Companion. You don't need it to run a show. Everything else in these docs works from a browser. Install the Controller on the machine where you want those extra features. ::: info Early access The Controller is in early testing. The Lumora team sends testers a link to the installer; a public download page is planned but not live yet. The desktop app is included with the plans marked **Desktop controller app** in [Subscription plans](/billing/subscription-plans). ::: ## Install Run the installer you were given (`lumora-controller-setup.exe`). It installs for your Windows user only and doesn't need administrator rights. * **Windows SmartScreen will warn you.** Test builds aren't code-signed yet, so Windows shows "Windows protected your PC". Click **More info**, check the app name reads Lumora Controller, then click **Run anyway**. * If the machine doesn't have Microsoft Edge WebView2 (most Windows 10 and 11 machines already do), the installer downloads it, so it needs an internet connection. ## Sign in Click **Sign in with Lumora** and sign in through your web browser with the same account you use on [app.lumora.live](https://app.lumora.live). The Controller never asks for your password itself. If the browser page asks you to confirm an account and you didn't just click **Sign in with Lumora**, close the tab. Signing out of the Controller ends its session on the server but leaves your browser signed in. ## Choose a workspace Pick a workspace to open its control panel. Workspaces on a plan without the desktop app show an upgrade link instead. The Controller reopens your last workspace on the next launch. ## What the Controller adds ### Local data files Use Excel (`.xlsx`), CSV or JSON files on your computer as [data sources](/operating/data-sources). In **Configure Data Sources**, add an Excel source, or a CSV / JSON source in **Local File** mode, then click **Browse…** to pick the file. * The Controller only reads files you've picked with **Browse…**, and only from your **Documents**, **Desktop** and **Downloads** folders. A file somewhere else is refused; move it into one of those folders. * Files can be up to **5 MB**. A bigger file isn't read; the source shows an error saying it's too large. * The file is read on this computer and its data sent to your workspace, so the source only updates while this Controller is open, signed in and showing that workspace. ### Tally The Controller can connect to your vision mixer (vMix, Blackmagic ATEM, TSL 3.1, Panasonic KAIROS) and show which Lumora outputs are on program or preview. See [Tally](/advanced/tally) for setup. ### Stream Deck and Companion (Client API) The Controller runs a small local API so Stream Deck, Bitfocus Companion (with generic HTTP actions) or your own scripts can take, clear and step graphics, the same as pressing the hotkeys. See [Client API](/advanced/client-api) for the address, the endpoints and the optional security token. ### Preview screenshot Right-click a preview and choose **Screenshot** to save a PNG of the graphic at your output's full resolution. The Controller window may flicker once while it captures; your program output is not affected. ### Pop-out previews **Large preview** and **Output preview** open in their own windows at the output's full size, so you can put them on a second monitor. ## Updates The Controller never installs an update on its own, so nothing changes in the middle of a show. When a new version is out, **Update & restart** appears on the sign-in and workspace screens and in the **Status** panel. While it updates, graphics already on air stay on air. Tally, local data files and Stream Deck control pause until the Controller is back. Machines with no internet access don't get the update notice; install new versions on those with the installer. ## Closing the Controller Closing the Controller doesn't take anything off air. It stops local data files, tally and the Client API until you open it again. ## Logs Log files for bug reports are in `%LOCALAPPDATA%\live.lumora.controller\logs\`. The current one is `controller.log`. ## Reporting problems * In the control panel, open the right-hand **Status** panel, go to the **Help** tab and use **Report a problem**. * Or post in the [Lumora Discord](https://discord.lumora.live), or email support (see [How to get help](/overview/help)). Tell us what you were doing, what you expected and what happened, and attach the log file from the folder above. Include the Controller version, which is shown at the bottom of the Status panel.