## Problem and outcome / 问题与结果 Browser sharing can remain connected to a local encoding transport that never becomes usable, leaving viewers without frames. This phase bounds that startup at eight seconds and restores ordinary encoding through the existing failure path. It also keeps ready App services running after a browser-open failure, preserves user presentation/playback choices, and aligns room feedback, illustrated hints, metrics and documentation. 部分环境下,本机编码连接一直无法建立会让观众收不到画面。本轮在八秒后进入现有降级流程,同时修复客户端启动移交、播放状态和前端反馈的一致性问题,并更新官网与中英文教程。 Closes #399. Related: #396. The release contains relevant startup/error-handling repairs, but the reporting machine has not been retested. Keep this issue open for a current-build result. #401 (optional Windows capture-border hiding) remains deferred. Release / 发布版本:**v1.3.1**. ## Release notes ### 中文 - 客户端记住上次确认的启动模式;启动移交保留已保存的语言、纯视觉模式和主题选择。 - 系统浏览器未能自动打开时,客户端继续运行,并在终端保留页面地址、重试入口和具体错误。 - 改善浏览器共享画面的启动兜底,避免 App 媒体因短暂信令中断被误判为失败。 - 音轨变化保持现有视频与观众的本机暂停状态;连接恢复和暂停恢复不再重复播放电视开机动画。 - 修复昵称编辑及长昵称查看,减少重复的角色提示,统一人物选择和连接状态的区别。 - 完善房间准入、密码和邀请说明;复制反馈对应当前链接及当前操作,避免迟到结果覆盖新反馈。 - 修正采集参数、统计单位与采样区间的展示,未知参数不再用配置上限代替。 - 统一提示漫画、状态图标与动效,改善选源器还焦、键盘操作、剧场布局和触控目标尺寸。 - 服务端默认支持 20 位观众,可在配置中设为 1–20 位,房主不占观众名额。 - 更新官网、教程入口和中英文说明,清理过时预览及失用代码。 兼容说明:使用旧版 App 连接更新后的站点时,站点会优先保留自己的显示偏好。如需更改语言或主题,请在进入后的页面调整。 ### English - Remember the last confirmed App launch mode and preserve saved language, visual-mode and theme choices during launch handoff. - Keep the App running if the system browser fails to open, with the page address, retry action and error details available in the terminal. - Improve the browser sharing startup fallback and avoid treating brief signaling outages as App media failures. - Keep existing video and local pause state when audio tracks change. Reconnecting and resuming no longer replay the television startup animation over the picture. - Fix nickname editing and full-name access, remove redundant role hints, and distinguish participant selection from connection state. - Clarify room access, passwords and invitations. Copy feedback now belongs to the current link and operation, so late results cannot replace newer feedback. - Correct capture details, metric units and observation intervals. Unknown capture values are no longer replaced with configured ceilings. - Align illustrated hints, status icons and motion. Improve source-picker focus, keyboard operation, theater layout and touch targets. - Default the Server to 20 viewers, configurable from 1 to 20. The host does not count toward that limit. - Update the website, guide links and bilingual instructions, and remove obsolete previews and unused code. Compatibility: when an older App connects to an updated Site, the Site keeps its saved presentation preferences. Change language or theme on the destination page when using an older launcher. ## Verification / 验证 Non-publishing [CI candidate run 34919320511](https://github.com/TNTcraftHIM/Piik/actions/runs/34919320511) passed Go core, race, Web checks, Server/container verification and all three native App package checks at source 188376e8. Subsequent commits only update deployment documentation, status and TODO; documentation/hygiene checks passed. Product inputs are unchanged. - `npm run check`: TypeScript, 64 test files / 854 tests, and the Web production build passed. - `npm run check:client-core`: final Go source passed tests, formatting, vet and core target builds. Windows capture compilation and geometry checks passed earlier in this phase; later edits did not change native capture. - Website build, documentation checks, repository hygiene and diff checks passed. Existing documentation-size and bundle-size warnings remain. - Actual browser flows covered sharing, source changes, pause/resume, late audio, brief signaling loss, invitation/copy feedback, entry preferences, source-picker focus, and narrow layouts. - A local three-viewer P2P relay check covered quality-report expiry, recovery and cleanup without interrupting video. A controlled browser-helper failure returning `0xc0000005` left the real App launcher and Local service available. - Homepage checks covered Chinese/English, light/dark preferences and inline-film open/close after removing the separate-page entry. Limits: no new reporter-machine confirmation for #396 or the Windows URL-handler crash; physical Safari/mobile, macOS/Linux capture and wider public-network/endurance coverage remain deferred. Formal release artifacts will be built from the approved squash-merge revision. Hero-loop controls and video-adjacent tooltip placement remain open design items in TODO. ## Impact / 影响 Compatible patch; signaling, Native control and capture contracts are unchanged. Older App launch handoff keeps the updated Site's saved presentation preferences. The Server's default viewer limit is corrected to 20; an explicit 1–20 configuration remains valid. Service updates retain persisted room authority but restart active media sessions. Deploy the verified immutable Server artifact through the existing bounded health/recovery process. Public Demo remains open and P2P-only; deployment does not enable SFU or change infrastructure/configuration.
71 lines
3.4 KiB
Bash
71 lines
3.4 KiB
Bash
# Application
|
|
# Use 127.0.0.1 instead when only a same-host reverse proxy should connect.
|
|
LISTEN_HOST=0.0.0.0
|
|
PORT=8787
|
|
# For LAN viewers, replace localhost with this computer's LAN address.
|
|
PUBLIC_BASE_URL=http://localhost:8787
|
|
# Include both the host browser origin and PUBLIC_BASE_URL when they differ.
|
|
ALLOWED_ORIGINS=http://localhost:8787
|
|
# Optional site access password in every environment. Unset or empty allows
|
|
# entry without a site password; room ownership and invitations still apply.
|
|
# Non-empty values are matched exactly; spaces and Unicode are supported.
|
|
SITE_ACCESS_PASSWORD=
|
|
# Rooms persist in rooms.sqlite under the working directory by default (also
|
|
# when blank). Set :memory: explicitly for process-memory rooms. Deployments
|
|
# should use an access-restricted absolute path outside the release directory,
|
|
# preserving the existing database and its writable parent across updates.
|
|
ROOM_DATABASE_PATH=
|
|
# Viewers per room, excluding the Host. Valid range: 1..20; default: 20.
|
|
MAX_VIEWERS_PER_ROOM=20
|
|
# Bounded standard-WebRTC relay/SFU controller is active for every room.
|
|
# One steady outbound media-copy capacity for every non-server endpoint.
|
|
# A peer child or Host SFU publication consumes one copy. Valid values: 1, 2, 3.
|
|
ENDPOINT_MEDIA_COPY_CAPACITY=2
|
|
# During pre-release route canaries, this enables sanitized room/ordinal events.
|
|
# PIIK_DEBUG=route
|
|
|
|
# Optional in-process automatic SFU fallback. Set SFU_UDP_PORT=7882 to enable;
|
|
# unset or empty disables it and fixes Privacy mode on for every room.
|
|
# STUN/signaling/P2P remain available. Local App modes never create this listener.
|
|
# Ingress uses the 9000-room code capacity; egress uses that capacity times the
|
|
# configured per-room Viewer admission.
|
|
SFU_UDP_PORT=
|
|
# IPv4 bind address, independent of HTTP LISTEN_HOST and advertised media IP.
|
|
SFU_LISTEN_HOST=0.0.0.0
|
|
# Optional advertised IPv4 override when the listener's address is behind NAT.
|
|
SFU_PUBLIC_IP=
|
|
|
|
# Ordinary peer ICE discovery. Production requires at least one STUN URL.
|
|
# These are advertised addresses, not local listener addresses. They may use
|
|
# an unproxied DNS name distinct from PUBLIC_BASE_URL. Separate URLs with commas.
|
|
STUN_URLS=
|
|
# Hosted STUN is in-process. With STUN_URLS configured, bind this IPv4 address
|
|
# on UDP 3478 (also 3479/3480 below). It is independent of HTTP LISTEN_HOST.
|
|
# Local App modes never create these listeners, even with public discovery.
|
|
STUN_LISTEN_HOST=0.0.0.0
|
|
|
|
# Optional bounded NAT traversal support. The per-share switch stays visible;
|
|
# it is locked off when disabled, and defaults on when enabled after all three
|
|
# local STUN listeners bind. Browser
|
|
# P2P derives UDP 3479/3480 from the first STUN_URLS endpoint on UDP 3478.
|
|
# Cloud security-group and host firewall rules must also allow these UDP ports.
|
|
NAT_PREDICTION_ENABLED=false
|
|
|
|
# Development example (two processes): Vite serves the Browser on 8787 and
|
|
# proxies /api, /healthz and /signal to the Go server on 8788. Keep
|
|
# PUBLIC_BASE_URL and ALLOWED_ORIGINS on the Browser origin above.
|
|
# PIIK_ENV=development
|
|
# PORT=8788
|
|
|
|
# Production example (keep any chosen password in an untracked environment):
|
|
# PIIK_ENV=production
|
|
# PUBLIC_BASE_URL=https://share.example.com
|
|
# ALLOWED_ORIGINS=https://share.example.com
|
|
# SITE_ACCESS_PASSWORD=
|
|
# STUN_URLS=stun:stun.example.com:3478
|
|
# NAT_PREDICTION_ENABLED=true
|
|
# Automatic SFU fallback (does not replace STUN above):
|
|
# SFU_UDP_PORT=7882
|
|
# SFU_PUBLIC_IP=198.51.100.5
|
|
# ENDPOINT_MEDIA_COPY_CAPACITY=2
|