.. include:: /Includes.rst.txt .. index:: TYPO3_CONF_VARS; GFX TYPO3_CONF_VARS GFX .. _typo3ConfVars_gfx: ============================ GFX - graphics configuration ============================ The following configuration variables can be used to configure settings for the handling of images and graphics: .. contents:: :local: .. note:: The configuration values listed here are keys in the global PHP array :php:`$GLOBALS['TYPO3_CONF_VARS']['GFX']`. This variable can be set in one of the following files: * :ref:`config/system/settings.php ` * :ref:`config/system/additional.php ` .. index:: TYPO3_CONF_VARS GFX; thumbnails .. _typo3ConfVars_gfx_thumbnails: thumbnails ========== .. confval:: $GLOBALS['TYPO3_CONF_VARS']['GFX']['thumbnails'] :type: bool :Default: true Enables the use of thumbnails in the backend interface. .. index:: TYPO3_CONF_VARS GFX; imagefile_ext .. _typo3ConfVars_gfx_imagefile_ext: imagefile_ext ============= .. versionadded:: 13.0 "webp" has been added to the list of default image file extensions. If the underlying ImageMagick / GraphicsMagick library is not built with WebP support, the server administrators can install or recompile the library with WebP support by installing the "cwebp" or "dwebp" libraries. .. confval:: $GLOBALS['TYPO3_CONF_VARS']['GFX']['imagefile_ext'] :type: list :Default: 'gif,jpg,jpeg,tif,tiff,bmp,pcx,tga,png,pdf,ai,svg,webp' Comma-separated list of file extensions recognized as images by TYPO3. List should be set to :php:`'gif,png,jpeg,jpg,webp'`, if ImageMagick / GraphicsMagick is not available. .. caution:: The file extensions must be in lowercase and there must be no spaces between the commas and the file extensions! .. index:: TYPO3_CONF_VARS GFX; .. _typo3ConfVars_gfx_processor_enabled: processor_enabled ================= .. confval:: $GLOBALS['TYPO3_CONF_VARS']['GFX']['processor_enabled'] :type: bool :Default: true Enables the use of Image- or GraphicsMagick. .. index:: TYPO3_CONF_VARS GFX; processor_path .. _typo3ConfVars_gfx_processor_path: processor_path ============== .. confval:: $GLOBALS['TYPO3_CONF_VARS']['GFX']['processor_path'] :type: text :Default: '/usr/bin/' Path to the IM tools convert, combine, identify. .. index:: TYPO3_CONF_VARS GFX; processor .. _typo3ConfVars_gfx_processor: processor ========= .. confval:: $GLOBALS['TYPO3_CONF_VARS']['GFX']['processor'] :type: dropdown :Default: 'ImageMagick' :allowedValues: ImageMagick Choose ImageMagick for processing images GraphicsMagick Choose GraphicsMagick for processing images Select which external software on the server should process images - see also the preset functionality to see what is available. .. index:: TYPO3_CONF_VARS GFX; processor_effects .. _typo3ConfVars_gfx_processor_effects: processor_effects ================= .. confval:: $GLOBALS['TYPO3_CONF_VARS']['GFX']['processor_effects'] :type: bool :Default: false If enabled, apply blur and sharpening in ImageMagick/GraphicsMagick functions .. index:: TYPO3_CONF_VARS GFX; processor_allowUpscaling .. _typo3ConfVars_gfx_processor_allowUpscaling: processor_allowUpscaling ======================== .. confval:: $GLOBALS['TYPO3_CONF_VARS']['GFX']['processor_allowUpscaling'] :type: bool :Default: true If set, images can be scaled up if told so (in :php:`\TYPO3\CMS\Core\Imaging\GraphicalFunctions`) .. index:: TYPO3_CONF_VARS GFX; processor_allowFrameSelection .. _typo3ConfVars_gfx_processor_allowFrameSelection: processor_allowFrameSelection ============================= .. confval:: $GLOBALS['TYPO3_CONF_VARS']['GFX']['processor_allowFrameSelection'] :type: bool :Default: true If set, the [x] frame selector is appended to input filenames in stdgraphic. This speeds up image processing for PDF files considerably. Disable if your image processor or environment cant cope with the frame selection. .. index:: TYPO3_CONF_VARS GFX; .. _typo3ConfVars_gfx_processor_stripColorProfileByDefault: processor_stripColorProfileByDefault ==================================== .. confval:: $GLOBALS['TYPO3_CONF_VARS']['GFX']['processor_stripColorProfileByDefault'] :type: bool :Default: true If set, the processor_stripColorProfileCommand is used with all processor image operations by default. See tsRef for setting this parameter explicitly for IMAGE generation. .. index:: TYPO3_CONF_VARS GFX; processor_stripColorProfileCommand .. _typo3ConfVars_gfx_processor_stripColorProfileCommand: processor_stripColorProfileCommand ================================== .. versionchanged:: 11.5.35/12.4.11 This string-based configuration option has been superseded by :ref:`$GLOBALS['TYPO3_CONF_VARS']['GFX']['processor_stripColorProfileParameters'] ` for `security reasons `__. .. confval:: $GLOBALS['TYPO3_CONF_VARS']['GFX']['processor_stripColorProfileCommand'] :type: string This option expected a string of command line parameters. The defined parameters had to be shell-escaped beforehand, while the new option :ref:`typo3ConfVars_gfx_processor_stripColorProfileParameters` expects an array of strings that will be shell-escaped by TYPO3 when used. The existing configuration will continue to be supported. Still, it is suggested to use the new configuration format, as the Install Tool is adapted to allow modification of the new configuration option only: .. code-block:: php // Before $GLOBALS['TYPO3_CONF_VARS']['GFX']['processor_stripColorProfileCommand'] = '+profile \'*\''; // After $GLOBALS['TYPO3_CONF_VARS']['GFX']['processor_stripColorProfileParameters'] = [ '+profile', '*' ]; .. index:: TYPO3_CONF_VARS GFX; processor_stripColorProfileParameters .. _typo3ConfVars_gfx_processor_stripColorProfileParameters: processor_stripColorProfileParameters ===================================== .. versionchanged:: 11.5.35/12.4.11 .. confval:: $GLOBALS['TYPO3_CONF_VARS']['GFX']['processor_stripColorProfileParameters'] :type: array of strings :Default: :php:`['+profile', '*']` Specifies the parameters to strip the profile information, which can reduce thumbnail size up to 60KB. Command can differ in IM/GM, IM also knows the :bash:`-strip` command. See `imagemagick.org `__ for details. .. index:: TYPO3_CONF_VARS GFX; processor_colorspace .. _typo3ConfVars_gfx_processor_colorspace: processor_colorspace ==================== .. versionchanged:: 13.0 The setting defaults to an empty value and - if not changed - is adjusted automatically to the recommended colorspace for the given processor ("sRGB" for ImageMagick, "RGB" for GraphicsMagick). .. confval:: $GLOBALS['TYPO3_CONF_VARS']['GFX']['processor_colorspace'] :type: text :Default: '' Specifies the colorspace to use. Defaults to "RGB" when using GraphicsMagick as :ref:`processor ` and "sRGB" when using ImageMagick. .. note:: Images would be rendered darker than the original when using ImageMagick in combination with "RGB". Possible values: CMY, CMYK, Gray, HCL, HSB, HSL, HWB, Lab, LCH, LMS, Log, Luv, OHTA, Rec601Luma, Rec601YCbCr, Rec709Luma, Rec709YCbCr, RGB, sRGB, Transparent, XYZ, YCbCr, YCC, YIQ, YCbCr, YUV .. index:: TYPO3_CONF_VARS GFX; processor_interlace .. _typo3ConfVars_gfx_processor_interlace: processor_interlace =================== .. confval:: $GLOBALS['TYPO3_CONF_VARS']['GFX']['processor_interlace'] :type: text :Default: 'None' Specifies the interlace option to use. The result differs in different GM / IM versions. See manual of GraphicsMagick or ImageMagick for right option. Possible values: None, Line, Plane, Partition .. index:: TYPO3_CONF_VARS GFX; jpg_quality .. _typo3ConfVars_gfx_jpg_quality: jpg_quality =========== .. versionadded:: 13.0 Lowest quality can be "1". Previously the lowest quality setting was "10". .. confval:: $GLOBALS['TYPO3_CONF_VARS']['GFX']['jpg_quality'] :type: int :Default: 85 :Allowed values: Between 1 (low quality, small file size) and 100 (best quality, large file size) Default JPEG generation quality .. index:: TYPO3_CONF_VARS GFX; webp_quality .. _typo3ConfVars_gfx_webp_quality: webp_quality ============ .. versionadded:: 13.0 .. confval:: $GLOBALS['TYPO3_CONF_VARS']['GFX']['webp_quality'] :type: int | string :Default: 85 :Allowed values: Between 1 (low quality, small file size) and 100 (best quality, large file size), or "lossless" Default WebP generation quality. Setting the quality to "lossless" is equivalent to `"lossless" compression`_. .. _"lossless" compression: https://developers.google.com/speed/webp/docs/compression#lossless_webp .. index:: TYPO3_CONF_VARS GFX; thumbnails_png .. _typo3ConfVars_gfx_thumbnails_png: thumbnails_png ============== .. confval:: $GLOBALS['TYPO3_CONF_VARS']['GFX']['thumbnails_png'] .. versionchanged:: 13.0 This setting has been removed. Thumbnails from non-image files (like PDF) are always generated as PNG. .. index:: TYPO3_CONF_VARS GFX; gif_compress .. _typo3ConfVars_gfx_gif_compress: gif_compress ============ .. confval:: $GLOBALS['TYPO3_CONF_VARS']['GFX']['gif_compress'] .. versionchanged:: 13.0 This setting has been removed. .. index:: TYPO3_CONF_VARS GFX; processor_allowTemporaryMasksAsPng .. _typo3ConfVars_gfx_processor_allowTemporaryMasksAsPng: processor_allowTemporaryMasksAsPng ================================== .. confval:: $GLOBALS['TYPO3_CONF_VARS']['GFX']['processor_allowTemporaryMasksAsPng'] .. versionchanged:: 13.0 This setting has been removed. Temporarily saved masking images are always saved as PNG files rather than GIF images. .. index:: TYPO3_CONF_VARS GFX; gdlib .. _typo3ConfVars_gfx_gdlib: gdlib ===== .. confval:: $GLOBALS['TYPO3_CONF_VARS']['GFX']['gdlib'] .. versionchanged:: 13.0 This setting has been removed. GDLib functionality is enabled as soon as relevant `GDLib`_ classes are found. Custom code that relied on :php:`$GLOBALS['TYPO3_CONF_VARS']['GFX']['gdlib']` should instead adopt the simpler check :php:`if (class_exists(\GdImage::class))`. .. _GDLib: https://www.php.net/manual/en/book.image.php .. index:: TYPO3_CONF_VARS GFX; gdlib_png .. _typo3ConfVars_gfx_gdlib_png: gdlib_png ========= .. confval:: $GLOBALS['TYPO3_CONF_VARS']['GFX']['gdlib_png'] .. versionchanged:: 13.0 This setting has been removed. Temporary layers/masks are always saved as PNG files instead of GIF files.