v0.61.3
ReferenceDesktopDataDesktop

Synnax Desktop data

Find the data folder of Synnax Desktop, or erase all data.

Synnax Desktop keeps its data in one folder for each user account on the computer:

Operating system Data folder
macOS ~/Library/Application Support/com.synnaxlabs.desktop/core
Windows %LOCALAPPDATA%\com.synnaxlabs.desktop\core

The folder holds your channels, recorded data, ranges, and projects. To open it, run the “Show data folder” command. Do not change the files in the folder while Synnax Desktop runs. Synnax Desktop 1.0 kept metadata backups in a backups folder next to core. Synnax Desktop deletes that folder when you erase all data.

Synnax Desktop also writes ~/.synnax/desktop.json (%USERPROFILE%\.synnax\desktop.json on Windows). The file holds the address of Synnax and an API key, so that scripts on the same computer can connect.

Metadata backups

Before a new version of Synnax Desktop first runs on your data, it copies your channels, ranges, and projects to the backups folder in the data folder. It keeps the three newest copies. The copies hold no recorded data.

If the update fails before it finishes, Synnax puts the newest copy back by itself and does not start that version again. See Synnax stops after an update. You cannot restore a copy by hand.

Erase all data

Erase all data cannot be undone. It deletes every channel, all recorded data, every project, all metadata backups, and the API key that scripts use. It also logs the computer out of your Synnax account.

  1. Run the “Erase all data” command, or select Erase all data in the diagnostics dialog.
  2. Hold the Erase all data button for one second to confirm.

Synnax Desktop deletes the data and ~/.synnax/desktop.json, logs out, then closes and opens again with no data. On the next launch, log in again. The new desktop.json holds a new API key, so code that holds the old key needs the new one. The logs and your app settings stay. If the erase fails, Synnax stays stopped: click Restart in the diagnostics dialog.