2.0
MyraSecurity, CDN
en
coding. powerful. systems. CPS GmbH
This document is published under the Open Content License available from http://www.opencontent.org/opl.shtml
The content of this document is related to TYPO3, a GNU/GPL CMS/Framework available from www.typo3.org.
This covers extension setup and TYPO3 feature options.
Most settings are made in Admin Tools > Settings > Extension Configuration > myra_cloud_connector.
Configuration values can be set as text or parsed from environment values:
Every configuration value that starts with
ENV= will be parsed and the provided
environment variable will be used.
Example syntax:
ENV=MYRA_API_KEY
getenv('MYRA_API_KEY') Myra API setup
The Myra Cloud API endpoint for every request.
A Myra Cloud User API key (the user needs permissions to clear the domain cache).
The matching secret for the API key.
To link TYPO3 with Myra Cloud, it's necessary to announce the used Myra Cloud Domains for a TYPO3 Site Entity. This can be done in Site Management > Edit [SiteXYZ] > Myra Cloud > Myra Domain List.
The configuration field accepts a comma separated list of all Myra domains. These are the domains which are supported by this particular site. You can find the correct names in the Myra Cloud Backend.
Toggle TYPO3 features.
If checked, this prevents any Myra Cloud cache clear request and disables all UI elements if the
application context is not
Production*. This is useful to prevent clear requests from stage
or development instances.
If checked, all UI Elements are disabled for non-admin users.
Note
Auto-clear hooks (page update / file list replace) are not affected by this.
If checked, both auto-clear hooks (page update and file list replace) are disabled.
A comma separated blacklist of domain names to prevent any Myra Cloud clear cache request and disable all UI elements if TYPO3 is used from a domain in this list.
Note
This does not affect the CLI command.
The extension inserts GUI options to clear pages and files from the Myra cache:
There are 4 ways to clear a page from the cache:
Note
Apart from the topbar clear cache menu, the page clear cache options clear a single page only and are non-recursive.
Clear the entire page cache or file cache
This option is admin-only by default. To allow for non-admin users, set user permissions accordingly.
If the menu option does not appear, check for missing Myra credentials and the setting of the feature flags:
This will clear the selected page only (no child pages). The option will not clear file resources.
This will clear the current page only (no child pages). The option will not clear file resources.
There are 4 ways to clear files from the cache:
Note
The file tree clear cache commands on folders are recursive.
Clear the entire page cache or file cache
This option is admin-only by default. To allow for non-admin users, set user permissions accordingly.
If the menu option does not appear, check for missing Myra credentials and the setting of the feature flags:
This will clear all files from the selected directory and all its subdirectories recursively.
This will clear the selected file only.
Hooks and CLI command.
Two AutoClear hooks are implemented:
Note
This hook listens on the
Data interface.
It will only clear the page itself, when the page or its elements are edited (created/updated/deleted). It will not clear subpages and file resources (non-recursive).
Using the option "Replace" in FileList will trigger this hook. This also clears processed files from the cache.
The command is based on a Symfony command and is only accessible via CLI (not via scheduler)
vendor/bin/typo3 myracloud:clearmyracloud:clear [options]
myracloud:clear -t page -i [PAGE_UID like: 123]
myracloud:clear -t resource -i [PATH like: /fileadmin/path/To/Directory]
myracloud:clear -t resource -i [PATH like: /assets/myCustomAssets/myScript.js]
myracloud:clear -t resource -i [PATH like: /fileadmin/path/ToFile.jpg]
myracloud:clear -t all
myracloud:clear -t allresources-t, --type=TYPE
page
resource
all
allresourcespage type requires a page identifier (pid) -i 1. the pid must be
numeric.
Note
page clear commands are never recursive.
resource type requires a combined identifier -i 1:/path/to/something.
Note
resource clear commands are always recursive.
Note
The resource type can also be used to clear pages. Simply provide the site URI (this will be recursive!).
allresources type requires NO extra option.
This will clear everything from these folders :
/fileadmin/*/typo3/*/typo3temp/*/typo3conf/*Note
The allresources clear command is recursive by default.
all type requires no extra option.
This clears everything in Myra Cache for this TYPO3 Instance.
Note
The all clear command is recursive by default.
All ClearCache request will be added into the sys_log database.
