Obiente Support

Obiente Support is the product-neutral support portal and private intake service for Obiente projects. It lets people report bugs, suggest features, ask for help, and send explicitly approved diagnostics without needing a GitHub account.

The public portal is a Vue 3 and TypeScript application. A small Go service owns the versioned intake contract, private storage, idempotency, status capabilities, deletion, and retention.

What this foundation includes

• Bug, feature, and general-support intake for products in a maintained registry.
• A versioned multipart API shared by the web portal and native applications.
• Explicit 4 MiB diagnostic upload bounds and per-product ZIP entry allowlists.
• Idempotent submission and receipt reconciliation after an uncertain response.
• Human-readable support codes and unguessable private status/deletion links.
• Application-level AES-256-GCM encryption for private report fields, capabilities, and diagnostic objects.
• Automatic private-data expiration and immediate deletion through the private capability.
• A second product registration and synthetic contract fixtures to prevent product-specific service code.
• A responsive, keyboard-operable Vue portal with reduced-motion behavior and upload cancellation.
• Direct diagnostic submission from supported applications, with the web ZIP picker as a fallback.
• A private maintainer login, report queue, decrypted detail view, diagnostic download, and status moderation.
• Server-side 12-hour admin sessions, strict cookies, CSRF protection, login throttling, and access auditing.

Public tracker promotion, GitHub synchronization, and safe follow-up messages remain required before the complete support workflow is finished.

Local development

Requirements:

• Go 1.24 or newer
• Node.js 22 or newer
• PostgreSQL 17

Create a data key and local environment file:

cp .env.example .env
openssl rand -base64 32
htpasswd -bnBC 12 admin 'choose-a-long-local-password'| cut -d: -f2

Place the generated values in SUPPORT_DATA_KEY and SUPPORT_ADMIN_PASSWORD_HASH, set a database password, then start PostgreSQL. Keep the bcrypt hash single-quoted in .env so its dollar signs remain literal.

docker compose up database

Build the Vue portal and run the same-origin service on port 8080:

cd frontend
npm ci
npm run build
cd ..
set -a
. ./.env
set +a
go run ./cmd/support

For Vue hot reload, keep a built portal available for the Go process, set SUPPORT_PUBLIC_URL=http://localhost:5173, run npm run dev, and open port 5173. Vite proxies /api to the Go service on port 8080.

For the production-shaped single-container build:

docker compose up --build

The support image contains both the built Vue portal and Go service. Mount persistent encrypted report storage at /data; the service stores diagnostic objects under /data/private. Runtime configuration is supplied through environment variables and is not built into the image.

The public intake is at /. Maintainers sign in at /admin/login. Admin credentials are runtime configuration; no default password is included in the image.

Validation

go test ./...
go vet ./...
cd frontend
npm ci
npm run lint
npm test
npm run build

Privacy boundaries

• New reports are private. Nothing is published automatically.
• Diagnostic attachments are optional and must match the selected product's registered schema.
• The service does not store raw idempotency keys or raw status capabilities in database lookup columns.
• Private report text, contact details, receipt capabilities, and diagnostic objects are encrypted before storage.
• Support codes are identifiers, not authentication secrets.
• Private status URLs are bearer capabilities. Applications must never put them in diagnostics, telemetry, or public issues.
• The application does not submit diagnostics automatically, after a crash, or in the background.
• Server logs contain operational failures but no request body, capability path, contact data, diagnostic content, or remote address.
• Maintainer access uses a server-side session and every list, view, diagnostic download, status change, login, and logout is written to the database audit trail.

See docs/threat-model.md, docs/operations.md, and openapi.yaml for the initial security and integration contract.

License

GNU Affero General Public License v3.0. See LICENSE.