Home
Softono

Waken Wa

Open source TypeScript
50
Stars
2
Forks
0
Issues
0
Watchers
2 months
Last Commit

 About Waken Wa

Waken Wa is a self-hosted personal status dashboard designed as a live personal homepage for sharing your digital life with friends. Inspired by Sleepy and Shiro, it goes beyond a basic monitoring panel to serve as a customizable personal space showcasing what you are doing across devices and apps. Core features include multi-device status auto-sync via Reporter or API clients that report data from desktop, mobile, or scripts; display of currently playing music, active applications, Steam games, and ICS calendar schedules; theme color extraction, custom backgrounds, status text rules, and personalized cards for visual customization; and embeddable status cards suited for personal homepages, BBS signatures, and GitHub README badges. Deployment options include a one-line Docker install script (curl), source-built Docker Compose on Windows or Linux, Railway one-click deploy, and Vercel with PostgreSQL and Redis. A companion project, Waken-Wa-Reporter, handles client-side status collection. The platform also offe

Platforms

Web Self-hosted

Languages

TypeScript

Need Help Installing Waken Wa?

We provide expert installation service for this software. Our team will install, configure, and secure Waken Wa on your server. plans start at just $30.

😴晨光里睁眼是醒,深夜写下"今天很好"也是醒。

Waken Wa

Waken Wa💫

visitors License GitHub Actions Workflow Status DeepWiki

Preview core

✨ 一个自托管的个人状态围观面板

🎗️把你的设备、听歌、应用、Steam、日程和随想,变成一个实时更新的个人主页

🌟项目灵感来源于 SleepyShiro

✨ 在这里查看 Demo! Status

可以用来做什么?

🕵️ 自托管的赛博视奸面板

把你的在线状态、正在听的歌、使用中的应用、Steam 游戏、日程和随想,变成一个可以被朋友围观的实时主页。

🎨 不是普通状态页,而是个人数字生活展示

Image-preview-main

支持主题取色、背景定制、状态文案规则和个性化卡片,让页面更像“你的个人空间”,而不是冷冰冰的监控面板。

📡 多设备状态自动同步

Image-preview-main

通过 Reporter / API 上报桌面、移动端或脚本状态,自动展示你现在正在做什么。

🎵 支持音乐、应用、游戏和日程

Image-preview-main_2

不仅能显示在线 / 离线,还能展示听歌进度、当前应用、Steam 游戏、ICS 课表 / 日程等生活状态。

🧩 可嵌入、可扩展

当前状态

适合作为个人主页、BBS 签名卡、GitHub README 状态卡、朋友之间的“围观入口”,也可以通过 OpenAPI 和自定义规则扩展。

具体更多详情请查看: Waken-Wa-Docs

部署

如果需要使用,请配合 Waken-Wa-Reporter

1. 本机部署

Docker(使用已打包的一键脚本)

需已安装 Docker(含 docker compose)。在终端执行:

curl -fsSL https://waken-wa.xwx.today | bash

如果你想部署最新的 main 分支版本,可以显式启用:

curl -fsSL https://waken-wa.xwx.today | USE_LATEST_VERSION=1 bash

自编译(源码)

在已克隆的本仓库根目录执行:

chmod +x deploy-build-from-source.sh   # Unix 首次需要
./deploy-build-from-source.sh
# 或: bash deploy-build-from-source.sh

在 Windows 下部署

1. 准备环境
  • Docker Desktop(推荐)或 Podman Desktop 等支持 Docker Compose 的容器工具
2. 获取项目代码

使用 Git(推荐):

git clone https://github.com/MoYoez/waken-wa.git
cd waken-wa

或手动下载 ZIP 并解压后进入项目目录。

3. 配置环境变量
  • 复制仓库中的 .env.example.env,根据需要调整配置,一般来说你可以不用配置,定制化需要。
4. 启动容器

如果只需直接运行官方镜像,在项目根目录打开 PowerShell 或 CMD,执行:

docker compose up -d
5. 从源码自定义构建(如需源码修改或自定义镜像)

在项目根目录运行:

docker compose up -d --build

2. Railway

Deploy on Railway

Railway 可能需要使用 Hobby 方案.

3. Vercel

需要使用 PostgresSQL (SupaBase / Neon) + Redis ,且开销较高 (SSE 长连接 / Realtime POST 多)

如需使用请考虑 非 Realtime 模式上传活动,并且在后台启用 Polling (轮询)

Deploy with Vercel

第一次部署后不用担心报错,在项目的 "Integrations" 中 通过 "Marketplace"找到 PostgreSQLRedis 供应商,Install 后 Connect 到此项目,Redeploy 即可。

如果你想用自己的供应商,请在 env 的 DATABASE_URL 中 写入地址即可,请注意 Vercel 这类 Serverless 平台的URL兼容性,以防止部署失败。

开发

请参考 DEVELOPMENT.md

API Reference

Star History

Star History Chart

License

本项目以 GNU Affero General Public License v3.0(AGPL-3.0)授权发布。完整条款见仓库根目录 LICENSE

Thanks

本项目在 LINUX DO 上宣发,感谢支持!