website: document compress post-processor
This commit is contained in:
parent
812ba35479
commit
2ed100a0b0
29
website/source/docs/post-processors/compress.html.markdown
Normal file
29
website/source/docs/post-processors/compress.html.markdown
Normal file
@ -0,0 +1,29 @@
|
||||
---
|
||||
layout: "docs"
|
||||
page_title: "compress Post-Processor"
|
||||
---
|
||||
|
||||
# Compress Post-Processor
|
||||
|
||||
Type: `compress`
|
||||
|
||||
The compress post-processor takes an artifact with files (such as from
|
||||
VMware or VirtualBox) and gzip compresses the artifact into a single
|
||||
archive.
|
||||
|
||||
## Configuration
|
||||
|
||||
The configuration for this post-processor is extremely simple.
|
||||
|
||||
* `output` (string) - The path to save the compressed archive.
|
||||
|
||||
## Example
|
||||
|
||||
An example is shown below, showing only the post-processor configuration:
|
||||
|
||||
<pre class="prettyprint">
|
||||
{
|
||||
"type": "compress",
|
||||
"path": "foo.tar.gz"
|
||||
}
|
||||
</pre>
|
Loading…
x
Reference in New Issue
Block a user