StaticWire by christophengelmayer

Convert pages to static HTML files via CLI or the admin interface.

StaticWire

ProcessWire Module that converts pages to static HTML files via CLI or the admin interface. Useful in CI/CD scripts or to use ProcessWire as a static site generator.

Installation


Install via the ProcessWire modules directory. See Instructions.

Configuration


The configuration option ("Static file path") defines the directory in which the static HTML files and folders are generated. The path is relative to the root directory of your ProcessWire installation. (default: /static)

Usage


via CLI (Command Line Interface)

Navigate to the root folder of your website:

cd /var/www/mysite

Run the script

php site/modules/StaticWire/cli.php

via admin interface

Go to Setup > Static Site Generator and click the "Generate" button.

Users need the staticwire-generate permission in order to run StaticWire.

How does it work?


The module creates a folder structure mirroring the page tree of your website. In each folder a index.html file with the corresponding page content is generated.

To generate the static HTML structure the $page->render() function is called on each page.

Asset handling

Assets (like CSS or JavaScript) and uploaded files are not copied!

To handle assets and uploads you have multiple options:

  • copy the folders (site/assets/files, site/templates/style, site/templates/scripts, etc.) to the output directory (static/)
  • copy them in your CI/CD script
  • create symlinks if the static site and your ProcessWire installation are running on the same server

Roadmap


  • [ ] Supprt paginated templates
  • [ ] Download static site as *.zip archive

Alternatives


If you need a more advanced solution please have a look at Ryan Cramers wonderful ProCache module.

Install and use modules at your own risk. Always have a site and database backup before installing new modules.

Twitter updates

  • New ProcessWire “User Activity” module version released (v5), this post covers what's new— More
    12 August 2022
  • New post: Multi-language field translation export/import — In this post we cover the details of a new module that enables export and import capabilities for multi-language fields in ProcessWire… More
    5 August 2022
  • Weekly update, July 29: Continuing upgrades to ProcessWire’s comments system and FormBuilder, along with a working example—More
    29 July 2022

Latest news

  • ProcessWire Weekly #431
    In the 431st issue of ProcessWire Weekly we'll check out the weekly update from Ryan in which he covers a new version of a popular Pro module, share some recent tutorials and other online resources, and more. Read on!
    Weekly.pw / 13 August 2022
  • Multi-language field translation export/import
    In this post we cover the details of a new module that enables export and import capabilities for multi-language fields in ProcessWire.
    Blog / 5 August 2022
  • Subscribe to weekly ProcessWire news

“We were really happy to build our new portfolio website on ProcessWire! We wanted something that gave us plenty of control on the back-end, without any bloat on the front end - just a nice, easy to access API for all our content that left us free to design and build however we liked.” —Castus, web design agency in Sheffield, UK