Skip to content

Repository files navigation

kubus Node

CI Current release including prereleases npm edge publication pending Docker runtime License: AGPL-3.0-only

Local runtime and public archive Node for art.kubus.

Keep the public art archive available. Process Spatial captures on your own hardware. Connect securely from art.kubus.

Download for Windows · Install · Documentation · node.kubus.site

Install

Windows

Download kubus Node for Windows x64. Have Docker Desktop running with its WSL 2 backend, install kubus Node, and open setup. Sign in to art.kubus, review the permissions, and authorize the Node. It then appears in My Nodes. Normal setup does not require a manual operator token.

npm

The alpha channel is edge. These are the channel commands:

npm install -g @kubus/kubus-node@edge
kubus-node setup

Or, without a global install:

npx @kubus/kubus-node@edge setup

Publication status, checked 2026-09-14: alpha.7 is published on GitHub, but the public npm edge package remains unavailable. Until this is repaired, install the exact official release tarball instead:

npm install -g https://github.com/kubus-project/kubus-node/releases/download/v0.8.0-alpha.7/kubus-kubus-node-0.8.0-alpha.7.tgz
kubus-node setup

Use kubus-node doctor --json for diagnostics. Both installers start the release's digest-pinned Docker runtime; they do not build a checkout.

What it does

  • Stores and serves canonical public cultural records in the distributed archive.
  • Runs local Gaussian reconstruction on compatible NVIDIA/CUDA hardware, or requests processing from a selected network provider.
  • Connects owned Nodes to art.kubus using the supported WebRTC/TURN transport.

The official runtime requires archive participation. Sharing a GPU as a remote compute provider is optional. Runtime guide.

Privacy

PROCESS ≠ PUBLISH. SYNC ≠ PUBLISH.

Local processing keeps raw capture processing on your Node. A selected remote provider necessarily sees plaintext while processing; transport encryption does not make that provider blind. Output in ordinary Kubo is unlisted and non-canonical until publication, but someone who knows its CID may be able to retrieve it. Explicit authorized publication creates canonical public state. Privacy details.

Requirements

  • Windows x64 or Linux x64; Docker Engine with Compose v2. The npm CLI needs Node.js >=20.19 and npm >=10. macOS is unsupported by this alpha CLI.
  • No GPU is needed for archive participation. Windows can request remote processing; local Windows GPU reconstruction is not validated in this release.
  • Local reconstruction/provider: validated Linux Docker host, NVIDIA/CUDA, NVIDIA Container Toolkit and sufficient VRAM. CPU reconstruction is unsupported.
  • Archive capacity is controlled by backend policy. The source example allocates 50 GiB; the Windows launcher checks at least 10 GiB free. Allow additional space for runtime images, captures and output.

Architecture

Architecture · Local API · Spatial · Remote transport · Distributed compute · Participation · Security

The backend is the matchmaking and canonical trust boundary, not a central capture-processing server. Archive contribution, compute-provider compensation and public Spatial contribution are separate records. KUB8 settlement remains pending; there is no guaranteed payout or market return. Contribution details.

Development

Installing a released Node does not require source development. For a checkout:

git clone https://github.com/kubus-project/kubus-node.git
cd kubus-node
npm ci
npm run typecheck
npm test

Configure .env from .env.example using the operator guide, then:

docker compose up --build
# Compatible NVIDIA/CUDA development host:
docker compose --profile spatial up --build

Release channels

Release npm / image alias
Alpha edge
Beta beta
Stable latest

Floating image tags are discovery aliases. Reproducible operation uses the manifest's image digests and docker-compose.release.yml in the official release ZIP. Verify the checksums and inspect the manifest. GitHub Actions artifacts are not public distribution endpoints. Release contract.

Source status

Current kubus Node source is open source under AGPL-3.0-only; see LICENSE. Third-party components retain their own licences. The software licence does not grant rights to the kubus branding or automatically cover artwork and archive content. The published alpha.6 tag predates this licensing change and still contains its earlier UNLICENSED notice. Check the licensing information included with downloaded release artifacts. Protocol and implementation detail previously in this README remains in the runtime guide and the linked documentation.

About

Local Gaussian splatting + IPFS spatial archive node for art.kubus. Process spatial captures on your own GPU, use distributed GPU compute, and contribute storage to a decentralised public art network.

Topics

Resources

Contributing

Security policy

Stars

1 star

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages