This section contains everything you need to know about installing and managing the iconik Storage Gateway (ISG)
Roles
These are the roles that are needed:
- Owner
1. Download and install the Iconik Storage Gateway
Set up the Iconik Yum repository, and install the Iconik Storage Gateway RPM
sudo tee -a /etc/yum.repos.d/iconik.repo >/dev/null << EOF
[iconik]
name=Packages - Amazon Linux 2023 \$basearch
baseurl=https://packages.iconik.io/rpm/al2023/\$basearch/
enabled=1
gpgkey=https://packages.iconik.io/rpm/iconik_package_repos.asc
gpgcheck=1
EOF
sudo yum install iconik_storage_gateway
2. Edit config.ini
Edit /etc/iconik/iconik_storage_gateway/config.ini to look like this (See Setting up how to get the correct values)
[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 = 5
max-transcoding-jobs = 5
log-filename = /var/log/iconik/iconik_storage_gateway/default.log
log-use-colors = true
forbidden-dirs = /;//;/etc/*;/dev/*;/cores/*;/bin/*;/sbin/*;/usr/*;/boot/*;/lib/*;/proc/*;/root/*;/run/*;/sys/*
image-magick-config = /etc/iconik/iconik_storage_gateway/image_magick_config
file-upload-parallel-uploads-num = 4
file-download-parallel-downloads-num = 4
missing-files-time-threshold = 60
sqlite-journal-mode = wal
#imagemagick-layer-extensions = .tiff,.tif,.png,.psd,.pdf,.psb
#image-extensions-override = .cr3,.raf,.tif,.tiff,.heic,.hdr
3. Start the service
Iconik Storage Gateway will add a system user called iconik that will be used to run systemd service. The iconik user must have permissions to read/write the storage mount point folder and it contents. You can add the Iconik user to a Group (legacy) or Team to manage permissions on Group/Team level instead.
After installation you can start service with:
sudo systemctl enable iconik_storage_gateway
sudo systemctl start iconik_storage_gateway
To check status of the service use:
sudo systemctl status iconik_storage_gateway
For following the log file, you can use the following command:
sudo tail -f /var/log/iconik/iconik_storage_gateway/default.log
You can run also run the systemd service from your custom user by providing an override (sudo systemctl edit iconik_storage_gateway.service) passing your own config and log files that are accessible for your custom user. Log file location can also be set in config.
[Service]
User=john
Group=john
ExecStart=
ExecStart=/usr/bin/iconik_storage_gateway --config=/home/john/iconik_storage_gateway/config.ini --log-filename=/home/john/iconik_storage_gateway/default.log
You will need to give your new user permissions to the database file and the log directory as well (If you didn't change the logs)
sudo chown -R john:john /var/iconik/iconik_storage_gateway/
sudo chown -R john:john /var/log/iconik/iconik_storage_gateway/
After adding your custom user you need to restart service.
sudo systemctl daemon-reload
sudo systemctl restart iconik_storage_gateway
Local transcoding
Local transcoding is required for viewing your content in the web browser
For local transcoding to work ffmpeg and ImageMagick must be available. Versions of ffmpeg and imagemagick are included as separate binaries in the ISG package, if you would like use other versions make sure the ffmpeg and magick commands are available on the path of the user running the service.
To get frame accurate playback in other browsers than Safari you also need mp4mux from Bento4.
You can download binaries from https://www.bento4.com/downloads/ but the latest version does not work properly on Amazon Linux 2023. Please use the version available at http://zebulon.bok.net/Bento4/binaries/Bento4-SDK-1-5-1-628.x86_64-unknown-linux.zip instead.
Unpack the correct package, and copy the mp4mux binary to /usr/local/bin
To write xmp metadata which can be used in our adobe integration to the proxy files you need Exiftool. Exiftool is not available on amazonlinux repos, but can be downloaded from https://exiftool.org, you will also need to install perl
Update the storage settings in Iconik to enable local transcoding and restart the service.
More information for Administrators
- Administrator’s Quick Start
- Application Tokens for managing keys for giving authorization to use Iconik