This section contains everything you need to know about installing and managing the iconik Storage Gateway (ISG) on MacOS.
ISG is supported on the latest three MacOS versions, older versions are unsupported but may work. It is a Universal binary supporting both Intel and Apple Silicon (M1/M2)
Roles
These are the roles that are needed:
- Owner
Local transcoding
Local transcoding is required for viewing your content in the web browser
ISG comes packaged with FFmpeg and ImageMagick for local transcoding. For keyframe generation of PDF documents poppler is required, see installation instructions below.
Use of packaged transcoders can be controlled through the config.ini attributes:
use-packaged-imagemagick = true
use-packaged-ffmpeg = true
Using custom ffmpeg and imagemagick
Set above options to "false" if you need to use a specific version or a custom build of ffmpeg and/or imagemagick.
For local transcoding to work you will have to install ffmpeg, ghostscript and ImageMagick. Make sure they are in the path for the user running the service.
- https://www.ffmpeg.org/download.html
- https://www.imagemagick.org/script/download.php
- We recommend installing ghostscript using Brew as detailed below but the source is available at: https://ghostscript.com/releases/gsdnld.html
To get frame accurate playback in other browsers than Safari you also need mp4mux from Bento4
https://www.bento4.com/downloads/
To write xmp metadata which can be used in our adobe integration to the proxy files you need Exiftool
https://exiftool.org/install.html#MacOS
The easiest way to install these transcodes is to use a package manager like brew. Follow the instructions below to install brew, and then install the transcoders.
Step 1: Open Terminal
- Press Command (⌘) + Space, type "Terminal", and press Enter.
Step 2: Install Homebrew
Paste the following command into Terminal and press Enter:
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"- This script downloads and installs Homebrew.
- It will ask for your system password.
- Follow the on screen instructions
Step 3: Verify Installation
Check that Homebrew is installed by running:
brew --version
Example output:
Homebrew 4.x.x
If `brew` is not found: Add Homebrew to your PATH manually
Depending on your system, you may need to add Homebrew to your shell profile.
For Apple Silicon (M1/M2):
echo 'eval "$(/opt/homebrew/bin/brew shellenv)"' >> ~/.zprofile
source ~/.zprofile
For Intel Macs:
echo 'eval "$(/usr/local/bin/brew shellenv)"' >> ~/.zprofile
source ~/.zprofile
Step 4: Install the transcoders
To install the local transcoders, run the command below:
brew install ffmpeg imagemagick
install additional utilities with
brew install bento4 poppler ghostscript exiftool
Step 5: Verify that the transcoders are in the system path
Open the terminal app and run the commands below. The output should show the transcoder version.
-
-
-
ffmpeg -version -
magick -version -
exiftool -ver
-
-
Download and install the Iconik Storage Gateway
https://downloads.iconik.io/IconikStorageGateway-latest.pkg
This will install the ISG and the Mac Tray application. The first time it will automatically start the Setup Wizard.
- The first step will ask you to log in to iconik using the Web interface. Once that is done and you approve the application to use your credentials, go back to the installer.
- Then select “Setup new iconik Storage Gateway” and press Next
- Give it a name that makes it possible to identify it (Default is your computer name followed by ISG)
- Select the Mount point that you want to scan.
- Optionally add scan directories if you want to limit the scanner scope to a specific list of paths and press Next.
- Setup ignore patterns to avoid ingest of certain files and/or folders and press Next.
- This will set the ISG up to use Local transcoding and not keep the original files locally. If you want to use any other settings, please click “Advanced Settings..” and that will take you to the Storage configuration page.
- Toggle on the "Start ISG after setup" checkbox if you want to start ISG after you press Finish.
- When you are done with your advanced settings press Finish.
The Tray application is visible as an iconik icon in your top navigation bar on you Mac, where you can access the menu to start/stop the service, as well as getting to the configuration and viewing the logs.
Advanced configuration without the Tray application
ISG will install its config files in /Library/Application Support/Cantemo/IconikStorageGateway where you will find config.ini
Unload the service for now.
sudo /bin/launchctl unload "/Library/LaunchDaemons/com.cantemo.IconikStorageGateway.plist"
Edit config.ini to look like this
[main]
app-id = 22f34c6e-268e-11e7-ac53-6c4008b85488
storage-id = 15fa3f68-7693-11e7-bf0c-02420a021013
iconik-url = https://app.iconik.io/
auth-token = eyJhbGciOiJIUzI1NiIsImlhdCI6MTUwMTU3NjAyNCwiZXhwIjoxNTAxNjE5MjI0fQ.eyJpZCI6IjMzMjFkMjIyLTc2OTMtMTFlNy1hN2EyLTAyNDIwYTAyMTAxYSJ9.sgag4OQb19J9qT1IAdKZYAqbpIoai7oW60Mahye7o8s
sleep-time = 10
max-transcoding-jobs = 1
file-upload-parallel-uploads-num = 4
file-download-parallel-downloads-num = 4
log-filename = /Library/Logs/Cantemo/IconikStorageGateway/default.log
Start the service
sudo /bin/launchctl load "/Library/LaunchDaemons/com.cantemo.IconikStorageGateway.plist"
Logs
For following the log file, you can use the following command:
sudo tail -f /Library/Logs/Cantemo/IconikStorageGateway/default.log
Additional logs are available here, organised by Storage ID:
/Library/Logs/Cantemo/IconikStorageGateway/
Control access to files and folders on Mac
These Mac folders require special rights: Desktop, Downloads and Documents folders. You can control this in System Settings under Privacy & Security > Files and Folders. Turn the ability to access files and folders in a required location for iconik Storage Gateway application.
More information on Mac official help pages.
Installation guides per platform:
More information for Administrators
- Administrator’s Quick Start
- Application Tokens for managing keys for giving authorization to use iconik