Skip to main content

What is Cuez Gateway and how do I install and configure it?

Find out how to install and configure the Cuez Gateway in order to use a streaming folder/watch folder as a media library in Cuez Rundown

The Cuez Gateway is a small application you install on a computer at your facility. It watches a local or network folder for new video files (a "watch folder" or "streaming folder") and makes anything dropped into it available as a Media Library inside Cuez Rundown.

This guide walks you through installing and configuring the Gateway.

Before you start

  • You need to be an Organization Owner in Cuez to complete the final step (creating the Media Library). If you are not sure whether that is you, check with whoever manages your Cuez organization.

  • Part of the setup requires an API Token that only the Cuez team can generate for your Gateway. Plan to reach out to your Cuez contact (via the in-app chat or via [email protected]) partway through this guide, at step 4 below.

  • Pick a computer that stays powered on and connected while the Gateway is running. Closing the Gateway app drops the connection.

  • Where possible, use a dedicated computer for this rather than one also running other heavy applications. Generating thumbnails and preview proxies is CPU-intensive.

Installation and configuration

Step 1 - Download and install the Gateway

Go to download.cuez.app, select Cuez Gateway under Products in the left menu, then the Stable version. Download the build for your platform (macOS Apple Silicon or Windows) and install it.

On Windows, the installer may be flagged as unsigned by your browser or antivirus. Choose "Keep" or "Run anyway" to proceed.

Step 2 - Open the Gateway and confirm the port

Open the app and keep its window open. Closing it drops the connection to Cuez.

By default the Gateway starts on port 7051. If clicking "Open GUI" does not open the settings page in your browser, open the Gateway's port setting and change it to, for example, 7052, then restart the app. This is a common first step and depends on port availability on your machine.

Step 3 - Note your Gateway ID and name it

In the Gateway app, go to Settings (bottom-left). You will see:

  • Gateway ID: pre-filled automatically. You need to share this with Cuez.

  • Gateway Name: give it a name you will recognize, for example your station or site name.

  • Api Token: to request, see next step.

Step 4 - Get your API Token from Cuez

Send your Gateway ID and the name you chose to your Cuez contact, and ask for an API Token for this Cuez Gateway. Once you receive it, paste it into the Api Token field in Gateway Settings.

The green checkmarks in Settings confirm the Gateway is authenticated.

Step 5 - Add the Indexing Folder - Streaming device

In the Gateway's UI, go to Services, then click Add Service (top-right) and choose Indexing Folder - Streaming.

Fill in the device fields:

  • Name: a clear, recognizable name for this device.

  • Extensions: comma-separated file types to watch, for example mp4, mov, mxf.

  • File Patterns (optional): wildcard filters if you only want to pick up files matching a pattern.

  • Folder Path to Watch: the folder to monitor (local or network drive). You can organize this folder with subfolders if you like, for example one per show. Files are picked up regardless of depth.

  • Thumbnail Temporary Folder: a separate folder for generated thumbnails. This must sit alongside the watch folder, never nested inside it. Nesting causes the Gateway to repeatedly reprocess its own thumbnails.

  • Browz Environment: select the region matching your Cuez organization, for example US East or EU Central.

  • Polling Interval: how often the Gateway checks the folder, in milliseconds. 2000 (2 seconds) is a good starting point.

Once saved, the device generates its own Browz Authentication Token automatically. Copy this for the next step.

Step 6 - Create the Media Library in Cuez (Organization Owner)

In Cuez, go to Organization Settings > Media Library > Add media library. Give it a name, set the Type to match your setup, and paste in the Browz Authentication Token from step 5.

For the Browz Socket Region, fill out your selection from step 5, all lowercase.

(us-east for example)

Step 7 - Reconnect and test

Back in the Gateway app, toggle the device off and back on to apply the settings. The status indicator should turn green.

Drop a small test video file into the watch folder (avoid a large file for this first test) and confirm it appears in the Media Library in Cuez, with a thumbnail and a working preview.

Step 8 - Keep it running

Optionally add the Gateway to your computer's startup apps so it relaunches automatically after a reboot. This keeps your watch folder connected without needing to remember to reopen it.

Once set up, any file placed in your watch folder will automatically appear in Cuez, ready to use in your rundown.

Troubleshooting

  • Gateway won't open, or "Open GUI" shows a blank or unreachable page: another application is likely already using that port. Change the port in the Gateway settings and restart the app.

  • "Invalid data found" or "Unable to process event" errors: the Gateway tried to read a file before it had finished copying into the watch folder. Move completed files into the watch folder rather than copying them in, or raise the Polling Interval so the Gateway waits longer between checks.

  • "Permission denied" errors while processing video: on Windows, relaunch the Gateway app as Administrator.

  • "Folder doesn't exist" errors: double check the Folder Path to Watch points to the correct network path, not a local drive letter that only exists on a different machine.

  • Status is green but no files show up in Cuez: confirm you pasted the correct Browz Authentication Token when creating the Media Library, and that you're dropping files into the exact folder configured in the device, not a different one.


Did this answer your question?