Open Markdown text in a new tab

Reset and account recovery

The Reset tab clears a selected category of data. It is for recovery and deliberate cleanup, not routine maintenance. In the SoAI WebUI, select the Settings button at the right of the header, then select Settings from its menu and select Reset. Read the action description before choosing its Reset button. Each action asks for confirmation, and Factory reset (FACTORY_RESET) asks twice. For a failed application update, begin with the update recovery guidance before clearing any data.

Who can use the Reset tab

Settings > Reset is shown only to an Administrator. The page hides Metrics and Hardware without Metrics reset (METRICS_RESET), Configuration without Configuration changes (CONFIG_PATCH), and Factory reset (FACTORY_RESET) without that permission. Resetting ACL policy also requires ACL administration (ACL_ADMIN). Resetting Appearance requires UI customization (WEBUI_APPEARANCE_ADMIN) because it removes the shared wallpaper.

Choose the smallest reset that solves the problem

Reset action Result
ACL policy Restores access-control policy overrides to their defaults.
Appearance Removes the shared wallpaper and restores the current user's built-in wallpaper, solid background, color, glass, animation, and appearance-effect settings.
Metrics Clears in-memory metrics, live persistence, and stored metrics history. Previously recorded samples disappear from charts and new history exports.
Hardware Removes recorded hardware-monitoring and SoAI Bench history.
Page layouts Restores saved Dashboard, Metrics, and Hardware movable layouts.
WebUI Restores the signed-in user's non-advanced WebUI preferences, including appearance, language, layout, and related preferences.
Chat presets Deletes the signed-in user's saved chat configuration presets. Existing conversations and the open chat configuration remain unchanged.
Prompt history Deletes the signed-in user's saved server-side chat prompt history.
Recent searches Clears the recent searches shown on the Search page.
Tool approvals Forgets the signed-in user's remembered approval decisions. SoAI asks again when a tool requires approval.
Password manager Deletes the signed-in user's saved password-vault credentials and invalidates active secure handles.
Conversations Deletes the signed-in user's chat conversations and automation transcripts. Automations, settings, models, and plugins remain.
Configuration Restores advanced and core configuration to built-in defaults, preserves non-configuration data, and restarts SoAI.
Factory reset (FACTORY_RESET) Deletes managed user data, settings, models, backups, and non-built-in plugins, then restarts to the initial setup state.

Reset configuration or return to factory state

Configuration is the right choice when configuration is the only problem. It removes the managed active configuration file and its recovery copies during restart, then SoAI recreates the active file from the built-in default. The action requires Configuration changes (CONFIG_PATCH) and is blocked when SYSTEM.RUNTIME.HOST_SYSTEM_ACTIONS_DISABLED is enabled.

Use Factory reset (FACTORY_RESET) only when you intend to remove managed application data. Before confirming it, create a backup from the Backup tab and keep any downloaded copy outside the SoAI installation. The action has the same host-action policy check and requires that permission. It deletes only application-managed paths inside the installation; configured data paths outside the installation are not deleted. After the second confirmation, the WebUI redirects to sign-in while SoAI restarts. When the WebUI detects the fresh installation state, it opens the setup wizard.

Change or recover a login password

The Users tab is available only to an Administrator with User administration (USER_ADMIN). Select the Settings button at the right of the header, then select Settings from its menu and select Users. Select Password for the account, enter Your current password, then enter and confirm the new password. A Standard account has no self-service Users-tab path. New passwords must contain at least 8 characters and no more than 1024 characters.

When no administrator can sign in, Linux and macOS (experimental) installations can use the POSIX launcher recovery command. Stop SoAI first, run the command from the installation directory, then start it again. The command asks for the new password twice without echoing it.

# SoAI on Linux
./soai.sh --stop
./soai.sh --reset-user-password administrator
./soai.sh --start

# SoAI on macOS
sudo /Applications/SoAI/soai.command --stop
sudo /Applications/SoAI/soai.command --reset-user-password administrator
sudo /Applications/SoAI/soai.command --start

# SoAI OS
./soai_os/soai_os.sh --stop
./soai_os/soai_os.sh --reset-user-password administrator
./soai_os/soai_os.sh --start

The Windows release launcher does not provide --reset-user-password. Do not edit the database to work around a missing administrator account.

Related documentation