JP Joom2Static - Configuration Parameter Reference
Article Index
- JP Joom2Static
- Why use JP Joom2Static?
- What's New in JP Joom2Static
- Installation
- General Configuration
- Menu and Asset Configuration
- Image Optimization
- .htaccess Settings
- Manual Files and Protected Sites
- Webhooks and REST API
- Deployment
- FTP Deployment
- Netlify Deployment
- AWS S3 Deployment
- GitHub Pages Deployment
- Generate Static HTML
- Configuration Parameter Reference
- Security Recommendations
- Conclusion
- All Pages
Page 17 of 19
Configuration Parameter Reference
The following primary configuration parameters are used by JP Joom2Static:
| Parameter | Description |
|---|---|
downloadid |
Download/update identifier. |
convert_html |
HTML Conversion Mode: Selected Menus or Full Site Crawler. |
html_folder |
Local static HTML output folder. |
incremental_export |
Enables incremental static generation. |
menuitems |
Primary menu selection by Joomla language. |
menuitems2 |
Additional menu selection 1. |
menuitems3 |
Additional menu selection 2. |
menuitems4 |
Additional menu selection 3. |
menuitems5 |
Additional menu selection 4. |
minify_js |
CSS and JavaScript minification. |
combine_js |
CSS and JavaScript file combining. |
optimize_method |
Image optimization method. |
optimize_quality |
Native PHP GD image quality from 1 to 100. |
tinykey |
TinyPNG API Key. |
force_catitems |
Generates articles inside category menus when required. |
htaccess |
Controls generation of the .htaccess file. |
htaccess_data |
Content written to the generated .htaccess file. |
sefurl |
JP Joom2Static Search Engine Friendly URL handling. |
add_files |
Manually included static files. |
htaccess_lock |
Enables source-site HTTP authentication. |
htaccess_user |
Protected-site username. |
htaccess_pass |
Protected-site password. |
webhook_secret |
Security token used by the standalone webhook trigger. |
deploy_target |
Selected remote deployment provider. |
ftp_server |
FTP hostname or IP address. |
ftp_port |
FTP connection port. |
ftp_username |
FTP account username. |
ftp_password |
FTP account password. |
ftp_path |
Remote FTP destination directory. |
netlify_site_id |
Netlify Site ID. |
netlify_auth_token |
Netlify Personal Access Token. |
s3_bucket |
S3 bucket name. |
s3_region |
S3 storage region. |
s3_access_key |
S3 access key. |
s3_secret_key |
S3 secret key. |
s3_endpoint |
S3-compatible endpoint configuration parameter. |
github_repo |
GitHub destination repository. |
github_token |
GitHub Personal Access Token. |
github_branch |
GitHub deployment branch. Default: gh-pages. |
Note: Single Page Export URL, Webhook Trigger URL, and REST API Status Endpoint are operational interface values rather than persistent configuration parameters.
