Skip to content

Getting started

Installation

Where to get Vukem Video, what each download is, and how to check it before you run it.

Last updated:

You will learn#

  • which file to download for your system, or how to run the container image;
  • how to start the server and where it listens;
  • how to check a download before you run it.

The idea#

Vukem Video runs only on your computer. You install one program, vukem-video. It serves the editor in your browser, the MCP server, the CLI and the HTTP API from the same process and the same workspace.

Quick start#

  1. Open the releases page and download the installer for your system, or the archive for your platform.
  2. Install it. The installer adds vukem-video to your path.
  3. Run vukem-video version. It prints the version, which tells you the program is installed.
  4. Run vukem-video serve. It listens on 127.0.0.1:7878 and nowhere else.

The container image#

Every stable release also publishes a multi-architecture image with the pinned LGPL FFmpeg inside, on two registries with the same digest: ghcr.io/alexgalhardo/vukem-video and alexgalhardo/vukem-video on Docker Hub. The tags are X.Y.Z, X.Y and latest. The workspace lives in the /data volume, so keep it in a named volume or a folder of your choice:

Terminal
docker run --rm -p 127.0.0.1:7878:7878 -v vukem-video:/data \
  -e APP_KEY="$(openssl rand -base64 32)" \
  ghcr.io/alexgalhardo/vukem-video:X.Y.Z

The container runs as the user app (uid 10001) and sends no data anywhere by default. docker run --rm ghcr.io/alexgalhardo/vukem-video:X.Y.Z version prints the version.

To build from source you need Go (the version in go.mod) and Bun for the front end.

The desktop application#

A release that carries the desktop application lists one file per system next to the other installers: vukem-video-desktop_X.Y.Z_windows_amd64_setup.exe for Windows 11, vukem-video-desktop_X.Y.Z_darwin_arm64.dmg (Apple silicon) or ..._darwin_amd64.dmg (Intel) for macOS, and vukem-video-desktop_X.Y.Z_linux_amd64.deb for Debian and Ubuntu. Each holds the window and the server it starts. The desktop application page says what it does.

The BETA installers are not signed#

No installer is signed with a paid certificate: there is no Apple Developer ID, no notarization and no Windows code-signing certificate in the BETA. Windows and macOS therefore warn before the first run. This is expected; what proves the file is genuine is the checksum and the signature in the release, which you can verify.

  • Windows. SmartScreen shows "Windows protected your PC". Choose More info, then Run anyway.
  • macOS. Gatekeeper says the app cannot be opened because Apple cannot check it. Control-click (right-click) the app, choose Open, then Open again. Or remove the quarantine mark in a terminal: xattr -d com.apple.quarantine "/Applications/Vukem Video.app".
  • Debian and Ubuntu. No warning. Install with sudo apt install ./vukem-video-desktop_X.Y.Z_linux_amd64.deb.

Common mistakes#

  • The system warns before the first run. The installers are not signed with a paid certificate; see The BETA installers are not signed above for the SmartScreen and Gatekeeper steps, and verify the download first if you want proof.
  • FFmpeg is not found. The editor uses your FFmpeg, and VUKEM_VIDEO_FFMPEG and VUKEM_VIDEO_FFPROBE name the binaries explicitly. See the configuration variables.

Next steps#