msgbyte--tianji/README.md

<!-- WEHUB_ZH_README -->
> [!NOTE]
> 本文档由 WeHub 基于上游 README 翻译整理，属于社区翻译，非官方中文文档。  
> [English](./README.en.md) · [原始项目](https://github.com/msgbyte/tianji) · [上游 README](https://github.com/msgbyte/tianji/blob/HEAD/README.md)  
> 原作者、版权与许可证归属以原始项目及本仓库 LICENSE 文件为准。

[![CI](https://github.com/msgbyte/tianji/actions/workflows/ci.yaml/badge.svg)](https://github.com/msgbyte/tianji/actions/workflows/ci.yaml)
[![Build Reporter Release](https://github.com/msgbyte/tianji/actions/workflows/reporter-release.yml/badge.svg)](https://github.com/msgbyte/tianji/actions/workflows/reporter-release.yml)
[![Docker Build CI](https://github.com/msgbyte/tianji/actions/workflows/ci-docker.yaml/badge.svg)](https://github.com/msgbyte/tianji/actions/workflows/ci-docker.yaml)
![Docker Pulls](https://img.shields.io/docker/pulls/moonrailgun/tianji)
![Docker Image Size](https://img.shields.io/docker/image-size/moonrailgun/tianji)
![Tianji Visitor](https://tianji.moonrailgun.com/telemetry/clnzoxcy10001vy2ohi4obbi0/cltjxvcwm02wdut4e106maek7/badge.svg?url=http://github.com/msgbyte/tianji)

# Tianji

<img src="./website/static/img/logo.svg" width="128" />

**All-in-One Insight Hub**

`Website analytics` + `Uptime Monitor`  + `Server Status` = `Tianji`

一个项目搞定一切！

## Motivation

在观察网站运营的过程中，我们经常需要同时使用多个应用。例如，我们需要 `GA`/`umami` 等分析工具来查看 PV/UV 以及各页面的访问次数；我们需要可用性监控来检查服务器的网络质量与连通性；我们还需要通过 prometheus 获取服务器上报的状态，以评估服务器质量。此外，如果我们开发的是支持开源部署的应用，通常还需要一套遥测（telemetry）系统，帮助我们收集他人部署情况的最基本信息。

我认为这些工具本应服务于同一目的——是否存在一款应用，能以轻量方式整合这些常见需求？毕竟大多数时候我们并不需要非常专业、深入的功能；但为了实现全面监控，我却不得不安装这么多服务。

术业有专攻——如果我们就是相关领域的专家，当然需要这类专业工具。但对大多数只有轻量需求的用户而言，一款 **All-in-One** 应用会更方便、更易用。

## Roadmap

- [x] website analysis
- [x] monitor
  - [x] support passive reception of results
- [x] server status
- [x] problem notification
- [x] telemetry
- [x] openapi
- [x] website
- [x] team collaboration
- [x] utm track
- [x] waitlist
- [x] survey
  - [ ] survey page
- [x] lighthouse report
- [x] hooks
- [x] helm install support
  - [x] allow install from public
- [x] improve monitor reporter usage
  - [x] uninstall guide
  - [x] download from server
  - [x] custom params guide

## Preview

![](./website/static/img/preview/1.png)

![](./website/static/img/preview/2.png)

![](./website/static/img/preview/3.png)

![](./website/static/img/preview/4.png)

![](./website/static/img/preview/5.png)

![](./website/static/img/preview/6.png)

## Translation

### Add a new translation

modify those file:
- `src/client/i18next-toolkit.config.cjs` in this file, edit country code
- `src/client/utils/i18n.ts` in this file, add for display

Then, run below code to auto generate

```bash
cd src/client
pnpm install
pnpm run translation:extract
pnpm run translation:translate # this will call chatgpt to run auto translation, so you need set env `OPENAPI_KEY` to make sure run correct
```

Then manual check translation file in `src/client/public/locales`

### Improve translation

Direct update  `src/client/public/locales`

## Open Source

`Tianji` is open source with `Apache 2.0` license.

And its inspired by `umami` license which under `MIT` and `uptime-kuma` which under `MIT` license too

### One-Click Deployment

[![Deploy on Hostinger](https://assets.hostinger.com/vps/deploy.svg)](https://www.hostinger.com/vps/docker-hosting?compose_url=https://github.com/msgbyte/tianji/)

[![Deploy on Sealos](https://cdn.jsdelivr.net/gh/labring-actions/templates@main/Deploy-on-Sealos.svg)](https://cloud.sealos.io/?openapp=system-template%3FtemplateName%3Dtianji)

[![Deploy to RepoCloud](https://d16t0pc4846x52.cloudfront.net/deploylobe.svg)](https://repocloud.io/details/?app_id=270)

[![Deploy to Render](https://render.com/images/deploy-to-render-button.svg)](https://render.com/deploy?repo=https://github.com/msgbyte/tianji)

[![Run on ClawCloud](https://raw.githubusercontent.com/ClawCloud/Run-Template/refs/heads/main/Run-on-ClawCloud.svg)](https://template.run.claw.cloud/?referralCode=TNW6NVWTLHPQ&openapp=system-fastdeploy%3FtemplateName%3Dtianji)