Update Elftia

Elftia has a built-in automatic update mechanism to ensure you always use the latest version. This page explains how updates work and how to manually update.

Automatic Updates

Elftia uses electron-updater for automatic updates. By default, the application automatically checks for updates in the background.

Update Flow

1. Check for Updates: When Elftia starts and during operation, it periodically queries the update server for new versions.
2. Download Update: When a new version is found, the installer is automatically downloaded in the background. You can continue using the application while downloading.
3. Install Notification: When the download is complete, the application displays an update notification telling you the new version is ready.
4. Restart and Install: Click "Restart and Install" in the notification; the application closes, installs the update, and automatically restarts.

info

The update process does not affect your data. All chat histories, configurations, API Keys, and other data remain intact after updating.

Update Channels

Elftia automatically determines the update channel based on the version string:

Channel	Version Example	Description
latest	1.0.0	Stable release, recommended for all users
beta	1.1.0-beta.1	Beta version with new features but possible issues
alpha	1.2.0-alpha.3	Early preview for developers and testers

By default, you only receive updates from the latest channel. If you want to experience new features early, you can opt into beta updates.

Manual Update Check

To check for available updates immediately:

1. Open Settings → About.
2. You'll see the current version number and update status.
3. Click the Check for Updates button.
4. The system will immediately query the update server:
   • If a new version is available, it shows the version number and update notes, then starts downloading.
   • If already up to date, it displays "Already on the latest version".

Download Progress

When downloading the update package, you can view the download progress on the About page:

• Shows download percentage and speed.
• Downloads can happen in the background without affecting normal use.
• If the network is interrupted, the download automatically retries when connectivity is restored.

Restart and Install

After the update download completes:

1. The application displays a notification or "Restart and Install" button on the About page.
2. Clicking the button causes Elftia to:
   • Save all unsaved state
   • Close the application
   • Execute the update installation
   • Automatically restart
3. Update installation typically takes a few seconds to a minute.

tip

You can choose to restart later. The update is already downloaded and will be automatically installed the next time you normally close and restart the application.

Steam Version Updates

If you're using the Steam version of Elftia, updates work differently:

Comparison	Standard Edition	Steam Edition
Update Check	Automatic in-app	Automatic via Steam client
Download Method	In-app background download	Steam download
Installation Method	Restart app	Steam auto-install
Manual Trigger	Settings → About → Check for Updates	Steam → Right-click game → Check for updates

Steam version updates are completely managed by the Steam client; you don't need to do anything within Elftia.

Portable Version Manual Update

If you're using the Portable version, automatic updates may not be available. Manual update steps:

1. Download the latest version installer from the official website or GitHub Releases.
2. Close the currently running Elftia.
3. Install the new version:
   • Windows: Run the new installer; it automatically replaces the old version.
   • macOS: Replace the old .app with the new one in the Applications folder.
   • Linux: Replace the old AppImage file.
4. Launch the new version.

info

Your data is stored in the user data directory (not the application installation directory), so manual updates won't lose data.

Update Failure Troubleshooting

If automatic updates fail, try these steps:

Download Failure

• Network Issues: Check your internet connection; if using a proxy, ensure proxy configuration is correct (see Using Proxy).
• Disk Space: Ensure your system has enough disk space for the update package (typically 200-500 MB of temporary space).
• Firewall: Confirm your firewall isn't blocking Elftia's access to update servers.

Installation Failure

• Permission Issues: On Windows, administrator rights may be required to install updates. Try running Elftia as administrator.
• File Locks: Ensure no other programs are locking files in Elftia's installation directory.
• Manual Update: If automatic installation repeatedly fails, download the latest version and install manually.

Rollback

If the new version has issues:

1. Download the previous stable version from GitHub Releases.
2. Uninstall the current version.
3. Install the old version.
4. Your data will be preserved since it's stored in the user data directory.

caution

In rare cases, a new version might include database migrations. After rolling back to an old version, if the new version has already executed migrations, this could cause compatibility issues. It's recommended to export diagnostic information via Settings → System → Export Diagnostics as a backup before updating.

Version Number Format

Elftia follows semantic versioning:

major.minor.patch[-prerelease]

Part	Meaning	Example
Major Version	Major changes or incompatible updates	2.0.0
Minor Version	New features, backward compatible	1.1.0
Patch	Bug fixes and minor improvements	1.0.1
Prerelease	Beta version	1.1.0-beta.1

---

If you encounter issues after updating, see Common Issues or Diagnostic Tools.