Settings

Complete guide to configuring Virtual Files plugin for optimal performance and functionality.

Basic Settings

Enable Virtual Files

This is the master switch that enables or disables all virtual file functionality:

• Location: Virtual Files → Settings → Basic Settings
• Default: Enabled (checked)
• Impact: When disabled, all virtual file URLs return 404 errors
• Warning: Disabling this option will immediately stop all virtual files from working

Allowed Extensions

Configure which file types users can create and manage. Click on extension chips to toggle them on/off.

Free Version Extensions

• Text Files (.txt): Plain text files
• Markdown (.md): Markdown documents
• JSON (.json): JSON data files

Pro Version Extensions

All Free Extensions plus:

• XML (.xml): XML documents
• CSV (.csv): Comma-separated values
• YAML (.yml, .yaml): YAML configuration files
• Log Files (.log): Log files
• RSS Feed (.rss): RSS feed files

Pro Features

• Enable All Extensions: Quick button to enable all file types at once
• Extension chips show visual feedback with colors and descriptions
• Toggle extensions by clicking on the chips

Performance Settings (Pro Only)

File Caching

Advanced caching system for optimal file serving performance:

Cache Configuration

• Enable File Caching: Toggle caching on/off
• Cache Expiration: Select from predefined options:
  • 5 minutes
  • 15 minutes
  • 30 minutes
  • 1 hour (default)
  • 2 hours
  • 4 hours
  • 8 hours
  • 24 hours

Cache Management

• Cache Statistics: Shows cached files count and cache size
• Warm Up Cache: Pre-populate cache with all virtual files
• Clear All Cache: Remove all cached content
• Auto-refresh of cache stats every 30 seconds

Data Management

Data Retention

• Remove data on uninstall: Checkbox to delete all plugin data when uninstalling
  • If checked: Deletes all virtual files, settings, and cache on uninstall
  • If unchecked: Preserves data for future reinstallation

Reset Options

• Reset Plugin Data: Permanently delete all virtual files, settings, and plugin data
  • Red button with warning styling
  • Requires confirmation dialog
  • Action cannot be undone

Development Mode (When VIRTUAL_FILES_DEV_MODE is enabled)

• Clear Freemius Data: Remove license and activation data (for testing only)
  • Shows "DEV" badge
  • Only visible in development mode
  • Helps test uninstallation hooks

Sidebar Widgets

Statistics Widget

Shows current plugin usage:

• Active Files: Number of published virtual files
• Total Files: Total number of virtual files (including drafts)
• Max Allowed: Maximum files allowed (Unlimited for Pro, 5 for Free)

Backup & Restore Widget (Pro Feature)

For Pro Users

• Create Backup: Download all virtual files as JSON
  • Includes file content and metadata
  • Automatic download via iframe
• Restore Backup: Upload JSON or ZIP file to restore files
  • Supports 10MB file size limit
  • Shows progress bar during upload
  • Skips existing files automatically

For Free Users

• Shows upgrade prompt with lock icon
• Disabled buttons with "PRO" badges
• Link to upgrade page

Action Buttons

Save Settings

• Primary button to save all configuration changes
• Shows loading state during save
• Displays success/error notifications

Flush Rewrite Rules

• Manually refresh WordPress rewrite rules
• Useful when virtual file URLs aren't working
• Shows success message when completed

File Type Limits

Free Version

• Maximum 5 active virtual files
• Basic file types only (.txt, .md, .json)
• No caching features
• No backup/restore functionality

Pro Version

• Unlimited virtual files
• All file types supported
• Advanced caching system
• Backup and restore functionality
• Performance optimization

Settings Structure

Free User View

• Basic Settings section
• File Types section (limited)
• Data Management section
• Pro Features promotional section
• Statistics widget
• Backup & Restore widget (disabled)

Pro User View

• Basic Settings section
• File Types section (full)
• Performance & Caching section
• Data Management section
• Statistics widget
• Backup & Restore widget (enabled)

Best Practices

For Free Users

• Focus on essential files (robots.txt, sitemap.xml)
• Use appropriate file types
• Monitor file limit (5 files)

For Pro Users

• Enable caching for better performance
• Set appropriate cache expiration based on content changes
• Use backup/restore for site migrations
• Monitor cache statistics periodically

General Tips

• Always test changes after modifying settings
• Use "Flush Rewrite Rules" if URLs aren't working
• Regular backups recommended for production sites
• Be careful with "Reset Plugin Data" - it's irreversible

Troubleshooting

Virtual Files Not Working

1. Check "Enable Virtual Files" is checked
2. Click "Flush Rewrite Rules"
3. Verify file extensions are enabled
4. Check file status is "publish"

Performance Issues

1. Enable caching (Pro users)
2. Warm up cache for frequently accessed files
3. Adjust cache expiration based on usage
4. Monitor cache statistics

Pro Features Not Available

1. Verify license is active
2. Check connection to Freemius
3. Try refreshing the page
4. Contact support if issues persist

Next Steps

Now that you understand Virtual Files settings:

1. Configure Basic Settings: Set up file types and enable virtual files
2. Enable Performance Features (Pro): Configure caching for better performance
3. Set Up Backups (Pro): Configure backup and restore functionality
4. Test Your Setup: Verify virtual files work correctly
5. Monitor Performance: Check statistics and cache status

For detailed information on specific features, see our other documentation sections.

---

Need Help?

• FAQ - Answers to common questions
• Troubleshooting - Step-by-step problem solving
• Contact Support - Contact options and resources