iconik Storage Gateway (ISG)
This section contains everything you need to know about installing and managing the iconik Storage Gateway (ISG)
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:
- Microsoft Windows: Windows 10, Windows 11, Windows Server 2016 or Windows Server 2019
- MacOS (three latest versions) Intel and Apple Silicon (M1/M2) supported.
- Linux: Amazon Linux 2, Ubuntu 20.04, Ubuntu 22.04, Ubuntu 24.04, Enterprise Linux 8, Enterprise Linux 9. For Amazon Linux 2 and Ubuntu Focal only amd64/x86-64 packages are available from our repositories, other versions also have packages for arm64.
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
The first step is to install the ISG. Please refer to the Installation section below for your operating system.
- Microsoft Windows
- Mac OS
- Amazon Linux 2
- Ubuntu 20.04
- Ubuntu 22.04
- Ubuntu 24.04
- Enterprise Linux 8
- Enterprise Linux 9
There you will also learn where to find the configuration file that is referred to in this section.
Note that the Windows installer will prompt you for the Application and Storage ID:s during the installation, so do the next steps first
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)
In the Admin section, under storages, create a new storage (See also Adding storage):
Storage Purpose
FILES
Storage Type
File
Make sure to give it a name you understand. On the next page set up the configuration of the storage
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. You can also choose to only include some files by adding include patterns. Note that directories are only matched against ignore patterns, not include patterns. Matching is done case-insensitive unless a regular expression is given.
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 pane 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
- iconik Storage Gateway FAQ
- iconik Storage Gateway Requirements
- Administrator's Quick Start
- Application Tokens for managing keys for giving authorization to use iconik
- Getting support
- Transcoders for ISG - Video and Audio
- Transcoders for ISG - Images