package
zidane-server: run the zidane chat host on a remote machine; TUI windows attach over WebSocket with device tokens.
npm install zidane-serverGitHub-flavored package documentation.
Across all versions.
Download trend unavailable.
Runtime metadata.
Tagged topics.
Estimated unpacked size across 1 packages.
16.4 kB
Includes dependencies.
zidane-server runs the zidane chat host on a remote machine. Sessions, settings and credentials live there. Terminal windows, the desktop app and the web app attach over WebSocket with a device token. Runs continue when a window closes. zidane-server <cmd> is the same as zidane server <cmd>.
Guides: install, deploy (systemd, Compose, Coolify, proxies). Reference (configuration, tokens, security model, operations): docs/SERVER.md.
The current version is on the releases page. Pin an exact release, and upgrade the server and its clients together.
# Docker (linux/amd64, linux/arm64)
docker run -d --name zidane --restart unless-stopped \
-v zidane-data:/data -p 127.0.0.1:4280:4280 \
--memory 4g --pids-limit 2048 --security-opt no-new-privileges \
ghcr.io/tahul/zidane-server:<version>
docker exec zidane zidane-server token create --name laptop # printed once
# Or a release binary, or the npm launcher
curl -fsSL https://zidane.si/install | sudo sh -s -- --server --prefix /usr/local
npx zidane-server start # 127.0.0.1:4280
# On the laptop, with the token in a 0600 file
The image listens behind a TLS-terminating proxy. The npm launcher downloads the release binary of its own version from https://zidane.si/dl, checks it, and caches it in ~/.zidane/server-bin/<version>/. The feed keeps the newest two releases only.
| File | What |
|---|---|
bin/zidane-server.mjs | The npm launcher. It runs dist/zidane-server when that build has the package version, else the release binary. |
lib/server-binary.mjs | Downloads, verifies and caches the release binary for the launcher. |
Dockerfile | The image ghcr.io/tahul/zidane-server, for Docker, Compose and Coolify. The build context is the repository root. |
docker-compose.selfhost.yml | The released image with a volume, resource limits and an optional Caddy (--profile caddy). |
docker-compose.build.yml | An override that builds the image from the checkout. |
docker-compose.yml | The Coolify Docker Compose build pack. |
zidane-server.service | The systemd unit for the release binary. It ships in the linux archives. |
zidane-cloudflared.service | The systemd unit for a Cloudflare Tunnel from a token file. |
zidane-machine.service | The systemd unit for a machine that serves a main server. |
scripts/ | Smoke tests of the binary (bun run server:smoke) and the image (bun run server:smoke:image). |