Skip to content

Quickstart ​

This page takes you from nothing to a running NexusDesk demo, and shows how to confirm the agent actually works. Expect about ten minutes.

Prerequisites ​

ItemRequirement
Docker20.10 or newer
Docker Composev2 (docker compose)
Docker DesktopUse Linux containers
NetworkThe first run pulls images or builds the frontend

Option 1 — build locally ​

bash
# Linux / macOS
sh nexusdesk quickstart
powershell
# Windows PowerShell
.\nexusdesk.ps1 quickstart

The first run compiles the frontend and builds images, so it takes a while; later runs reuse the cache.

Option 2 — use the published image ​

bash
NEXUSDESK_IMAGE_REGISTRY=docker.io/groundedcore/ NEXUSDESK_VERSION=latest \
  docker compose -f deploy/quickstart/compose.yaml up -d

Verify the stack is up ​

Open https://localhost:8080.

The demo uses a self-signed certificate, so the browser warns you — continue anyway. Certificate setup and LAN access are covered in the deployment guide.

Sign in with admin / nexusdesk (local demo only).

Run your first conversation ​

Open the preconfigured sample-support conversation and try two prompts:

  1. "How long does shipping take?" — the agent retrieves from the knowledge base and answers with references.
  2. "帮我创建工单" (create a ticket for me) — the agent drafts a ticket and waits for your confirmation before creating it.

These two steps verify the retrieval path and the tool-calling plus human-confirmation path respectively.

Explore the industry case packs ​

The demo ships 9 industry case packs: 9 knowledge bases, 18 agent drafts and 36 documents.

  • Every resource name carries the [案例] (case) prefix;
  • Filter the agent list with Scope → Cases only;
  • See Industry examples for details.

Troubleshooting ​

Port already in use — free 8080 or change the port mapping in the compose file.

Image pull fails — make sure NEXUSDESK_IMAGE_REGISTRY ends with a slash and the registry is reachable.

The page keeps loading — the frontend may still be compiling; watch docker compose -f deploy/quickstart/compose.yaml logs -f web.

Security note ​

The demo uses a simulated model, so answers do not reflect real model quality. The default account is for local use only and is not a production authentication boundary. Keep the default 127.0.0.1 binding; if you need external access, restrict source IPs with a security group or firewall.

Next steps ​

NexusDesk 采用 Apache License 2.0 许可