You will learn#
- how to start and stop the server without a container;
- which address, workspace, key and log files it uses;
- how to check the installation before you rely on it.
The idea#
The release archive and the installers carry one program, vukem-video. vukem-video serve is the process that owns the workspace: it serves the editor, the HTTP API and the MCP endpoint, and it runs the jobs. Without a container it runs in local mode: it listens on 127.0.0.1:7878 only, and a request needs the token in <workspace>/token. To serve other machines, use network mode, which has login and API keys.
The server makes no outbound connection by default and sends no telemetry; see Privacy.
Quick start#
- Download and verify the archive of your platform, and put
vukem-videoon yourPATH. - Check the installation:
vukem-video doctor --fullruns every check and names what to fix. - Start the server:
vukem-video serve. It stays in the foreground and logs to standard error. - Open the editor with
vukem-video open, or go tohttp://127.0.0.1:7878in a browser.
vukem-video version
vukem-video doctor --full
vukem-video serveStop the server with Ctrl+C or by sending SIGTERM. It waits up to 15 seconds for running jobs to reach a safe point; a job that is still running then is interrupted and requeued, and the next start recovers it.
vukem-video open starts a local server first when none runs, then opens the browser. With VUKEM_VIDEO_NO_BROWSER set it prints the address instead of starting a browser.
What it uses#
| Item | Where | Notes |
|---|---|---|
| Workspace | ~/.vukem-video, or VUKEM_VIDEO_HOME | one directory; see Workspace and storage |
| Address | 127.0.0.1:7878, or VUKEM_VIDEO_ADDR | an address that is not loopback is refused in local mode |
| Local token | <workspace>/token | readable only by you; vukem-video token:rotate makes a new one |
| Application key | <workspace>/app.key | created on first start in local mode when APP_KEY is unset; keep it private |
| Logs | <workspace>/logs/vukem-video.log | rotated at 10 MiB, three old files kept; LOG_LEVEL sets the level |
| FFmpeg | the order of FFmpeg, codecs and licences | VUKEM_VIDEO_FFMPEG and VUKEM_VIDEO_FFPROBE name it explicitly |
Every variable is in the configuration reference.
Common mistakes#
- Starting a second
vukem-video serveon the same workspace: it fails withE_WORKSPACE_LOCKED. See The workspace is locked. - Binding another address in local mode. Set
VUKEM_VIDEO_MODE=network, anAPP_KEYand the rest of the network settings first. - Putting the workspace inside a folder that a cloud-sync client manages: it can corrupt the database and the lock.
doctor --fullwarns when it recognises such a folder. - Deleting
app.keyor changingAPP_KEYby accident: keep the key with your other secrets and back it up with the workspace.