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

FAQ for iconik Storage Gateway

iconik Storage Gateway (ISG)

See all 19 articles

Table of Contents:

  1. What is the Iconik Storage Gateway
  2. Can I show the folders and directories of my storage
  3. Can I map the directories to collections
  4. Can I set up multiple mount points
  5. Can I ignore certain file types or paths
  6. Can I index an external NAS or SAN device
  7. Can I make sure that all files that the ISG finds are uploaded into the cloud
  8. Where can I find out what version of the ISG I am running
  9. Will changes I make in the ISG’s storage page automatically apply
  10. Where can I find the logs from the ISG
  11. How can I configure my ISG to use an HTTP Proxy
  12. How can I the following signatures were invalid error for Ubuntu
  13. Can I rename files managed by the ISG
  14. How can I upgrade existing ISG
  15. Can I migrate an existing ISG to a new system
  16. What happens if a file is moved on an ISG
  17. Can I authenticate the ISG using Single Sign-On (SSO)

What is the iconik Storage Gateway (ISG).

Please refer to the knowledgebase article What is iconik Storage Gateway.

Can I show the folders and directories of my storage?

Yes, the usual way of doing this is using collections and turning on Collection Directory Mapping in your storage settings for your iconik Storage Gateway. Then all your folders under the mount point will be mapped to collections under a master collection called “Storage Gateways”.

Can I map the directories to collections?

Yes, this is the same as the answer above, it’s possible to do this from the storage administration page by selecting Collection Directory Mapping

Can I setup multiple mount points?

Currently, we do not enable this feature but it’s on our roadmap. Instead you could choose a directory above and have multiple scan directories.

Can I ignore certain file types or paths?

Yes, by using the Ignore Files Patterns on the configuration for your iconik Storage Gateway’s storage configuration. Please see iconik Storage Gateway Administration for more details.

Can I index an external NAS or SAN device?

As long as you have a computer or server on which you can both run the ISG and mount the NAS or SAN device permanently. It’s very important that the mount is permanent whilst the ISG is running.

Can I make sure that all files that the ISG finds are uploaded into the cloud?

Yes, it’s possible by turning on Upload Original from the storage administration page for your iconik Storage Gateway.

Where can I find out what version of the ISG I am running?

Log in to iconik as an Administrator, go to the storage page for the ISG and click on logs. The version number will be at the top.

Will changes I make in the ISG’s storage page automatically apply

If you are running an ISG that was released in October 2019 or later then you shouldn’t need to restart the ISG manually. The ISG will fetch updated settings from the iconik application when they are modified.

Where can I find the logs from the ISG?

This is platform dependant, and you will be able to find the logs in these locations depending on which platform you run your ISG on:

  • Windows - C:\ProgramData\Cantemo\IconikStorageGateway
  • MacOS - /Library/Logs/Cantemo/IconikStorageGateway
  • Linux - /var/log/iconik/iconik_storage_gateway

How can I configure my ISG to use an HTTP Proxy?

In some network configurations you will need to configure the ISG to connect to iconik via an HTTP Proxy. This happens when the local network administrators prevent unrestricted access to the internet and force connections through a dedicated proxy. In general, you configure a HTTP Proxy for the ISG by setting the Environment Variables http_proxy and https_proxy to the url of your proxy server. For example you can set them both to http://proxy.example.com:8080 if that is the address to your proxy.

Exactly how to configure this is dependant on the platform which the ISG is configured on.

Windows

On Windows, you can configure this by editing the registry. The registry is Windows’ built in configuration store. You need to add a REG_MULTI_SZ registry key called HKLM\SYSTEM\CurrentControlSet\Services\IconikStorageGateway\Environment which contains the following:

http_proxy=http://proxy.example.com:8080 https_proxy=http://proxy.example.com:8080

This can be either be done by using the regedit GUI tool or by running the following command as an administrator user:

REG ADD "HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\IconikStorageGatewayService" /v "Environment" /t REG_MULTI_SZ /d "http_proxy=http://proxy.example.com:8080\0https_proxy=http://proxy.example.com:8080"

MacOS

On MacOS, the global proxy settings are used for the ISG. To configure this open System Preferences and go to Network -> Advanced -> Proxies and configure Web Proxy and Secure Web Proxy with the proxy settings required on your network.

MacOS Proxy Configuration

Linux

On Linux you need to configure systemd to pass the environment variables along to the ISG. This can be done by creating a file called /etc/systemd/system/iconik_storage_gateway.service.d/http_proxy.conf with the following content:

[Service] Environment=http_proxy=http://proxy.example.com:8080 Environment=https_proxy=http://proxy.example.com:8080

After this file is created you can reload the configuration with the command systemctl daemon-reload and then restart the ISG with systemctl restart iconik_storage_gateway

Can I Rename files managed by the ISG

If you have the setting “Consider identical files the same” turned on then files can be renamed as you like.

How can I the following signatures were invalid error for Ubuntu

For Ubuntu 18/20:

curl https://packages.iconik.io/deb/ubuntu/dists/focal/iconik_package_repos_pub.asc | sudo apt-key add -

For Ubuntu 22:

curl https://packages.iconik.io/deb/ubuntu/dists/jammy/iconik_package_repos_pub.asc |\ gpg --dearmor -o /usr/share/keyrings/iconik.gpg

Make sure to select to overwrite the file.

How can I upgrade existing ISG

Ubuntu: apt-get update && apt-get install iconik-storage-gateway

Amazon Linux 2: yum update iconik_storage_gateway

Enterprise Linux: dnf update iconik_storage_gateway

Mac OS & Windows: download the latest package and run installation again.

Can I migrate an existing ISG to a new system?

Yes, you can migrate an existing ISG to a new host machine. To do so, follow the steps below:

  • Shut down the old ISG
    Ensure the ISG is fully stopped before proceeding.

  • Install the ISG on the new machine
    Download and install the latest version of the Iconik Storage Gateway.

  • Move the local database (files.db)
    Copy the files.db from the old system to the corresponding location on the new one.
    File locations by OS:

    • macOS:
      /Library/Application Support/Cantemo/IconikStorageGateway/Data/{storage_id}/files.db

    • Linux:
      /var/iconik/iconik_storage_gateway/{storage_id}/files.db

    • Windows:
      C:\ProgramData\Cantemo\IconikStorageGateway\Data\{storage_id}\files.db

  • Edit the config.ini file
    Update the new ISG’s config.ini to use the same:

    • storage_id

    • app_id and auth_token
      These must belong to the same user or a user with equivalent access.

  • Install required third-party transcoders
    Make sure all necessary local transcoders (e.g., FFmpeg) are installed and accessible on the new system.

  • Update the mount point
    Set the mount point in the storage configuration to reflect the correct volume on the new machine.

    Ensure the relative file paths remain unchanged. If the path structure is different, the new ISG might ingest existing files as new and mark previously ingested files as missing.

  • Start the new ISG
    Launch the ISG and verify connectivity and scan behavior.

⚠️ Important Note

Windows-based ISGs can only be migrated to other Windows systems because of differences in file-path separators and system conventions. In practice, this means you can migrate between Linux and macOS, but you cannot migrate a Windows ISG to Mac or Linux, nor migrate a Mac/Linux ISG into Windows.

What happens if a file is moved on an ISG?

When the file is moved, the file on the asset will show as missing, but the next time the ISG is scanned, the file will be re-ingested along with the new folder structure it was placed in. Whether or not the newly ingested file gets put on the existing asset is determined by the "Consider identical files the same" on the storage settings.

If it's turned on, the newly ingested file will get added to the asset that already exists as a new original format with it's new location. If it's turned off, a new asset will be created.

Can I authenticate the ISG using Single Sign-On (SSO)?

The ISG does not directly support logging in via SSO because the authentication process for the ISG uses the tracking token from the web browser. The typical flow that users take to authenticate the ISG is first to sign into iconik via SSO, then go through the installation flow on the ISG. This will redirect them to the active iconik tab where they can approve the authentication.

Alternatively, you can create an access token under Settings -> Application Tokens and add the auth-token and app-id values to the config file. You will need to restart the ISG service after making this change if the ISG is already running.