[Redirect]https://help.themehouse.com/docs/image-optimizer/getting-started-with-image-optimizer [/Redirect]

Thank you for your interest in [TH] Image Optimizer! Here you will find documentation for Installing [TH] Image Optimizer, Setting up Image Optimizer, Options, Providers, Status queue, and Permission. If you need something specifically explained, please feel free to get in touch. Automatically optimize any image uploaded to your forum. Compress your photos to save storage space and bandwidth and improve your website's load time. Image Optimizer supports Kraken.io, Resmush.it, jpegoptim, and pngquant. You will need to have an active subscription on Kraken.io to use Kraken.io with Image Optimizer. To use Pngquant and Jpegoptim with Image Optimizer you must install them on your server.

Install & Upgrade (Recommended) To install using Install & Upgrade, please refer to the Install & Upgrade documentation. Manual Installation Your first step is to download the add-on from your customer area. You will be asked to provide some information before downloading. Once you download, save the .zip file somewhere you are familiar with. Next, you will want to extract the files. After that is done you will need to upload the contents inside the upload folder into your root XenForo directory. After you have uploaded the files you will need to navigate to the Add-ons section within your XenForo admin panel. Here you will see it listed under 'Installed add-ons'. Just click Install! Congratulations! You have officially installed the Image Optimizer add-on on your site. ZIP Upload (XenForo 2.1. and higher) Your first step is to download the add-on from your customer area. You will be asked to provide some information before downloading. Once you download, save the .zip file somewhere you are familiar with. After you have downloaded the file, you will need to navigate to the Add-ons section within your XenForo admin panel. Click “Install/upgrade from archive” and follow the on screen instructions. When asked for an add-on archive, select the previously downloaded file. Congratulations! You have officially installed the Image Optimizer add-on on your site. If you need assistance getting the add-on installed or would prefer us to handle it for you, you can create a ticket.

Here is a basic guide to setting up Image Optimizer. For more information on each section, please navigate to the corresponding pages in the documentation. Set up providers by navigating to Admin Control Panel -> Content -> Image optimizer -> Providers. Review and make any necessary setting changes to Options by navigating to Admin Control Panel -> Content -> Image optimizer -> Options. View which images have been optimized, how much storage space was saved, and which provider was used in the Status queue by navigating to the Admin Control Panel -> Content -> Image optimizer -> Status queue. Optimize Pre-existing Images To optimize pre-existing images, navigate to ACP -> Tools -> Data maintenance -> Rebuild caches -> Optimize images. You can then choose which content type you want to optimize: (All), Attachments, Proxied images, or User avatars. You can also set how many items are optimized per page.

General Image Optimizer options can be found in your XenForo Admin Control Panel -> Setup -> Options -> [TH] Image optimizer. You can also navigate to options by going to Admin Control Panel -> Content -> Image optimizer -> Options. Optimize images when they’re uploaded - When this option is unchecked, images will be optimized via a cron that runs automatically. If this cron is unable to keep up with new images that are uploaded or causes server load issues it is recommended that you enable this option. Log informational errors - When enabled, additional informational messages will be logged into your XenForo error log. It is recommended to disable this option after everything is configured. Secret Key - The key shown is used to secure “th_imageoptimizer.php” which is used to render the image to some image optimization providers. Disabled content types - Content types selected here will not have their images optimized. If none are selected any images uploaded within these content types will be optimized.

Providers can be set up by navigating to Admin Control Panel -> Content -> Image optimizer -> Providers. The following providers are supported with this add-on: Gifsicle Pngquant Jpegoptim Kraken.io reSmush.it To configure a provider, click the “Configure” link next to the provider you would like to configure. Options for Configuring Gifsicle Priority - This option allows you to choose the order in which providers are attempted. Providers with a lower value will execute first. Supported image types - Allow image/gif image types to be supported or not supported during optimization. Binary path - The path to the binary for this provider. If it is in your $PATH you may be able to leave this value as default. If you’re unsure of what this value should be your host or sysadmin should be able to provide more information. The following options are passed to the gifsicle binary. You can find details on each of these options here. Lossiness - The quality loss threshold of the conversion. Higher value means less quality at the expense of better preserved space. Optimization mode - The optimization mode that Gifsicle will use to optimize images. Options for Configuring Pngquant Priority - This option allows you to choose the order in which providers are attempted. Providers with a lower value will execute first. Supported image types - Allow image/png image types to be supported or not supported during optimization. Options - Choose to make the provider active or inactive. Binary path - The path to the binary for this provider. If it is in your $PATH you may be able to leave this value as default. If you’re unsure of what this value should be your host or sysadmin should be able to provide more information. The following options are passed to the pngquant binary. You can find details on each of these options here. Minimum quality - The minimum quality of the image (Value from 1-100). Maximum quality - The maximum quality of the image (Value from 1-100). Speed - The speed of the optimization. 1 is faster but will not reduce the filesize as much, while 10 will be much slower and have a greater reduction in file size. Options for Configuring Jpegoptim Priority - This option allows you to choose the order in which providers are attempted. Providers with a lower value will execute first. Supported image types - Allow image/jpeg image types to be supported or not supported during optimization. Options - Choose to make the provider active or inactive. Binary path - The path to the binary for this provider. If it is in your $PATH you may be able to leave this value as default. If you’re unsure of what this value should be your host or sysadmin should be able to provide more information. Maximum quality - The maximum quality of the image (Value from 1-100). Strip EXIF data - Choose if you want to remove EXIF metadata. Strip IPTC data - Choose if you want to remove IPTC metadata. Options for Configuring Kraken.io Priority - This option allows you to choose the order in which providers are attempted. Providers with a lower value will execute first. Supported image types - Allow gif, jpeg, and png based images to be supported or not supported during optimization. Options - Choose to make the provider active or inactive. API Key - Enter Kraken.io API key. API Secret - Enter Kraken.io API Secret. Optimize type - Choose an optimization type. Lossless - The image will remain the same but the file size will not be as small as if Lossy was chosen. To learn more please click here. Lossy - The file size will be smaller than if Lossless was chosen but may change the image. To learn more please click here. Preserve metadata - Choose if you would like any of the metadata to be preserved. To learn more please click here. Options for Configuring reSmush.it Priority - This option allows you to choose the order in which providers are attempted. Providers with a lower value will execute first. Supported image types - Allow multiple types of image types which include gif, jpeg, png, and bmp based images. Options - Choose to make the provider active or inactive. Preserve EXIF - Choose if you want to preserve EXIF metadata.

In the status queue, you can view which images have been optimized, how much storage space was saved, and which provider was used. Navigate to the Status queue by going to the Admin Control Panel -> Content -> Image optimizer -> Status queue.

Administrator Permission The “Manage [TH] Image Optimizer providers” administrator permission can be set.