AAA
c9a6642ac1
* fix: allow Linux interface discovery in embedded media service * feat: expand local diagnostic reports * research: validate independent Browser encoding producers * feat: prototype Browser pool ownership and record remaining media gates * feat: refine Browser shared encoders and native output reuse * Refine carrier costs and simplify release entry points * Close media phase and prepare piik design handoff
3.6 KiB
Documentation
Use Screener
| What you need | Start here |
|---|---|
| Join a friend or share a screen | Quick Start |
| Run Client, choose a mode, or fix capture trouble | Client guide |
| Collect a useful bug report | Diagnostics and export |
| Host your own site | Self-hosting |
| Configure ports, access or persistence | Configuration reference |
| Update an existing deployment | Deployment and recovery |
| Check platform and release readiness | Current status |
The public entry points have English and Chinese versions. Technical references keep one owner rather than duplicate the full documentation tree.
Run from source
Use Node from .node-version, npm from package.json, and Go 1.26 as specified by go.mod. Node builds and serves the development UI; the application server runs in Go.
Start the UI:
npm ci
npm run dev
In a second terminal, start the server. For a POSIX shell:
PORT=8788 PUBLIC_BASE_URL=http://localhost:8787 go run ./cmd/screener-server
Or in PowerShell:
$env:PORT = '8788'
$env:PUBLIC_BASE_URL = 'http://localhost:8787'
go build -o build/dev/screener-server.exe ./cmd/screener-server
./build/dev/screener-server.exe
The fixed Windows executable path avoids repeated firewall prompts from go run.
Open http://localhost:8787. The development UI also listens on the LAN;
screen capture requires localhost or HTTPS. For another invitation origin,
follow the configuration reference.
The standard checks are:
npm run check
npm run check:client
The contributing guide explains native build prerequisites, focused checks and separate physical gates.
Product and design
Current behavior belongs to four product modules:
Key decisions cover automatic routing, the shared Go core, embedded media and Native output groups, and the Browser encoding-pool candidate. Browse all ADRs for their context and consequences.
Evidence and current work
- Project memory: compact product map and invariants.
- Status: current source, production and acceptance boundaries.
- TODO: the only work ledger.
- Verification status: remaining physical evidence.
- Native encoding research and Browser pooling research: measured results, failed controls and limits; neither promises universal performance.
- Research directory: transport, capture, platform and backend evidence.
- Maintenance: document ownership and repository lifecycle.
- Licensing: Screener's MIT scope and third-party notices.
Research distinguishes observations from assumptions. Product modules own accepted behavior, source and tests own implementation detail, and Git/PRs own completed history.