Modules
Extend Votlie with additional features using installable modules. Modules are self-contained packages that plug into Votlie without modifying the core application.
What Are Modules
Modules are feature packages that add new functionality to Votlie. They can add:
- New pages and menu items
- New settings
- Email templates
- Public-facing features
Modules are developed independently and can be installed, activated, deactivated, and removed without affecting your core installation.
Stats Overview
The top of the Modules page displays summary statistics:
| Stat | Description |
|---|---|
| Total | Total number of installed modules |
| Active | Modules currently running and providing features |
| Inactive | Modules installed but not currently enabled |
| Errors | Modules that failed to load or have issues |
Below the stats, use the filter tabs to narrow the list:
- All - Show every installed module
- Active - Show only running modules
- Inactive - Show only disabled modules
- Errors - Show only modules with problems
Installing a Module
- Go to Admin > Modules
- Click Upload Module
- Select the module ZIP file
- The system validates the module automatically (see below)
- Once uploaded, the module appears in your list as Inactive
Module Upload Validation
When you upload a module ZIP file, Votlie runs several checks before allowing installation:
| Check | What It Does |
|---|---|
| Module manifest validation | Verifies the module contains a valid module.json file with required metadata |
| Compatibility check | Ensures the module is compatible with your Votlie version and license type |
| Security scan | Scans the module files for known security issues |
| File integrity check | Validates that the ZIP archive is not corrupted and all expected files are present |
If any check fails, the upload is rejected and you will see an error message explaining the issue.
Module Details
Each module in the list displays a details card with the following information:
- Name - The module's display name
- Icon - A visual icon representing the module
- Version - The installed version number
- Status - Active, Inactive, or Error
- Description - A brief summary of what the module does
- Author - The developer or company that created the module
- License type compatibility - Whether the module works with Regular, Extended, or both license types
Activating a Module
- Go to Admin > Modules
- Find the module in the list
- Click Activate
- The module's features are now available
Some modules add new menu items to the admin sidebar, new settings pages, or new public-facing features.
Configuring a Module
If a module provides settings:
- Go to Admin > Modules
- Click the Settings gear icon next to the module
- The module's dedicated settings page opens
- Configure the module's options as needed
- Click Save to apply your changes
Module settings are specific to each module and documented by the module developer. Changes take effect immediately after saving.
Deactivating a Module
- Go to Admin > Modules
- Find the active module
- Click Deactivate
Deactivating disables the module's features but keeps its data and configuration. You can reactivate it later without losing settings.
Uninstalling a Module
- Go to Admin > Modules
- Deactivate the module first (if active)
- Click Uninstall
- Confirm the action
Uninstalling removes the module's files and may remove its data depending on the module. This action cannot be undone.
Module Compatibility
Modules are checked for compatibility with your license type when uploaded. There are three compatibility categories:
| Compatibility | Description |
|---|---|
| Regular License modules | Designed for the Regular License only. Cannot be installed on an Extended License installation. |
| Extended License modules | Designed for the Extended License (SaaS mode) only. Cannot be installed on a Regular License installation. |
| Universal modules ("both") | Compatible with both Regular and Extended License installations. Work on either license type. |
The compatibility type is displayed on each module's details card and is verified automatically during upload.
Tips
| Tip | Why |
|---|---|
| Read module docs | Each module has its own documentation |
| Test after installing | Verify the module works as expected |
| Keep modules updated | Module developers may release fixes |
| Deactivate before removing | Ensures a clean uninstall |
Next Steps
- Updates & Backups - Keep everything current
- Troubleshooting - Fix issues