Skip to content

Commit c2c897a

Browse files
Fanju6Fanju6
committed
init
0 parents  commit c2c897a

13 files changed

Lines changed: 2666 additions & 0 deletions

File tree

‎.github/dependabot.yml‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Dependabot 配置文件
2+
# 用于自动检查和更新依赖
3+
4+
version: 2
5+
updates:
6+
# 维护 npm 包依赖（website 目录）
7+
- package-ecosystem: "npm"
8+
directory: "/website"
9+
schedule:
10+
interval: "daily"
11+
commit-message:
12+
prefix: "chore(deps)"
13+
14+
# 维护 GitHub Actions 依赖
15+
- package-ecosystem: "github-actions"
16+
directory: "/"
17+
schedule:
18+
interval: "daily"
19+
commit-message:
20+
prefix: "chore(deps)"

‎.github/workflows/deploy.yml‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# 构建 VitePress 站点并将其部署到 GitHub Pages 的示例工作流程
2+
#
3+
name: Deploy VitePress site to Pages
4+
5+
on:
6+
# 在针对 `main` 分支的推送上运行。如果你
7+
# 使用 `master` 分支作为默认分支，请将其更改为 `master`
8+
push:
9+
branches: [main]
10+
11+
# 允许你从 Actions 选项卡手动运行此工作流程
12+
workflow_dispatch:
13+
14+
# 设置 GITHUB_TOKEN 的权限，以允许部署到 GitHub Pages
15+
permissions:
16+
contents: read
17+
pages: write
18+
id-token: write
19+
20+
# 只允许同时进行一次部署，跳过正在运行和最新队列之间的运行队列
21+
# 但是，不要取消正在进行的运行，因为我们希望允许这些生产部署完成
22+
concurrency:
23+
group: pages
24+
cancel-in-progress: false
25+
26+
jobs:
27+
# 构建工作
28+
build:
29+
runs-on: ubuntu-latest
30+
steps:
31+
- name: Checkout
32+
uses: actions/checkout@v6
33+
with:
34+
fetch-depth: 0 # 如果未启用 lastUpdated，则不需要
35+
# - uses: pnpm/action-setup@v3 # 如果使用 pnpm，请取消此区域注释
36+
# with:
37+
# version: 9
38+
# - uses: oven-sh/setup-bun@v1 # 如果使用 Bun，请取消注释
39+
- name: Setup Node
40+
uses: actions/setup-node@v6
41+
with:
42+
node-version: 20
43+
cache: npm # 或 pnpm / yarn
44+
cache-dependency-path: website/package-lock.json
45+
- name: Setup Pages
46+
uses: actions/configure-pages@v5
47+
- name: Install dependencies
48+
run: npm ci # 或 pnpm install / yarn install / bun install
49+
working-directory: website
50+
- name: Build with VitePress
51+
run: npm run docs:build # 或 pnpm docs:build / yarn docs:build / bun run docs:build
52+
working-directory: website
53+
- name: Upload artifact
54+
uses: actions/upload-pages-artifact@v4
55+
with:
56+
path: website/docs/.vitepress/dist
57+
58+
# 部署工作
59+
deploy:
60+
environment:
61+
name: github-pages
62+
url: ${{ steps.deployment.outputs.page_url }}
63+
needs: build
64+
runs-on: ubuntu-latest
65+
name: Deploy
66+
steps:
67+
- name: Deploy to GitHub Pages
68+
id: deployment
69+
uses: actions/deploy-pages@v4

‎.gitignore‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Gradle files
2+
.gradle/
3+
build/
4+
5+
# Local configuration file (sdk path, etc)
6+
local.properties
7+
8+
# Log/OS Files
9+
*.log
10+
11+
# Android Studio generated files and folders
12+
captures/
13+
.externalNativeBuild/
14+
.cxx/
15+
*.apk
16+
output.json
17+
18+
# IntelliJ
19+
*.iml
20+
.idea/
21+
misc.xml
22+
deploymentTargetDropDown.xml
23+
render.experimental.xml
24+
25+
# Keystore files
26+
*.jks
27+
*.keystore
28+
29+
# Google Services (e.g. APIs or Firebase)
30+
google-services.json
31+
32+
# Android Profiling
33+
*.hprof

‎PrivacyPolicy.md‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# **隐私政策**
2+
3+
**生效日期**：2025 年 2 月 5 日
4+
5+
欢迎使用 **ProxMonitor**（以下简称“本应用”）。本隐私政策描述了我们如何收集、使用和保护您的信息。由于本应用面向儿童用户，我们特别注重保护儿童隐私。
6+
7+
## **1. 我们收集的信息**
8+
9+
本应用仅收集以下类型的信息：
10+
11+
- **用户 PVE 账户信息**：为了使用本应用，用户需要登录其 Proxmox VE（PVE）服务器。我们会存储 PVE 的 API 访问凭据（如用户名、密码或 API Token），所有凭据均**仅存储在本地**，不会上传到服务器或第三方。
12+
- **设备信息**（通过 Microsoft App Center 采集）：包括设备型号、操作系统版本、应用崩溃日志等，以帮助我们改进应用性能。此数据是匿名的，不涉及任何个人身份信息。
13+
14+
**我们不会收集任何个人身份信息**，例如姓名、电子邮件地址或家庭住址，也不会收集儿童的敏感信息。
15+
16+
## **2. 数据存储和安全**
17+
18+
- 所有 PVE 账户数据均存储在用户本地设备的 **DataStore** 中，并且不会上传到远程服务器。
19+
- 我们使用 Microsoft App Center 收集设备的匿名数据，以帮助我们改进应用的功能和稳定性。这些数据不包括个人身份信息，并且不会用于广告或其他商业用途。
20+
- 本应用不会与第三方共享任何个人数据。
21+
22+
## **3. 第三方服务**
23+
24+
本应用集成了以下第三方服务：
25+
26+
- **Microsoft App Center**（用于应用崩溃报告和性能分析）。
27+
- 这些第三方服务可能会收集匿名数据，详细信息请参见 Microsoft 的[隐私政策](https://privacy.microsoft.com/)。
28+
29+
我们确保这些服务不涉及收集儿童的个人信息，并且遵守所有相关的儿童隐私保护法规。
30+
31+
## **4. 用户控制权**
32+
33+
- 用户可以随时清除应用数据，删除存储的 PVE 登录信息。
34+
- 用户可以选择**禁用崩溃报告和分析数据**，方法是进入应用设置并关闭相关选项。
35+
36+
## **5. 儿童隐私**
37+
38+
**我们非常重视儿童的隐私保护**，并遵循《儿童在线隐私保护法》（COPPA）及其他适用的隐私保护法规。
39+
40+
- 本应用**不收集任何可识别个人身份的儿童信息**，并且不允许儿童提供个人信息。
41+
- 如果我们意识到在未获得父母或监护人同意的情况下，收集了儿童的个人信息，我们将采取措施立即删除这些信息。
42+
43+
## **6. 隐私政策的更新**
44+
45+
我们可能会更新本隐私政策，以反映新的服务或法律要求。更新后，我们会通过应用内的通知或官方渠道告知用户。
46+
47+
## **7. 联系我们**
48+
49+
如果您有任何关于儿童隐私或本隐私政策的问题，或者您想删除您的信息，请通过以下方式与我们联系：
50+
51+
**开发者邮箱：**fanju745@gmail.com

‎README.md‎

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
# ProxMonitor
2+
3+
ProxMonitor 是一个用于监控和管理 Proxmox VE 服务器的 Android 应用。它提供了直观的界面来查看和控制您的虚拟化环境。
4+
5+
[![Latest release](https://img.shields.io/github/v/release/Fanju6/ProxMonitor?label=Release&logo=github)](https://github.com/Fanju6/ProxMonitor/releases/latest)
6+
[![Channel](https://img.shields.io/badge/Follow-Telegram-blue.svg?logo=telegram)](https://t.me/ProxMonitor)
7+
8+
<div style="display: flex; justify-content: space-around;">
9+
<img src="/Screenshots/Screenshot1.png" width="30%" />
10+
<img src="/Screenshots/Screenshot2.png" width="30%" />
11+
<img src="/Screenshots/Screenshot3.png" width="30%" />
12+
</div>
13+
14+
15+
## 功能特点
16+
17+
- 🖥️ 资源监控
18+
- 实时查看节点、虚拟机和存储的状态
19+
- 监控 CPU、内存、网络和磁盘使用情况
20+
- 支持图表展示历史数据
21+
22+
- 💻 虚拟机管理
23+
- 开机/关机操作
24+
- 通过 noVNC 访问虚拟机控制台
25+
- 查看虚拟机详细信息和性能指标
26+
27+
- 📊 存储管理
28+
- 查看存储空间使用情况
29+
- 监控存储性能
30+
- 浏览存储内容
31+
32+
- 🔒 安全特性
33+
- 支持 HTTPS 连接
34+
- 基于 ticket 的身份验证
35+
- 安全的凭证存储
36+
37+
## 系统要求
38+
39+
- Android 8.0 (API 26) 或更高版本
40+
- Proxmox VE 7.0 或更高版本
41+
- 网络连接到 Proxmox VE 服务器
42+
43+
## 安装说明
44+
45+
1. 从 [Releases](https://github.com/Fanju6/ProxMonitor/releases) 页面下载最新的 APK
46+
2. 在 Android 设备上安装 APK
47+
3. 启动应用并输入您的 Proxmox VE 服务器信息：
48+
- 服务器地址 (例如: https://pve.example.com:8006)
49+
- 用户名 (格式: user@pam 或 user@pve)
50+
- 密码
51+
52+
## 使用说明
53+
54+
### 登录
55+
1. 输入服务器地址、用户名和密码
56+
2. 点击登录按钮
57+
3. 登录成功后会自动保存凭证
58+
59+
### 资源监控
60+
- 主页面显示所有节点、虚拟机和存储的概览
61+
- 点击任意资源可查看详细信息
62+
- 支持下拉刷新更新数据
63+
64+
### 虚拟机管理
65+
- 点击虚拟机卡片进入详情页面
66+
- 使用顶部工具栏的按钮进行开机/关机操作
67+
- 点击控制台图标打开 noVNC 远程访问
68+
69+
### 存储管理
70+
- 在存储详情页面可查看使用情况
71+
- 支持查看存储内容列表
72+
- 提供多个时间范围的性能数据图表
73+
74+
## 技术栈
75+
76+
- 使用 Kotlin 和 Jetpack Compose 开发
77+
- 遵循 Material Design 3 设计规范
78+
- 采用 MVVM 架构
79+
- 使用 Hilt 进行依赖注入
80+
- 使用 Retrofit 进行网络请求
81+
- 使用 DataStore 进行数据持久化
82+
83+
84+
## 致谢
85+
86+
- [Proxmox VE](https://www.proxmox.com/en/proxmox-ve) - 优秀的虚拟化平台
87+
- [noVNC](https://novnc.com/) - HTML5 VNC 客户端

‎Screenshots/Screenshot1.png‎

353 KB
Loading

‎Screenshots/Screenshot2.png‎

400 KB
Loading

‎Screenshots/Screenshot3.png‎

396 KB
Loading

‎website/docs/.vitepress/config.js‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
export default {
2+
base: "/ProxMonitor/",
3+
title: 'ProxMonitor',
4+
description: 'Proxmox VE 服务器监控和管理的 Android 应用',
5+
themeConfig: {
6+
logo: '/logo.png',
7+
nav: [
8+
{ text: '主页', link: '/' },
9+
{ text: '指南', link: '/guide/' },
10+
{ text: 'GitHub', link: 'https://github.com/Fanju6/ProxMonitor/' }
11+
],
12+
sidebar: {
13+
'/guide/': [
14+
{
15+
text: '入门指南',
16+
items: [
17+
{ text: '简介', link: '/guide/' },
18+
{ text: '安装', link: '/guide/installation' },
19+
{ text: '使用说明', link: '/guide/usage' }
20+
]
21+
},
22+
{
23+
text: '功能',
24+
items: [
25+
{ text: '资源监控', link: '/guide/monitoring' },
26+
{ text: '虚拟机管理', link: '/guide/vm-management' },
27+
{ text: '存储管理', link: '/guide/storage' }
28+
]
29+
}
30+
]
31+
},
32+
footer: {
33+
message: 'Released under the MIT License.',
34+
copyright: 'Copyright © 2024-present ProxMonitor'
35+
}
36+
}
37+
}

‎website/docs/guide/index.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# ProxMonitor 简介
2+
3+
ProxMonitor 是一个专为 Proxmox VE 服务器设计的 Android 监控和管理应用。它提供了直观的界面，让您能够随时随地管理您的虚拟化环境。
4+
5+
## 系统要求
6+
7+
- Android 6.0 (API 24) 或更高版本
8+
- Proxmox VE 7.0 或更高版本
9+
- 网络连接到 Proxmox VE 服务器
10+
11+
## 技术栈
12+
13+
- 使用 Kotlin 和 Jetpack Compose 开发
14+
- 遵循 Material Design 3 设计规范
15+
- 采用 MVVM 架构
16+
- 使用 Hilt 进行依赖注入
17+
- 使用 Retrofit 进行网络请求
18+
- 使用 DataStore 进行数据持久化

0 commit comments

Comments
 (0)