diff --git a/README.md b/README.md index 886e188..0a5b4c1 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ ## Introduction Static provides several extensions for exporting a SilverStripe application to -both local or remote file systems +both local or remote file systems. ## Maintainer Contact @@ -15,4 +15,8 @@ both local or remote file systems * SilverStripe 3.1 * Tar archive +## Documentation + +See docs/ + Note this is untested on Windows. \ No newline at end of file diff --git a/docs/en/StaticExporter.md b/docs/en/StaticExporter.md index a6b0c1e..11859e8 100644 --- a/docs/en/StaticExporter.md +++ b/docs/en/StaticExporter.md @@ -33,12 +33,27 @@ configuration options then will generate a tar.gz archive of the website. Accessing http://yoursite.com/dev/tasks/StaticExporterTask will generate the export of the website and save it to a folder on your filesystem. Unlike the GUI option this does not allow you to configure options in the browser, instead -it relies on the developer setting the options via statics (as deploy) +it relies on the developer setting the options via statics or through GET +parameters. ### Sake -To generate the export via command line ([sake](framework/en/topics/commandline.md)) +To generate the export via command line ([sake](/framework/en/topics/commandline.md)) sake dev/tasks/StaticExporterTask -## Options \ No newline at end of file +## Options + +Both the StaticExporterTask and Sake task take the following GET params. The +GUI method only allows you to customize the baseurl path. + +* baseurl - (string) Base URL for the published site +* symlink - (false|true) Copy the assets directory into the export or, simply +symlink to the original assets folder. If you're deploying to a separate +server ensure this is set to false. +* quiet - (false|true) Output progress of the export. +* path - (string) server path to generate export to. + +Note that the path directory will be populated with the new exported files. +This script does not empty the directory first so you may which to remove the +folder (`rm -rf cache && sake dev/tasks/StaticExporterTask path=cache`) diff --git a/docs/en/index.md b/docs/en/index.md new file mode 100644 index 0000000..84a41d6 --- /dev/null +++ b/docs/en/index.md @@ -0,0 +1,24 @@ +# Static + +Static is a module providing extensions to SilverStripe to allow developers to +generate static exports of their SilverStripe sites either for performance or +as a backup system. + +There are two main parts to the module + +## Static Publisher + +Publish selected SilverStripe pages as HTML / PHP files to get a performance +increase on those pages. You can run the static content alongside a full +installation to allow for seamless integration. Also supports syncing published +content to multiple servers for load balancing. + +* [Static Publisher](StaticPublisher) + +## Static Exporter + +Export your entire website to HTML pages. Suitable if your entire site is +static and you wish to deploy the content to a machine other than the CMS or +as a backup measure to your website + +* [Static Exporter](StaticExporter) \ No newline at end of file