Get started

Install Vue.io on the computer that will host your workspace. Your team and clients use their browsers; they do not each need a server installation.

1. Prepare your host

The primary alpha supports x86-64 and ARM64 Linux with:

• Docker Engine and Docker Compose v2;
• Python 3.9 or newer;
• 4 CPU cores and 8 GiB RAM as a practical starting point;
• 40 GiB free local space for the app and working data; and
• separate capacity for media and independent backups.

Large libraries and high-resolution previews need more resources. Check Docker:

docker --version
docker compose version

For Apple Silicon, read the experimental Mac instructions first. There is no supported Intel Mac or native Windows installer yet.

2. Install Vue.io

Run this on the host:

curl -fsSL https://github.com/rfxmedia/vueio/releases/latest/download/install.sh | sh

You can also download and inspect install.sh from the latest release, then run sh ./install.sh.

The installer checks prerequisites, asks for storage locations, downloads the release, and starts Vue.io. Keep the terminal open until it prints the browser address and one-time setup code.

Choose two separate locations:

• Vue data: database, app files, previews, and database backups. Use a suitable local filesystem, not a network share or FAT/exFAT database drive.
• Media: a selected project folder or mounted storage. Media can live on local disks, USB storage, or a network share mounted on the host.

The installer does not format drives. Do not run a fresh installation over an existing workspace; follow the update guide.

3. Open the workspace

On the host, open the printed address, normally http://127.0.0.1:9000. Enter the setup code and create the first owner account.

For a headless server, open an SSH tunnel from your own computer:

ssh -L 9000:127.0.0.1:9000 user@vueio-server

Leave the tunnel open and visit http://127.0.0.1:9000 in your browser. Replace user@vueio-server with your server's SSH destination.

Lost the setup instructions? On Linux, run:

sudo vueioctl setup-info

The output contains a private setup code. Do not post it in an issue or screenshot.

4. Complete a first review

Use the owner account for these steps.

1. Confirm the selected media location in Settings → Storage.
2. Open Projects → New project.
3. Enter a title and select a Working project folder.
4. Select Create.
5. In the project, select New → Upload Files and upload non-sensitive sample media.
6. Wait until the upload shows Done.
7. Select New → Vue Tracker and create a tracker.
8. Select Import → Add Shots, then choose the uploaded media in Project Files.
9. Complete the import and open the resulting shot.
10. Post a review comment and confirm that it appears.

Use Review and version history to add a revision, compare versions, and control publication. Use Workspace and team to add a restricted member. Check a share in a signed-out browser before inviting a client.

5. Set up remote access

The default loopback address is local to the host. It is not an internet link. Configure an HTTPS reverse proxy, VPN hostname, or tunnel before inviting remote collaborators. Vue.io does not create that connection for you.

After your HTTPS endpoint is working, configure Vue.io on Linux:

sudo vueioctl exposure set https://vue.example.com

Replace the example with your HTTPS origin. Do not forward the plain HTTP port directly to the public internet.

HTTPS, Caddy, and Cloudflare examples →

Before real production work

Read the release's known issues. Verify login, playback, a review link, and downloads from the intended network. Make a database backup and separately back up application files, media, and configuration. The alpha is intended for trusted users and media; a successful install is not a security audit.