Updating Allegra#

This chapter describes how to update Allegra on Windows systems installed using the ZIP package method.

Attention

Before updating, ensure you have a full backup of your database and your <ALLEGRA_HOME> directory (which contains attachments, templates, and configuration files — defined during installation and located within the installation directory by default).

Preparation#

Before you begin, ensure the following:

Allegra is stopped (see below)
Database and <ALLEGRA_HOME> backups are complete
Java 21 JRE/JDK is installed and available in your system PATH
You have administrator privileges
There is sufficient free disk space in your <INSTALLATION_DIRECTORY>

Summary#

In your <INSTALLATION_DIRECTORY>, run the following commands in sequence:

# Stop Allegra
allegra.bat stop
# or, if installed as a service do it via the Windows UI service manager.

# Update Allegra
allegra.bat update

# Start Allegra
allegra.bat start
# or, if installed as a service do it via the Windows UI service manager.

# Verify version
allegra.bat version

Note

The <INSTALLATION_DIRECTORY> contains Allegra’s program files and scripts. During setup, Allegra also creates a separate <ALLEGRA_HOME> directory where Allegra stores all attachments and configuration files. Always back up both directories before performing an update.

Updating the Management Script#

Updating the management script (allegra.ps1) is rarely required. If a newer version is required, Allegra will usually prompt you automatically during the normal update process.

You can also check and update it manually if needed:

Check for script updates
```
allegra.bat check-script-updates
```
Update the script
```
allegra.bat update-script
```
This command downloads and installs the latest version of the script, creating a backup (allegra.ps1.backup) before replacement.

Note

Script updates do not require stopping Allegra. The script is used only for administrative tasks, not for running the server.

Troubleshooting#

Common issues and their resolutions:

Update download fails – Check internet connection or firewall settings
Allegra does not start – Review allegra-startup.log for errors
Database connection errors – Ensure the database server is running and reachable
Out of memory – Increase memory allocation with allegra.bat setup-memory

Next Steps#

After completing the update, perform the following checks to ensure the installation is healthy:

Verify application startup

Check that Allegra starts correctly and is accessible in your browser.
Review application logs

Inspect <ALLEGRA_HOME>\log\catalina.out for any errors or warnings.
Confirm database connection

Verify Allegra can connect to your configured database.
Inform users

Notify users once the update is complete and tested.