@connectai/selfhost - npm Package Compare versions

Comparing version

0.1.5

0.1.6

+1

-1

package.json

		{
		"name": "@connectai/selfhost",
		"version": "0.1.5",
		"version": "0.1.6",
		"description": "One-command self-host installer for ConnectAI. Takes a clean machine (only Docker + Node) to a running, health-checked company-brain in one command, with no source clone and no local image build: `npx @connectai/selfhost run`. Bundles the image-based docker-compose stack + boot scripts, generates a strong .env (CSPRNG ENCRYPTION_SECRET + POSTGRES_PASSWORD), boots the stack, and soft-pulls the local inference models.",
		@@ -5,0 +5,0 @@ "type": "module",

+39

-8

README.md

		# @connectai/selfhost

		One-command self-host installer for [ConnectAI](https://github.com/joi-fairshare/connectai). Takes a clean machine (only Docker + Node) to a running, health-checked company-brain in one command, with no source clone and no local image build.
		One-command self-host installer for [ConnectAI](https://github.com/ConnectAI-OS/connectai). Takes a clean machine with only Docker + Node to a running, health-checked company-brain, with no source clone and no local image build.

		```bash
		npx @connectai/selfhost run
		# optional global alias:
		npm i -g @connectai/selfhost && connectai run
		# optional global aliases:
		npm i -g @connectai/selfhost
		connectai run
		selfhost run
		```

		That is the entire happy path. The canonical npm surface is `@connectai/selfhost`. The bare word `connectai` is only the installed binary alias after `npm i -g @connectai/selfhost`; do not use `npx connectai`.
		That is the happy path. The canonical npm surface is `@connectai/selfhost`. The bare words `connectai` and `selfhost` are only installed binary aliases after `npm i -g @connectai/selfhost`; do not use `npx connectai`.

		The CLI pulls prebuilt images, writes a hardened `.env`, boots the stack, pulls the local inference models, and prints the console URL + your single next step.

		## Quick start

		1. Boot the stack:

		```bash
		npx @connectai/selfhost run
		```

		2. Get the one-time setup token:

		```bash
		npx @connectai/selfhost token
		```

		3. Open `http://localhost:5273/setup`, paste the token, create the first admin, confirm inference, and connect a source.

		For the full operator guide, remote-origin caveats, and day-2 operations, see [`SELF_HOSTING.md`](../../SELF_HOSTING.md).

		## What `run` does
		@@ -24,2 +44,12 @@

		## Command examples

		```bash
		npx @connectai/selfhost run
		npx @connectai/selfhost run --dir /opt/connectai --no-pull
		npx @connectai/selfhost logs api
		npx @connectai/selfhost token
		npx @connectai/selfhost down -v
		```

		## Commands
		@@ -47,5 +77,6 @@

		- Docker with the Compose v2 plugin, daemon running.
		- Docker with the Compose v2 plugin and a running daemon.
		- Node >= 18 (for `npx`).
		- That is it. No git, no clone, no source, no local image build.
		- Roughly 8 GB RAM and 10 GB free disk for a comfortable first boot.
		- No git checkout, no source clone, and no local image build.

		@@ -57,3 +88,3 @@ ## Notes
		- Only one localhost stack can be up at a time because the services still bind fixed host ports (`4000`, `5273`, `8082`, `5432`). For a clean rerun on a shared box, stop the currently running stack without `-v`, run the temp-dir install, then tear down the temp-dir stack with `down -v`.
		- localhost is the v1 target. The prebuilt console image bakes its API base URL at publish time to `http://localhost:4000`, which is correct for the localhost eval. Serving the prebuilt console for a remote origin needs runtime API-base injection (a documented follow-up).
		- localhost is the v1 target. The packaged installer is the fastest path for a same-box eval. The prebuilt console image bakes its API base URL at publish time to `http://localhost:4000`, which is correct for localhost. Serving the prebuilt console for a remote origin needs extra setup; use [`SELF_HOSTING.md`](../../SELF_HOSTING.md) before trying to expose this packaged path on a real domain.
		- The packaged installer defaults to the verified `v0.1.1` release tag. If you override it, keep the same tag across your operator docs and rollout notes.
		@@ -65,2 +96,2 @@ - The first run downloads several GB (images + models) and can take a few minutes; re-runs are fast and idempotent.

		[BUSL-1.1](https://github.com/joi-fairshare/connectai/blob/main/LICENSE). Development, testing, and evaluation use need no license; production use requires a commercial license. The self-host runtime guard fail-closes at run time, so a public image gives nothing away.
		[BUSL-1.1](https://github.com/ConnectAI-OS/connectai/blob/main/LICENSE). Development, testing, and evaluation use need no license; production use requires a commercial license. The self-host runtime guard fail-closes at run time, so a public image gives nothing away.

@connectai/selfhost - npm Package Compare versions

Improved metrics