Skip to content

Commit c7e0d85

Browse files
committed
docs: improve environment variable description
#29 #32
1 parent 27fddee commit c7e0d85

File tree

2 files changed

+56
-291
lines changed

2 files changed

+56
-291
lines changed

README.md

Lines changed: 56 additions & 110 deletions
Original file line numberDiff line numberDiff line change
@@ -13,169 +13,115 @@
1313
</p>
1414

1515
<p align="center" class="hidden">
16-
<a href="./README_ZH.md">简体中文</a>
16+
<a href="./README.md">English</a>
1717
</p>
1818

19-
## 📖 Introduction
19+
## 📖 介绍
2020

21-
An all-in-one KMS toolbox that integrates features such as KMS activation script generation, KMS server detection, and KMS server status monitoring.
21+
一站式 KMS 工具箱,集成了 KMS 激活脚本生成、KMS 服务器检测、KMS 服务器状态监控等功能。
2222

23-
## 📦 Project Demo
23+
项目依赖于 Node.js 的 `child_process` 模块来调用 `vlmcs` 二进制文件执行 KMS 检测服务,无法在 Github Pages 等静态网站托管平台上运行,因此区分了 `full` 全栈版本和 `static` 静态版本。
2424

25-
### Full-Stack Version
25+
## 📦 演示
2626

27-
Thanks to [Zebaur](https://zeabur.com/referral?referralCode=ikxin&utm_source=ikxin&utm_campaign=oss) for providing services for project deployment.
27+
静态版本默认调用 https://kms.ikxin.com 的 API 接口,也可以自行部署全栈版本,然后通过环境变量 `NUXT_PUBLIC_API_URL` 设置。
2828

29-
- [kms.ikxin.com](https://kms.ikxin.com)
29+
### 全栈版本
3030

31-
### Frontend Version
31+
https://kms.ikxin.com
3232

33-
By default, it calls the API interface of [kms.ikxin.com](https://kms.ikxin.com), but you can also deploy your own backend service.
33+
### 静态版本
3434

35-
- Cloudflare: [kmstools.pages.dev](https://kmstools.pages.dev)
36-
- Vercel: [kmstools.vercel.app](https://kmstools.vercel.app)
37-
- Netlify: [kms-tools.netlify.app](https://kms-tools.netlify.app)
35+
| 平台 | 演示链接 |
36+
| ---------- | ----------------------------- |
37+
| Vercel | https://kms-tools.vercel.app |
38+
| Cloudflare | https://kmstools.pages.dev |
39+
| Netlify | https://kms-tools.netlify.app |
3840

39-
## 🌈 Feature Preview
41+
## 🌈 界面预览
4042

41-
| KMS Activation Script Generation | KMS Server Detection | KMS Server Status Monitoring |
43+
| KMS 激活脚本生成 | KMS 服务器检测 | KMS 服务器状态监控 |
4244
| ------------------------------------- | ---------------------------------- | ------------------------------------ |
4345
| ![](./src/assets/images/activate.png) | ![](./src/assets/images/check.png) | ![](./src/assets/images/monitor.png) |
4446

45-
## Tech Stack
47+
## 技术栈
4648

47-
- [Nuxt](https://github.com/nuxt/nuxt) - Full-stack web application framework based on Vue.js
48-
- [Vue.js](https://github.com/vuejs/core) - Progressive JavaScript framework
49-
- [Nitro](https://github.com/nitrojs/nitro) - High-performance web server framework based on unjs/h3
50-
- [Vite](https://github.com/vitejs/vite) - Fast development server and modern build tool
51-
- [VueUse](https://github.com/vueuse/vueuse) - Collection of utility functions based on the Composition API
52-
- [Tailwind CSS](https://github.com/tailwindlabs/tailwindcss) - Utility-first CSS framework
53-
- [Arco Design Vue](https://github.com/arco-design/arco-design-vue) - Enterprise-level product design system by ByteDance
54-
- [Nuxt I18n](https://github.com/nuxt-modules/i18n) - Internationalization support plugin for Nuxt
49+
- [Nuxt](https://github.com/nuxt/nuxt) - 基于 Vue.js 的全栈 Web 应用框架
50+
- [Vue.js](https://github.com/vuejs/core) - 渐进式 JavaScript 框架
51+
- [Nitro](https://github.com/nitrojs/nitro) - 基于 unjs/h3 的高性能 Web 服务端框架
52+
- [Vite](https://github.com/vitejs/vite) - 极速开发服务器和现代构建工具
53+
- [VueUse](https://github.com/vueuse/vueuse) - 基于 Composition API 的实用函数集合
54+
- [Tailwind CSS](https://github.com/tailwindlabs/tailwindcss) - 实用性优先的 CSS 框架
55+
- [Arco Design Vue](https://github.com/arco-design/arco-design-vue) - 字节跳动开发的企业级产品设计系统
56+
- [Nuxt I18n](https://github.com/nuxt-modules/i18n) - 适用于 Nuxt 的国际化支持插件
5557

56-
## 📦 Deployment
58+
## 📦 部署
5759

58-
### Full-Stack Version
60+
### 环境变量
5961

60-
#### Zeabur Deployment
62+
| 名称 | 示例值 | 描述 |
63+
| --------------------- | --------------------------- | ---------------------------------------- |
64+
| `NUXT_PUBLIC_API_URL` | `https://kms.ikxin.com` | 前端版本 API 接口地址 |
65+
| `MONITOR_LIST` | `kms.org.cn,win.freekms.cn` | 自定义监控 KMS 服务器列表,使用 `,` 分隔 |
66+
| `ENABLE_VLMCSD` | `false` | 是否启用 VLMCSD 服务器检测 |
67+
68+
### 全栈版本
69+
70+
#### Zeabur(推荐)
6171

6272
[![Deployed on Zeabur](https://zeabur.com/deployed-on-zeabur-dark.svg)](https://zeabur.com/templates/TXR0D9)
6373

64-
#### Docker Deployment
74+
#### Docker
6575

6676
```bash
6777
docker run -d --name kms-tools -p 3000:3000 ikxin/kms-tools
6878
```
6979

70-
#### Manual Deployment
80+
#### 手动部署
7181

72-
1. Clone the project repository to your local machine and install dependencies
82+
1. 克隆项目仓库到本地,执行命令安装依赖
7383

7484
```bash
7585
git clone https://github.com/ikxin/kms-tools.git
7686
cd kms-tools && pnpm install
7787
```
7888

79-
2. Build the project
89+
2. 执行命令构建项目
8090

8191
```bash
8292
pnpm run build
8393
```
8494

85-
3. Start the server (listening on port `3000` by default)
95+
3. 执行命令启动服务,项目默认监听 `3000` 端口
8696

8797
```bash
8898
node .output/server/index.mjs
8999
```
90100

91-
### Frontend Version
92-
93-
#### Cloudflare Deployment
94-
95-
1. Fork this project to your own repository
96-
97-
2. Create a project on Cloudflare Pages and select the forked repository
98-
99-
3. Set the build command
100-
101-
```bash
102-
pnpm run generate
103-
```
104-
105-
4. Configure environment variables
106-
107-
| Name | Value |
108-
| --------------------- | ----------------------- |
109-
| `NODE_VERSION` | `22` |
110-
| `NUXT_PUBLIC_API_URL` | `https://kms.ikxin.com` |
111-
112-
5. Deploy the project
113-
114-
#### Vercel Deployment
115-
116-
1. Fork this project to your own repository
117-
118-
2. Create a project on Vercel and select the forked repository
119-
120-
3. Set the build command
121-
122-
```bash
123-
pnpm run generate
124-
```
125-
126-
4. Configure environment variables
101+
### 静态版本
127102

128-
| Name | Value |
129-
| --------------------- | ----------------------- |
130-
| `NUXT_PUBLIC_API_URL` | `https://kms.ikxin.com` |
103+
几乎所有 SaaS 平台都支持静态网站托管服务,以下是通用的的 SaaS 平台的部署方式:
131104

132-
5. Deploy the project
105+
> [!WARNING]
106+
> 注意:如果你使用的是 Cloudflare Pages,部署时需要将 `NODE_VERSION` 设置为 `22`,否则构建时会出现报错。
133107
134-
#### Netlify Deployment
135-
136-
1. Fork this project to your own repository
137-
138-
2. Create a project on Netlify and select the forked repository
139-
140-
3. Set the build command
141-
142-
```bash
143-
pnpm run generate
144-
```
145-
146-
4. Configure environment variables
147-
148-
| Name | Value |
149-
| --------------------- | ----------------------- |
150-
| `NUXT_PUBLIC_API_URL` | `https://kms.ikxin.com` |
151-
152-
5. Deploy the project
153-
154-
#### Manual Deployment
155-
156-
1. Clone the project repository to your local machine and install dependencies
157-
158-
```bash
159-
git clone https://github.com/ikxin/kms-tools.git
160-
cd kms-tools && pnpm install
161-
```
162-
163-
2. Build the project
164-
165-
```bash
166-
pnpm run generate
167-
```
108+
1. Fork 本项目仓库到自己的 Github 账户
109+
2. 在 SaaS 平台创建项目,选择刚才 Fork 的仓库
110+
3. 设置项目的构建命令为 `pnpm run generate`
111+
4. 设置环境变量 `NUXT_PUBLIC_API_URL=https://kms.ikxin.com`
112+
5. 点击部署项目即可
168113

169-
3. After building, upload the files from the `.output/public` directory to your server
114+
> [!NOTE]
115+
> 如果在其他 SaaS 平台部署时遇到问题,欢迎提交 Issue 来获得支持。
170116
171-
## Stars
117+
## 星星
172118

173119
<img class="w-full" src="https://starchart.cc/ikxin/kms-tools.svg" />
174120

175-
## 🧑‍💻 Author
121+
## 🧑‍💻 作者
176122

177123
Code with ❤️ by [一纸忘忧](https://blog.ikxin.com '一纸忘忧')
178124

179-
## 📜 License
125+
## 📜 开源协议
180126

181-
[MIT License](./LICENSE 'MIT License') © 2022 ~ Present
127+
[MIT License](./LICENSE 'MIT License') Copyright (c) 2022 ~ Present

0 commit comments

Comments
 (0)