mirror of https://github.com/Studio-Saelix/sencho.git synced 2026-07-26 11:49:16 +00:00

Files

T

Anso f32b6372a1 docs: pre-1.0 readiness pass for public beta launch (#1225 )

Close the trust-blocking items from the pre-v1.0 readiness audit so the
repository is ready for the first public posting. No backend or
frontend code changes; no tier gates move.

README:
- Add a single beta-status GitHub [!NOTE] callout below the dashboard
  image. Beta status also appears in selected install-flow docs
  (Quickstart, Known Limitations, Security Architecture, Upgrade,
  Troubleshooting) so install-flow readers are not surprised.
- Add a "Before you install" subsection that names the docker.sock
  privilege model with the Portainer / Dockge / Komodo comparison.
- Fix the docker run example: add the missing /opt/docker:/opt/docker
  mount that COMPOSE_DIR=/opt/docker depends on.
- Reword the two "no exposed Docker socket" sentences so the claim is
  scoped to remote / cross-node exposure.
- Reword "transparent HTTPS proxy" to "authenticated HTTP and WebSocket
  proxy" with a TLS / VPN reminder.
- Fix the RBAC bullet: the role set is admin, viewer, deployer,
  node-admin, auditor. There is no "editor" role.
- Add tier markers to the Capabilities list (matrix sentence plus
  per-bullet (Skipper) / (Admiral) markers), verified against the
  route guards in backend/src/routes/.
- Fix the broken notification-routing link to point at the existing
  alerts-notifications#notification-routing anchor.
- Soften the BSL paraphrase to point at LICENSE plus the license FAQ.
- Add a "Telemetry and data handling" section: no telemetry, no
  analytics, no crash reports; license validation only when a paid key
  is activated.
- Add a "What Sencho is not (yet)" section so the scope boundaries are
  visible above Capabilities.

Templates:
- PR template: drop the contradictory CHANGELOG checkbox; release-please
  owns CHANGELOG.
- Bug report template: update the stale 0.2.2 version placeholder to
  0.86.6 and add fields for compose snippet, container logs, browser
  console, and an involved-subsystems checkbox.

Docs:
- docs/operations/trivy-setup.mdx: replace both sencho/sencho:latest
  occurrences with the published image saelix/sencho:latest.
- docs/reference/settings.mdx: rewrite the API Tokens Note (no tier
  gate in code; admin role only) and the Stack Labels Note (basic
  CRUD is free; only bulk actions require Skipper or Admiral).
- Add the shared beta-status Note callout to docs/getting-started/
  quickstart.mdx, docs/operations/upgrade.mdx, docs/operations/
  troubleshooting.mdx, and docs/reference/security.mdx.

CONTRIBUTING:
- Replace the public link to the in-repo coding-rules file with a
  pointer to docs.sencho.io for architecture deep-dives.
- Fix the sample clone URL case (Sencho.git becomes sencho.git).

New files:
- SUPPORT.md: where to ask, response-time expectations, in / out of
  scope.
- KNOWN_LIMITATIONS.md: scale, platform, architecture, and feature
  limits documented for the beta audience; scale numbers marked "not
  benchmarked yet" pending real benchmarking.

2026-05-25 13:24:28 -04:00

2.0 KiB

Raw Blame History

Getting help with Sencho

Sencho is a solo-maintained project. Here is what to expect.

Where to ask

Setup, configuration, "how do I" questions → Documentation
Discussion, share your setup, propose ideas → GitHub Discussions
Bugs, regressions, broken features → Bug report
Feature requests → Feature request
Security vulnerabilities → SECURITY.md. Do not open a public issue.
Licensing, billing, refunds → licensing@sencho.io
Support the project → Buy Me a Coffee. Sponsorship is not required and does not change support response times; it helps fund the work.

Response times

Sencho is built by a single maintainer. Volunteer responses target:

Security reports: 72 hours initial response (committed in SECURITY.md)
Bug reports: a few days, typically within a week
Feature requests: triaged but not always replied to individually; check the roadmap
Discussions questions: community-first; the maintainer joins when possible

There is no SLA. Paid tiers (Skipper, Admiral) get priority for licensing-related issues through the email above. A formal paid-support tier may follow 1.0.

What is in scope

Bugs in shipped functionality, on a supported deployment (Docker Compose or docker run with the documented mounts).
Setup questions where the docs are unclear; tell us which page confused you.
Feature requests that fit Sencho's scope (Docker Compose control plane for homelab and small fleets).

What is out of scope

Generic Docker, networking, or Compose troubleshooting unrelated to Sencho.
Custom modifications, forks, or non-default deployments.
Migration help from competing tools beyond what the docs already cover.