iconik Storage Gateway Overview iconik Storage Gateway Overview
  1. iconik
  2. iconik Storage Gateway (ISG) & Edge Transcoder
  3. iconik Storage Gateway (ISG)

iconik Storage Gateway Overview

iconik Storage Gateway (ISG)

See all 17 articles

This section contains everything you need to know about installing and managing the iconik Storage Gateway (ISG)

Roles

These are the iconik roles that are needed:

  • admin

Overview

The iconik Storage Gateway (ISG) allows you to use your on-premise storage with iconik in the cloud.

Sync your folder structures from your local SAN, NAS or personal computer to the cloud, using fast parallel original file uploads, or using local transcoding to just upload proxies and keyframes.

The iconik Storage Gateway is compatible with:

The installation can utilize a locally installed FFMpeg, Telestream Vantage for local transcoding on all supported platforms. Our watch folder integration can also support Blackmagic Raw Proxy Generator

The requirements for the iconik Storage Gateway are documented here.

Setting up an ISG

To Administrate iconik and set up ISG you need to have Admin enabled on your user account. If you do not have Administrative access you can ask another Admin to enable it for you.

1. Install the ISG

When you first select the iconik Storage Gateway option from the Storages page, you'll be prompted to download the ISG compatible with your device.

Screenshot 2025-04-28 at 3.25.29 PM.png

For complete step-by-step guides for your operating system, please refer to the Installation section below:

There you will also learn where to find the configuration file that is referred to in this section.

*Note that the Linux installer will prompt you for the Application and Storage ID's during the installation. Once you have the installer downloaded, click Next to create the storage.

2. Set up a Storage (Not needed for MacOS)

The next step is to create a storage in iconik representing the local storage this ISG will monitor. (Note that for MacOS the configuration Wizard will manage this step for you). 

Once you have downloaded the appropriate installer based on your operating device, select "Next" to continue.

Step 1 - Setup

Screenshot 2025-04-28 at 3.48.53 PM.png

  1. Enter the purpose of the storage you’re connecting:
  • Files: stores all file types except keyframes and proxies.
  • Exports: will be used as a destination for export jobs.
  • Archive: will be used as an archive destination.
  1. Enter a unique name for your storage that will be easily recognizable for yourself and your team.
  1. Optional - enter a brief description of what this storage is used for.
  1. Enable or disable the available options:
  • Read: this will allow iconik to read files on the storage.
  • Write: this will allow iconik to write files to the storage.
  • Delete: this will allow iconik to delete files on this storage. If this is enabled, files deleted from iconik will also be deleted from this storage.
  1. Select “Next” to continue.

Step 2 - Credentials

Screenshot 2025-04-28 at 3.49.21 PM.png

  1. Enter the mount point for the file or directory you’ll be connecting iconik to.

  2. Optional - If you’d like this storage to be able to transfer to another storage over your network, enter the direct transfer address of that network or DNS name.
  1. For file or archive storages, choose whether you will enable the ability for iconik to scan for new files on the storage.
    • Optional - if Scan is enabled, you can enter specific scan directories to limit the scanning of these directories only.
      • If scan directories are specified, choose whether to enable the ability for the ISG to access but not scan additional directories within the storage.
    • If Scan is enabled, set the interval (in seconds) at which you’d like iconik to look for new and updated files in the connected system.
    • If Scan is enabled, set the how long since a file has been modified (in seconds) iconik should wait to include it in the current scan of the file system. Files that have been modified less than this amount of time ago will be included during the next scan.
    • Recommended - If Scan is enabled, you can enable the Collection Directory Mapping toggle. This will automatically mirror the folder structure within your directory to a collection structure within iconik. 

*You can customize the scan settings at any time after the storage is connected.

        4. Select “Verify” to continue.

Step 3 - Verification

Iconik will verify the credentials that you have provided. 

If verification is successful, please complete the process by selecting “Connect” and reviewing the storage settings. There may be some additional customization that you want to complete.

If verification is not successful, you can use the “Back” button to visit the previous steps and update the highlighted fields. If you’re making changes outside of iconik and want to run the verification process again, please choose “Retry”.

Step 4 - Additional Customization & Setting up Transcoders

Set the paths to scan, select if you want files to be automatically uploaded, and whether to use local transcoding, and which Group should be given access to the assets that get created

Make sure you have at least Read and Scan permissions set on the storage.

If you want to ignore some files/folders in your mounted point, add ignore patterns.

Examples:

*exclude* (match file/folder with substring exclude)

*.pdf (match file/folder that ends on .pdf)

You can also use regular expressions:

re:/^.*\.png$/ (match file/folder with .png ending)

When you are done setting everything up, you have to press Edit to be able to add local transcoders, and note the storage id.

If you want local transcoding, make sure you add the local transcoders in the transcoder panel to the right.

Note the storage_id, and put that in to the configuration file. You find this in the URL when you are editing the storage in the format 6f9c5e54-fb9f-11e7-8152-0a580a000240 or in the storage list as a button you can click to copy.

3. Creating an application Token (Not for MacOS)

The next step is to create an application and a token that the ISG will use for authenticating to Iconik In the Admin section, under Settings / Application Tokens, create a new application and select the user that the ISG will act as. Copy the App ID and Token to the corresponding places in the configuration file.

Note: The User selected in the Application is required to have asset creation permissions, and be a member of the Group you selected in the storage settings.

4. Starting ISG

Now you are ready to start the ISG. Again refer to the Installation section for your platform for information.

More information for Administrators