MUE SyncFeaturesHow It WorksSetupDocsFAQDownload

Installation

Everything you need before the first sync, with verification steps.

This page walks through every install step in detail, including verification, plus how to run the agent without the batch files (for power users and admins).

Requirements

ItemRequirement
OSWindows 10 or 11. (macOS/Linux work too, see below.)
Node.jsLTS, v18 or newer (nodejs.org).
TailscaleInstalled and signed into your team network.
NetworkAll artists on the same Tailscale tailnet; relay box online.

Step 1: Install Node.js

  1. Open nodejs.org and download the LTS version.
  2. Run the installer. Accept the defaults and click through.
  3. Open a new terminal (or Command Prompt) and type node --version. You should see something like v20.x.x.

If node --version errors, close and reopen your terminal so it picks up the new PATH, and try again.

Step 2: Install Tailscale

  1. Open tailscale.com/download and download for Windows.
  2. Install and launch the app.
  3. Sign in with the account that is a member of your team's network. Your team admin controls who can join.
  4. Confirm you see your Tailscale IP (for example 100.x.y.z) in the app.

Same tailnet. Everyone, including the relay box, must be on the same Tailscale network. If you are on a different one, the relay cannot introduce you to your team.

Step 3: Get the agent

Download the MUE Sync Agent package and unzip it anywhere (for example Documents\MueSync). You should have these files:

Step 4: Verify everything

  1. Open a terminal in the agent folder and run node --version (Node is installed).
  2. Run tailscale status and confirm you see the relay box and your teammates.
  3. Run node "agent.js" directly. You should see:
    [mue-sync ...] P2P listen on 6670
    [mue-sync ...] watching C:\path\to\project
    [mue-sync ...] connected to relay introducer 100.123.2.61:6668
  4. Open a second machine's agent and confirm both print peer connected.

Running on macOS or Linux

The agent is pure Node.js and works on any OS. Instead of launch.bat, run it with environment variables:

export MUE_CONTENT_DIR=/path/to/project
export MUE_RELAY_HOST=100.123.2.61
export MUE_RELAY_PORT=6668
node agent.js