quip-node-manager README

The project's README from github.com/QuipNetwork/quip-node-manager. As one markdown file: README.md.

Quip Node Manager

Desktop application for running and monitoring Quip network nodes. Supports Docker and native execution modes on macOS, Linux, and Windows.

Quick Install

macOS / Linux:

curl -fsSL https://gitlab.com/quip.network/quip-node-manager/-/raw/main/scripts/install.sh | sh

Windows (PowerShell):

irm https://gitlab.com/quip.network/quip-node-manager/-/raw/main/scripts/install.ps1 | iex

Manual Download

Download the latest release from the Releases page.

macOS

Download the .dmg, open it, and drag the app to /Applications.

Linux

The recommended format is AppImage (works on any distro):

chmod +x quip-node-manager-linux-x86_64.AppImage
./quip-node-manager-linux-x86_64.AppImage

A .deb package is also available for Debian/Ubuntu:

sudo dpkg -i quip-node-manager-linux-x86_64.deb

Windows

Download the .exe and run it. Windows SmartScreen may show a warning because the binary is not yet code-signed.

Click More info, then Run anyway.

Features

Development

Prerequisites

Setup

This repo vendors the compose stack via a git submodule. After cloning, fetch the submodule at the commit locked by this repo:

make fetch-submodules

(Equivalent to git submodule update --init --recursive, or clone with git clone --recurse-submodules to do this in one step.)

Commands

bun install          # Install JS dependencies
bun run dev          # Launch development build
bun run build        # Production build for current platform

cd src-tauri
cargo check          # Type-check Rust code
cargo clippy         # Lint

CLI Mode

The app also supports a terminal UI mode:

quip-node-manager --cli

The terminal UI starts and stops the stack, runs the pre-flight checklist, streams logs, and edits the node configuration. Configuration covers the storage directory, ports, run mode, update channel, CPU and GPU settings, and the D-Wave keys. The dashboard, the health panel, TLS settings, and in-app updates stay in the desktop app.

Architecture

Native mode note (macOS): the node's REST API binds to 127.0.0.1:20100. Docker Desktop's vpnkit forwards container traffic from host.docker.internal through to the host's loopback, so the REST port is not exposed to the LAN.

Overriding the bundled stack

Node Manager rewrites ~/quip-data/docker-compose.yml from its embedded copy on every Start and Apply, discarding whatever you edited there. Put changes in ~/quip-data/docker-compose.override.yml instead. Staging never touches that file, and compose merges it over the base.

services:
  quip-validator:
    environment:
      RUST_LOG: debug

Compose loads an override file automatically only when it discovers the compose file itself. Node Manager always passes -f, so it adds the override explicitly when the file exists, after the base file so the override wins.

Two things to watch:

The compose file caps the miner container at 16 GiB, which stops a runaway round from triggering a host-wide out-of-memory kill. On a dedicated miner with more RAM, raise it by setting miner_mem_limit_gb in ~/quip-data/app-settings.json:

{ "miner_mem_limit_gb": 48 }

Set it there rather than in .env, which Node Manager regenerates on every Start. There's no UI control for this yet.

Validator pruning isn't recommended. The validator runs --state-pruning=archive --blocks-pruning=archive, keeping every state trie and block body from genesis. Size the disk for that. Pruning reclaims disk, but it breaks the dashboard: the descriptor worker scans from genesis and fails with State already discarded once it reads past the pruning window. Pruning also likely reduces your point awards on the SNAG platform. Only prune if you accept losing the dashboard.

See AGENTS.md for detailed architecture documentation.

License

AGPL-3.0-or-later

Copyright (c) Postquant Labs

quip-node-manager (QuipNetwork/quip-node-manager)

Searching Database…

5.5K ·GitHub
Quip-node-manager
What is this?Quip Node Manager is a desktop GUI app for running and monitoring nodes on the Quip Network, a blockchain that supports both classical CPU mining and D-Wave quantum (QPU) mining.
Is this a desktop app or a web dashboard?It's a native desktop application built with Tauri v2, with a vanilla HTML/CSS/JS frontend; it also embeds a web-based dashboard in an iframe and ships a terminal UI mode for headless use.
How do I get it running?Use the Quick Install script on macOS/Linux or the PowerShell command on Windows, or manually download the .dmg (macOS), AppImage/.deb (Linux), or .exe (Windows) from the Releases page.
What do I need installed before running a node?You need Docker with Compose v2 (standalone docker-compose v1 isn't supported); on Windows that also means WSL, and macOS Native mode additionally needs the standalone miner binary on the host.
Any install pitfalls I should know about?The Windows .exe isn't code-signed yet, so SmartScreen will warn you — click 'More info' then 'Run anyway'. Also, pruning the validator breaks the bundled dashboard since it scans state from genesis.
Does it run the same way on every OS?Docker mode is the default on Windows and Linux, driving a full Compose stack; on macOS the app can instead run the miner as a standalone native binary while validator, dashboard, postgres, and Caddy still run in containers reached via host.docker.internal.
Is the node's API exposed to my network?In Native mode on macOS, the node's REST API binds only to 127.0.0.1:20100 and Docker Desktop's vpnkit just forwards host-local traffic to it, so it isn't exposed to the LAN.
What does the full node stack actually run?It spins up a miner, a validator, a Postgres-backed dashboard, and a Caddy front door together via Docker Compose, with the dashboard UI embedded directly in the app's Dashboard tab.
How does TLS get configured for the dashboard?You set a DNS name and email and the app wires up Caddy's ACME support, automatically issuing a Let's Encrypt or ZeroSSL certificate — TLS is optional but 'just works' once configured.
What is the D-Wave QPU feature for?It lets the node mine using a D-Wave quantum processing unit instead of (or alongside) CPU mining, with daily budget controls to cap QPU spend, configured via the [dwave] section and a D-Wave token.
Can I run it without the GUI?Yes — a terminal UI (CLI) mode can start/stop the stack, run the pre-flight checklist, stream logs, and edit node configuration, though the dashboard and in-app updates remain GUI-only.
What are similar projects?labtether, omnyssh, quip-solver, buzz, openship, Termix, glances, agentsview
Which topics is it in?metal, tauri, blockchain, tls, tui, agpl, nvidia, postgresql, docker-compose, cuda, dashboard, monitoring
Creator
QuipNetwork
Size
6.2 MB
Stars
5.5K
Updated
CommitOct 15
Age
6mo
Commits · 90 Days