Skip to content

Main Navigation Get started Deploy with Docker Team Hub API NPM What is HarborClient?v0.4.5

Sidebar Navigation

Introduction

Prerequisites

Setup

Configuration

Sections overview

server

db

redis

logging

llm

plugins

docs

Docker environment variables

Related docs

Deploy

Hosting options

What is in the container

Bundled vs managed services

Local smoke test

Documentation index

Google Cloud Run

Prerequisites

Build and push the image

Quick start (evaluation)

Production

Admin commands

Cloud Run troubleshooting

VPS

Overview

Prerequisites

Install Docker

Build the image

Run Team Hub

Verify and create users

Persistence and backups

Firewall

Updates

Edit configuration

VPS troubleshooting

Using the CLI in the container

Where the config file lives

How to invoke the CLI

Reload config without restarting

Restart the server after config changes

Create an admin user

Post-deploy administration

Health checks

Environment variable reference

Troubleshooting

Container exits during startup

GET /health fails or connection refused

Protected API routes return 503

Config file not found

Migration errors

Related docs

Authentication

LLM

Configuration

User access

Agent loop

Monthly limits

Usage logging

Endpoints

CLI

Global options

Commands overview

start

migrate

collection list

llm list

user

user token

Examples

API Endpoints

Overview

Conventions

Timestamps

Errors

Empty responses

Shared types

Health

GET /health

GET /join

Authentication

GET /auth/session

Administration

GET /admin/users

PUT /admin/users/:id

DELETE /admin/users/:id

POST /admin/users

GET /admin/tokens

POST /admin/users/:id/tokens

DELETE /admin/tokens/:id

GET /admin/collections

PUT /admin/collections/:id

DELETE /admin/collections/:id

GET /admin/collections/:collectionId/documents

GET /admin/environments

PUT /admin/environments/:id

DELETE /admin/environments/:id

GET /admin/snippets

PUT /admin/snippets/:id

DELETE /admin/snippets/:id

GET /admin/llm/models

POST /admin/config/reload

Collections

GET /collections

POST /collections

PUT /collections/:id

DELETE /collections/:id

Environments

GET /environments

POST /environments

PUT /environments/:id

DELETE /environments/:id

Snippets

GET /snippets

POST /snippets

PUT /snippets/:id

DELETE /snippets/:id

GET /collections/:collectionId/folders

POST /collections/:collectionId/folders

PATCH /folders/:id

DELETE /folders/:id

PUT /collections/:collectionId/folders/reorder

Requests

GET /collections/:collectionId/requests

POST /collections/:collectionId/requests

PUT /requests/:id

DELETE /requests/:id

PUT /collections/:collectionId/requests/reorder

PUT /requests/:id/move

Documents

GET /collections/:collectionId/documents

POST /collections/:collectionId/documents

PUT /documents/:id

DELETE /documents/:id

PUT /collections/:collectionId/documents/reorder

PUT /documents/:id/move

LLM routes

GET /llm/models

GET /llm/usage

POST /llm/chat/step

Plugin sources

GET /plugins/sources

Development

Build

Scripts

License

On this page

Prerequisites

Node.js 24 (see .nvmrc)
pnpm 10

bash

nvm use
corepack enable

Pager

Previous pageIntroduction

Next pageSetup

Prerequisites ​

Prerequisites