Deploy Plone site to static files.
Project description
Overview
stxnext.staticdeployment is a tool to deploy Plone site to static files. It supporst Plone 3 and Plone 4 (including sites using Diazo themes).
Installation
Edit buildout.cfg and append stxnext.staticdeployment to eggs and zcml parameters in instance section:
[instance] eggs = ... stxnext.staticdeployment zcml = ... stxnext.staticdeployment
Instance must be rebuild and restarted:
./bin/buildout ./bin/instance stop ./bin/instance start
This product must be also installed inside Plone site. Do do it, go to Site Setup -> Add/Remove Products, select checkbox near stxnext.staticdeployment and click Install button.
Configuration
Every website has own configuration (different set of eggs, skin, products etc.) - this I meas as project. But website can have few instances (development, test and production instances). Because of this, configuration is split for two parts:
instance parameters:
parameters connected to instance - e.g.: domain
configured in Control Panel - can be edited throw the web (Site Setup -> Static deployment -> Settings tab)
form has description and validation - can be used by less experienced users
website parameters:
stored in INI file
created by developer of website
can be used by many sites
default configuration (included in egg)
default configuration can be overriden by file ${buildout:directory}/etc/staticdeployment.ini
staticdeployment.ini paramaters
- deployment-directory (string)
Where to deploy site. Path can be relative or absolute. Default: ./plone-static
- layer-interface (string)
Default: zope.publisher.interfaces.browser.IDefaultBrowserLayer
- defaultskin-name (string)
Skin which will be used during deploy. Default: Sunburst Theme
- deploy-plonesite (boolean)
If enabled home page will be deployed also as index.html in root of deployment-directory. Default: true
- deploy-registry-files (boolean)
Deploy registry files (CSS, JS, KSS)? Default: true
- make-links-relative (boolean)
Make all links relative (otherwise they will be absolute). Default: false
- add-index (boolean)
Add index.html to all links (that should have index.html). Works only when make-links-relative is enabled. Default: false
- page-types (list)
Page types that should be deployed. For example: ATDocument, ATFolder
- file-types (list)
File types that should be deployed. For example: ATBlob
- skinstool-files (list)
Additional files (from plone_skins tool) which should be deployed. For example: plone_images/favicon.ico
- additional-files (list)
Other files to deploy. For example: sitemap.xml.gz
- additional-pages (list)
Other pages that should be deployed. For example: sitemap
- deployable-review-states (list)
Only pages with review states listed here will be deployed. Default: published
Usage
When website is ready to deployment go to Site Setup -> Static deployment -> Deployment tab. Select Deploy static version of website checkbox and press Save button. Deployment will work for few seconds or minutes (it depends on size of website and server performance).
Author & Contact
- Author:
Igor Kupczyński <igor.kupczynski@stxnext.pl>
Radosław Jankiewicz <radoslaw.jankiewicz@stxnext.pl>
Wojciech Lichota <wojciech.lichota@stxnext.pl>
Sebastian Kalinowski <sebastian.kalinowski@stxnext.pl>
STX Next Sp. z o.o.
Changelog
1.0.1 (03.07.2012)
Fixed issue with Products.CMFCore on Plone 4.1
1.0.0 (23.05.2012)
Code refactoring
Compatibility with Plone 3
Created tests
Added possibility of generating relative paths
History of earlier changes: https://github.com/stxnext/stxnext.staticdeployment/blob/refactoring/docs/OLD_HISTORY.txt
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file stxnext.staticdeployment-1.0.1.tar.gz.
File metadata
- Download URL: stxnext.staticdeployment-1.0.1.tar.gz
- Upload date:
- Size: 43.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 296536a90eddfcddfd1ec53953fc894bdb38982a688871846fc87e7169e540ee |
|
| MD5 | a447f778dcc0cdf8244cf23242ac6efd |
|
| BLAKE2b-256 | 80ce1c24807c88caf2560844b0ba7ac99e4fde9373ebf442eca8f490e2bc7a18 |
