chore: drop billing and team variables from .env.example, add the installer README

.env.example described Stripe, Clerk, MinIO and the team server, none of
which the community edition runs, and sent users to a Settings tab that
does not exist. The web UI no longer names a person as author, and the
installer package gets the README its files list promised.
This commit is contained in:
shumeiko.it
2026-11-01 02:10:01 +01:00
parent 74200d46e8
commit b156072285
3 changed files with 58 additions and 64 deletions

View File

@@ -1,77 +1,38 @@
# ── LLM provider API keys ─────────────────────────────────────────── # Optional settings for running the sidecar from source. A basic local run
# CANONICAL STORE = the encrypted vault (~/.waggle/vault.json), set via the UI # needs none of them: keys are entered in the app and kept in the encrypted
# (Settings → API Keys). The server hydrates process.env FROM the vault at boot, # vault (~/.waggle/vault.json).
# so you normally do NOT set provider keys here.
# ── Provider API keys ──────────────────────────────────────────────
# Set keys in the app under Settings > Models (Provider Keys) or in the Vault
# app. The server loads them from the vault at startup, so you normally do not
# set them here. Providers: anthropic, openai, google (gemini), xai, deepseek,
# openrouter, mistral, moonshot (kimi), alibaba (qwen), minimax, zhipu (glm),
# perplexity, genspark, and tavily for web search.
# #
# Full provider set the app can use (all vault-managed, keyed by provider id): # These are also read from the environment, for CI and headless runs:
# anthropic · openai · google (gemini) · xai · deepseek · openrouter · mistral
# · moonshot (kimi) · alibaba (dashscope/qwen) · minimax · zhipu (glm)
# · perplexity · genspark + tavily (web search)
#
# Only the following are ALSO read directly from env (for CI / headless runs
# where the vault UI isn't available):
# ANTHROPIC_API_KEY= # ANTHROPIC_API_KEY=
# OPENAI_API_KEY= # OPENAI_API_KEY=
# VOYAGE_API_KEY= # embeddings only (EMBEDDING_PROVIDER=voyage) # VOYAGE_API_KEY= # embeddings only (EMBEDDING_PROVIDER=voyage)
# LiteLLM proxy master key # ── Data directory and port ────────────────────────────────────────
LITELLM_MASTER_KEY=sk-waggle-dev # WAGGLE_DATA_DIR=~/.waggle
# WAGGLE_PORT=3333
# LiteLLM proxy URL (for multi-model routing) # ── LiteLLM (optional) ─────────────────────────────────────────────
LITELLM_BASE_URL=http://localhost:4000 # Off by default; the built-in provider proxy handles model calls. Point the
# sidecar at an external LiteLLM-compatible proxy only if you run one.
# LITELLM_BASE_URL=http://localhost:4000
# LITELLM_MASTER_KEY=
# ── Embedding Provider (M2-1) ─────────────────────────────────────── # ── Embeddings ─────────────────────────────────────────────────────
# Default: auto (tries InProcess → Ollama → API → mock) # auto (default) tries in-process, then Ollama, then an API provider.
# Options: auto, inprocess, ollama, voyage, openai, mock # Options: auto, inprocess, ollama, voyage, openai, mock
# EMBEDDING_PROVIDER=auto # EMBEDDING_PROVIDER=auto
# In-process (default — zero config, works offline) # In-process model: downloads about 23 MB on first use, cached in
# Model downloads ~23MB on first launch, cached in ~/.waggle/models/ # ~/.waggle/models/, then works offline.
# EMBEDDING_MODEL=Xenova/all-MiniLM-L6-v2 # EMBEDDING_MODEL=Xenova/all-MiniLM-L6-v2
# Ollama (power user — needs Ollama installed: https://ollama.com) # Ollama: needs Ollama running (https://ollama.com).
# OLLAMA_HOST=http://localhost:11434 # OLLAMA_HOST=http://localhost:11434
# OLLAMA_EMBED_MODEL=nomic-embed-text # OLLAMA_EMBED_MODEL=nomic-embed-text
# API Providers (set keys in the app: Vault → Secrets → Embedding Providers)
# Or set here for CI/headless only:
# VOYAGE_API_KEY=
# M3 Server Configuration
DATABASE_URL=postgres://waggle:waggle_dev@localhost:5434/waggle
REDIS_URL=redis://localhost:6381
CLERK_SECRET_KEY=sk_test_...
CLERK_PUBLISHABLE_KEY=pk_test_...
CLERK_WEBHOOK_SIGNING_SECRET=
PORT=3100
CORS_ORIGIN=http://localhost:8080
# ── Stripe (M2-2 Billing) ──────────────────────────────────────────
# Required for paid tier checkout and subscription management.
# Get keys from https://dashboard.stripe.com/apikeys
# STRIPE_SECRET_KEY=
# STRIPE_WEBHOOK_SECRET=
# Price IDs. Since the Solo-vs-Team collapse (2026-07-05) TEAMS is the ONLY active
# checkout price. The PRO vars are legacy — still recognized on inbound webhooks
# (a legacy PRO subscriber resolves to Solo/FREE, never a removed tier), but no new
# PRO checkout is offered.
# STRIPE_PRICE_TEAMS_MONTHLY= # active — the only new-checkout price
# STRIPE_PRICE_TEAMS_ANNUAL= # active
# STRIPE_PRICE_PRO_MONTHLY= # legacy — webhook-recognized, resolves to Solo/FREE
# STRIPE_PRICE_PRO_ANNUAL= # legacy — webhook-recognized, resolves to Solo/FREE
# Legacy single-price vars (still resolved as a fallback):
# STRIPE_PRICE_BASIC= # legacy — webhook-recognized, resolves to Solo/FREE
# STRIPE_PRICE_PRO= # legacy — webhook-recognized, resolves to Solo/FREE
# STRIPE_PRICE_TEAMS= # legacy single-var fallback for TEAMS
# ── MinIO (Team File Storage) ──────────────────────────────────────
# S3-compatible object storage for shared team workspace files.
# docker compose up starts MinIO + auto-creates waggle-files bucket.
MINIO_ENDPOINT=localhost:9000
MINIO_BUCKET=waggle-files
MINIO_ACCESS_KEY=waggle
MINIO_SECRET_KEY=waggle_s3_dev
# ── Teams Server (M3 PostgreSQL) ──────────────────────────────────
# When DATABASE_URL is set, the Teams server starts alongside the local server.
# TEAMS_SERVER_PORT=3101

View File

@@ -29,7 +29,6 @@
<link rel="apple-touch-icon" href="/waggle-logo.png" /> <link rel="apple-touch-icon" href="/waggle-logo.png" />
<title>Waggle OS</title> <title>Waggle OS</title>
<meta name="description" content="Workspace-native AI agent platform with persistent memory" /> <meta name="description" content="Workspace-native AI agent platform with persistent memory" />
<meta name="author" content="Marko Markovic" />
<meta property="og:title" content="Waggle OS" /> <meta property="og:title" content="Waggle OS" />
<meta property="og:description" content="Workspace-native AI agent platform with persistent memory" /> <meta property="og:description" content="Workspace-native AI agent platform with persistent memory" />

View File

@@ -0,0 +1,34 @@
# Waggle server installer
Installs and runs the Waggle server: the sidecar and web UI of the Waggle community edition,
without the desktop app. The server runs on its own bundled Node, so nothing is compiled on
your machine and no Python or Docker is needed.
```bash
npx @waggle-ai/waggle install
waggle-server
```
`waggle-server` starts the server at http://localhost:3333 and opens it in your browser.
| Command | What it does |
|---|---|
| `install` | Downloads the server for this system, checks its SHA-256 and installs it |
| `run` | Starts the server (the default command) |
| `doctor` | Checks the runtime, SQLite, the data directory, the port and the command |
| `update` | Installs this version over the installed one |
| `uninstall` | Removes the program; your data stays |
Options: `--from <path|url>` installs from a downloaded archive, `--port <n>` picks another
port, `--data-dir <path>` uses another data directory, `--no-open` keeps the browser closed.
Run `waggle-server --help` for the full list.
Supported systems: Windows x64, macOS (Apple silicon and Intel), Linux x64. You need Node.js
20 or newer only for the first `npx` call.
Your data lives in `~/.waggle` (or `WAGGLE_DATA_DIR`). `uninstall` does not touch it.
The package and command names are temporary until the product name is decided, and until
the release location is set, install from an archive with `--from`.
License: MIT.