Voxta docs

Installing, updating and reverting

Downloading modules, when Voxta checks for updates, the two kinds of module update, going back to the previous version, and when a restart is needed.

Installing

From Add Modules, Install opens the install flow. For a module with the Download tag, its first step downloads it, checks the file against the source's checksum and loads it. No restart.

From a source's own page (Browse on its row in Module Sources), the button downloads the module and loads it at once. A module you did not have yet then opens in Add Modules, to set it up.

What a source offers per module:

ShownMeaning
InstallNot downloaded yet.
Update to XA newer version than the one installed.
Download XInstalled at another version, from another source or built in.
No buttonAlready the newest that fits, or a module built into Voxta, which cannot be replaced.
Needs Voxta XNo release runs on this Voxta version.
Not available on this systemNo build for this operating system or processor.

Badges say what you have: Downloaded X, Built in X, and Installed (added in Manage Modules) or Not installed (downloaded, not added yet). A downloaded module also has a trash button, Remove from Voxta.

The newest release that runs on your Voxta version is offered, not always the newest published.

When Voxta checks

Voxta asks the module sources for updates when an administrator signs in, at most once a day per administrator. Not at startup: nobody has signed in yet, so a private repository's token, for one, is not there. The answer is kept in memory, so a restart checks again at the next sign-in.

Check for updates in Manage Modules' Add modules menu asks again, and says when the last check was. A dot on Settings in the left rail means updates are waiting.

Nothing installs on its own. Updates, and modules your services use that are missing, wait for an administrator.

Two kinds of update

A new module version. A source published a newer release. Manage Modules shows a banner listing them, and the startup window lists them after you sign in. Update all downloads them, loads them and runs the installs they need.

An install update. A module's install step has to run again, because its version changed or Voxta changed something it depends on. Manage Modules lists those modules first, under Needs you, marked Needs install or Update ready. The startup window marks them Required when the module cannot run until it is done.

  • Upgrade all on Manage Modules (in the Add modules menu, and on the notice above the list) runs every pending update and install in one pass. With nothing pending the menu offers Repair all instead, which runs every install again.
  • A single module upgrades from its own page.
  • Disabled modules are skipped and not counted.

Chat augmentations are a tab of Manage Modules, with the others. The old Chat Augmentations page leads there.

A module updates only from the source it was installed from. Modules from a GitHub source are never in Update all or Upgrade all. Each update is confirmed on that source's page.

Python requirements

When a module's Python packages change (a new version, or a different build loaded), Voxta flags it for an install. It checks at startup and each time modules are loaded. A source's page and Local Development Modules then show … need an install. with an Install button. Elsewhere it appears as an install update.

Reverting an update

Voxta keeps the version an update replaced. The module shows Revert to X on its source's page (or on Local Development Modules, for one installed from a file). It applies at once.

Only the one previous version is kept.

Modules Voxta stopped shipping

Many modules that used to be built in are now downloaded. If a service you set up uses one that is not here, Voxta does not install it automatically. After an administrator signs in, the startup window offers Install, and Manage Modules shows A module you use is no longer built into Voxta with an Install button.

Without a restart

Modules load and unload while Voxta runs. When one changes:

  • chats wait until it is done;
  • chats running that module's augmentations end;
  • its services start again with the new version.

A restart is still needed for:

  • modules that load native libraries or change process-wide state, which mark themselves restart-only;
  • a downloaded copy replacing a module Voxta ships.

The page then shows … only change with a restart and a Restart button. It restarts the server, not the app.

If the previous version of a module stays in memory after an unload, the page says so. It goes at the next restart.

On this page