Sync Overview

Mudstack’s sync feature is broken up into 2 parts:

1. Pulling & Syncing data from the cloud to your local computer, and auto syncing files and folders, so that you’re in sync with cloud data.
2. Pushing changes from your computer up to the cloud, so cloud data can stay in sync with your changes.

​

How Local and Cloud Workspaces Interact

For a given user, workspaces in mudstack can be of the following types:

1. Cloud only workspace: this is a workspace that is not mapped to a local directory for the user. Indicated by a cloud icon next to the workspace name in the sidebar.
2. Local only workspace: this is a workspace that is only on the user’s computer and has not been sent to the cloud. Indicated by a monitor icon next to the workspace name in the sidebar.
3. Mapped workspace: this is a workspace that exists both locally and in the cloud, and can be kept in sync. Indicated by lack of an icon next to the workspace name in the sidebar.

Local and cloud workspaces interact by syncronizing files and data in both directions to ensure changes made on either platform are reflected across both, facilitating collaborative and accesible project management.

All changes to files, tags, libraries, and workspaces are done locally first, then explicitly pushed to the cloud when using the desktop app.

Cloud changes to content must be fetched and pulled to see those changes reflected in the desktop app.

When a workspace is mapped, downloads and uploads between a cloud workspace and the defined local directory go to the relative path of the set workspace locations.

​

Create a Local Workspace

Create a local workspace by clicking New Workspace below the list of workspaces in the selected account.

All workspaces need a name and workspace location. You may optionally add an icon image.

Click Create Workspace and the workspace will be added to the list of workspaces in that account.

Any local changes must be pushed to be available to your team on the cloud.

​

Mapping a Workspace

In order to synchronize data between a cloud workspace and your computer, you must first connect, or map the cloud workspace to a designated location on your computer.

The workspace sidebar will also show a button alongside workspaces that haven’t been mapped yet— whether they are local only or cloud only.

​

Send an Existing Local Workspace to the Cloud

If you would like to send a local workspace to the cloud, click the Monitor icon next to the workspace name in the left sidebar.

You will see a modal that allows you to send this workspace to the cloud and keep it in sync with your local directory.

​

Map an Existing Cloud Workspace

To map a cloud workspace, click the Cloud icon next to the workspace name in the left sidebar.

You will see a modal appear. Click Select Workspace Location to choose the parent folder of the location where you want to create the local directory for the workspace.

Depending on the size of the cloud workspace, this process could take several minutes. You will see the pull count in the top right go down to zero, at which point the mapping should complete.

​

Unmap a Workspace

Go to Settings > App Settings > Cloud Workspaces. From here you can click the Unsync icon for a synced workspace and confirm that you want to stop syncing.

Any files that are already synced will remain but mudstack will stop watching this directory for changes or creating new local versions for files in this directory.

​

Data vs. File Syncing

When mudstack pulls changes, it is:

1. Pulling updates made by others to metadata for the selected workspace— its libraries, tags, and files (names, locations and any changes to the current version).
2. Downloading only the files (and folders) that you have enabled auto syncing on.

See pull for more information.