AAA
cdd503a98d
Waiting feedback and tooltips now share consistent presentation lifecycles, while App shutdown and native-media operation failures stay within their owning session or output. This phase also consolidates the project standards and publishes searchable English/Chinese reader documentation alongside the homepage. Validation: repository hygiene and Markdown links; TypeScript, 971 Web tests and production build; website/documentation build; Go tests, vet and Windows/Linux builds with Windows capture checks; desktop/mobile UI and documentation review. Linux race, container and three-platform packaging checks run in the release pipeline. Physical macOS/Linux capture and broader network coverage remain outside this acceptance. The owner approved v1.4.0 publication. Existing empty-source, Windows URL-handler and public-invitation timeout reports remain tracked; this release makes no claim to resolve those device/network reports. The Windows capture-border request is next-phase work. ## Release notes ### 中文 这是一次以稳定性和交互一致性为重点的功能更新。等待与提示更有反馈，App 启动、原生分享和连接恢复的边界处理得到改善，使用与部署指南也有了统一的文档中心。 #### 新增与改进 - 欢迎语、等待短句和六类可轮换的标签页标题共用一致的显示规则。等待短句从一开始就出现，并在停留时轮换；明确的错误与操作提示保持固定。 - 房间准入等漫画采用更克制的小人物与循环动效。改进 tooltip 的定位与指向，减少对播放器的遮挡；状态、图标和文案保持相同含义。 - 新增中英文文档中心，提供搜索、手机目录、使用教程、问题排查与自部署指南。官网 FAQ 聚焦开始使用前的问题，详细排查统一进入文档中心。 #### 修复 - 使用 `--local` 启动不再清空已保存的 Piik 站点地址。 - 打开系统浏览器不再阻塞 App 的退出流程；改进临时公网邀请、终端和诊断导出在关闭时的清理及错误反馈。 - 单条原生媒体连接的操作失败不再被误判为整个会话的协议错误；重复停止分享保持幂等。 - 修复连接替换、转发停止和异常退出时的部分资源清理问题，避免迟到结果影响当前连接。 - Windows 原生采集中，单个输出的编码错误只结束对应输出；共享采集源本身的错误仍会结束分享。 #### 升级与已知边界 本次保持现有协议版本与配置格式。更新 App 或自托管 Server 后，重新打开页面即可使用对应的新界面。 个别设备的空窗口列表、Windows 浏览器启动异常，以及 Linux 编码输出的故障隔离仍在跟进。macOS/Linux 的物理采集和更广泛的公网网络场景仍需实机验证；本次不宣称这些问题已经解决，也不承诺所有网络都能直连。 ### English This feature update focuses on stability and consistent feedback. Waiting states are easier to follow, App startup and native sharing handle several failure cases more reliably, and the new documentation center brings usage and deployment guides together. #### New and improved - Welcome lines, waiting captions and six groups of rotating tab titles follow one presentation lifecycle. Waiting captions appear immediately and rotate while visible; actionable errors and instructions remain fixed. - Room-admission comics use restrained characters and looping motion. Tooltips point more accurately to their controls and interfere less with the player, with consistent meanings across illustrations, icons and copy. - A new English/Chinese documentation center includes search, mobile navigation, usage guides, troubleshooting and self-hosting. The homepage FAQ covers questions before getting started and links to the documentation for detailed help. #### Fixes - Starting with `--local` no longer clears a saved Piik site address. - Opening the system browser no longer blocks App shutdown. Temporary public invitations, the terminal and diagnostic exports handle cleanup and exit errors more consistently. - An operation failure on one native media connection no longer becomes a protocol failure for the entire session. Repeated stop-sharing requests are safe. - Fixed cleanup cases during connection replacement, relay shutdown and unexpected exits, preventing late results from affecting the current connection. - On Windows, an encoder failure for one native output stops that output only. A failure of the shared capture source still ends sharing. #### Updating and known limits Protocol versions and configuration formats are unchanged. After updating the App or your self-hosted Server, reopen the page to use its updated interface. Empty source lists on some devices, Windows browser-launch failures and Linux output-failure isolation remain under investigation. Physical macOS/Linux capture and broader public-network coverage still need device testing; this update does not claim to resolve those cases or guarantee a direct connection on every network.
4.6 KiB
Deploy Piik Server
English · 简体中文 · Documentation
Piik Server packages the web interface, room management and optional media forwarding in one server binary. Extract and run it; room data is stored in SQLite.
Try it locally
These server instructions use a Linux x64 machine.
Download piik-<revision>-runtime.tar.gz, the Linux x64 Server archive,
from GitHub Releases
or the Gitee mirror.
Extract it and run the following in its directory:
./piik-server
Open http://localhost:8787. This is a local trial; use the configuration below
to let friends connect over the internet. To start a temporary room on your computer,
use the Piik App guide.
Docker Compose
On a Linux x64 server with Docker Compose v2, download the two deployment files into an empty directory:
curl -fsSLo compose.yaml https://raw.githubusercontent.com/TNTcraftHIM/Piik/main/deploy/container/compose.yaml
curl -fsSLo .env https://raw.githubusercontent.com/TNTcraftHIM/Piik/main/deploy/container/.env.example
Replace share.example.com in .env with your domain, then start Piik:
docker compose run --rm piik --check-config
docker compose up -d
The ghcr.io/tntcrafthim/piik:latest image includes the Web UI, signaling, STUN
and optional SFU. Complete HTTPS and
firewall configuration below. The default is P2P;
the sample .env also shows how to enable SFU fallback. Keep the piik-data
volume, which stores room data and optional diagnostics. See
container maintenance for updates and backups.
Put it online
You need a Linux x64 server and a domain pointing to its public IP.
The example uses share.example.com; replace it with your domain.
1. Configure and start Piik
Create a .env file next to the binary:
PIIK_ENV=production
LISTEN_HOST=127.0.0.1
PUBLIC_BASE_URL=https://share.example.com
STUN_URLS=stun:share.example.com:3478
MAX_VIEWERS_PER_ROOM=20
SITE_ACCESS_PASSWORD=
Run these commands from that directory as a regular user:
./piik-server --check-config
./piik-server
The server reads .env automatically and stores rooms in rooms.sqlite in the
working directory. A blank SITE_ACCESS_PASSWORD allows
entry without a site passphrase; enter a passphrase to require one.
Room invitations and access settings still apply.
MAX_VIEWERS_PER_ROOM sets the room's Viewer limit, excluding the Host. Choose
1..20 and restart to apply it. More Viewers can require more network and relay
resources. See room capacity
for defaults and the difference from App rooms.
2. Enable HTTPS
Use your existing HTTPS reverse proxy to forward to 127.0.0.1:8787 with
WebSocket support. If you do not have one, install Caddy
and add this to its Caddyfile:
share.example.com {
reverse_proxy 127.0.0.1:8787
}
Reload Caddy. It obtains and renews the certificate automatically when DNS points to the server and TCP 80/443 are reachable. See Caddy's HTTPS proxy guide.
3. Open the ports and verify
Allow TCP 80/443 for HTTPS and UDP 3478 for STUN in the server firewall and cloud security group. Keep TCP 8787 private. The STUN hostname must resolve directly to the server; a CDN HTTP proxy does not forward its UDP traffic.
Open https://share.example.com/healthz; it should return {"status":"ok"}.
Then open the site, share a screen and join from another device. This initial
configuration uses P2P media, so participants need a usable UDP path.
Optional: media fallback
Add SFU_UDP_PORT=7882 to .env, allow UDP 7882, and restart Piik to enable
automatic SFU fallback. When the server is behind NAT, also set SFU_PUBLIC_IP
to its reachable public IPv4 address. The same binary provides the fallback.
The Host must turn off Privacy mode before sharing to allow this route.
Both direct and SFU media need a usable UDP connection.
Keep it running and update
For automatic startup, use the systemd or container guide.
Keep .env and rooms.sqlite across updates. Back up room data while the server is
stopped, replace the executable with the new release, then restart and check
health and room access. Read release notes before an upgrade that changes data formats.