Static Publishing¶

What does it do?¶

Publishes pages to static files for purposes to a) speed up a website by applying Apache mod_rewrite rules to serve the static pages or b) upload a site with ftp somewhere (of course with no dynamic functionality).

It works based on the “crawler” extension queue system. It has and administration module for overview and management of published files.

Screenshots¶

From the management module:

From the process of publishing from command line:

Publishing directory¶

Simply:

• Set in localconf.php:$GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['staticp ub']['publishDir'] = '_staticpub_/';
• Create the directory “_staticpub_” in the root of the TYPO3 website (PATH_site)

You can choose another name than “_staticpub_” for your directory.

Configuring URLs to publish¶

With Page TSconfig you can configure which URLs the crawler will try to publish. Please refer to the crawler extension for a detailed understanding of this format. Its a generic one. Here is an example:

tx_crawler.crawlerCfg.paramSets {
  staticpub = &L=[|_TABLE:pages_language_overlay;_FIELD:sys_language_uid]
  staticpub.procInstrFilter = tx_staticpub_publish
  staticpub.baseUrl = http://localhost:8888/typo3/dummy_4.0/
}

This configuration is enough to publish URLs which even combines with the various languages available on pages. The published pages of a default configuration like this will be the html-files ONLY - so no resources (images / flash / stylesheets). This mode is useful if you wish to create HTML files for performance improvements on the same server using mod_rewrite. In such a case you would set up some mod_rewrite wizardry that checks if a static file exists in the publish directory, if so, serve that file while all resource files (which are not served by TYPO3) are already on the server.

Alternatively, you may want a variant of this; namely exporting all resources as well. This can be done with a little setting. This modified configuration does that:

tx_crawler.crawlerCfg.paramSets {
  staticpub = &L=[|_TABLE:pages_language_overlay;_FIELD:sys_language_uid]
  staticpub.procInstrFilter = tx_staticpub_publish
  staticpub.procInstrParams.tx_staticpub_publish.includeResources=relPath
  staticpub.procInstrParams.tx_staticpub_publish.overruleBaseUrl =
  staticpub.baseUrl = http://localhost:8888/typo3/dummy_4.0/
}

It asks to include resources. It also asks to set the path relative to these. This is necessary because in this case a base-url is set in the rendered files because we use “realurl”. This is also the reason why the base url is set blank in the second line I introduced above.

staticpub options for crawler configuration:¶

The following options are set with “....procInstrParams.tx_staticpub_publish.” as prefix. See also the “crawler” extension documentation for information on “procInstrParams”.