# runphp
**Repository Path**: lopinx/runphp
## Basic Information
- **Project Name**: runphp
- **Description**: RunPHP — 基于 FrankenPHP 的 PHP 建站环境管理软件（桌面端 Tauri 2 / CLI + axum Web 面板）。包含站点管理（域名/HTTPS/Worker/热重载）、数据库管理（SQLite + 远程 MySQL/PG + libSQL）、FTP 服务、hosts 管理。
- **Primary Language**: Rust
- **License**: WTFPL
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-09-02
- **Last Updated**: 2026-09-02
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
# 🐘 RunPHP
### 基于 [FrankenPHP](https://frankenphp.dev) 的 PHP 建站环境管理软件
桌面端 · 服务器端 · 一键下载运行时 · 站点 / 数据库 / Hosts 全管理
[](https://www.rust-lang.org/)
[](https://tauri.app/)
[](https://vuejs.org/)
[](https://www.naiveui.com/)
[](./LICENSE)
[](#-快速开始)
---
## 📋 目录
- [✨ 功能特性](#-功能特性)
- [📸 软件截图](#-软件截图)
- [🛠️ 技术栈](#️-技术栈)
- [📦 快速开始](#-快速开始)
- [📋 CLI 命令一览](#-cli-命令一览)
- [📁 目录结构](#-目录结构)
- [📂 数据目录](#-数据目录)
- [📖 文档](#-文档)
- [📜 许可证](#-许可证)
---
## ✨ 功能特性
| 功能 | 说明 |
|---|---|
| 🚀 **运行时管理** | 首次启动自动从 GitHub Releases 下载 FrankenPHP 二进制，支持多版本并存、本地已有二进制导入 |
| 🌐 **站点管理** | 域名绑定 · 本地 HTTPS（Caddy 内置 CA 自动签发）· Worker 模式（Laravel / Symfony 常驻进程） |
| 🔥 **热重载** | 站点变更后 `frankenphp reload` 热加载，不中断连接 |
| 🗄️ **数据库管理** | 内置 SQLite · libSQL（本地/远程/副本）· 连接管理 MySQL · MariaDB · PostgreSQL · MongoDB · Redis · Qdrant · SSH 隧道 |
| 📁 **FTP 文件管理** | FTP / FTPS / SFTP 三协议 · 档案管理 · 上传/下载/目录递归 · 进度反馈 |
| 🛠️ **Adminer** | 单文件下载 + 数据库管理页面 URL 生成 |
| 📋 **Hosts 管理** | 受管区块读写 · 自动备份 · 无权限时生成提权命令（内嵌于设置页） |
| 🖥️ **多平台** | Windows 桌面 · Linux 桌面（Tauri 2）· 无 UI 的 Linux 服务器（CLI + Web 面板）|
| 🇨🇳 **全程中文** | 界面 · 注释 · 文档 · 提交信息均中文 |
## 📸 软件截图
### 仪表盘页面
### 数据库管理页面
### FTP 文件管理页面
### Hosts 管理页面
### 设置页面
## 🛠️ 技术栈
| 层 | 技术 | 说明 |
|---|---|---|
| 核心逻辑 | **[Rust](https://www.rust-lang.org/)** | `crates/runphp-core`，三端共用，无 UI 依赖 |
| 桌面壳 | **[Tauri 2](https://tauri.app/)** | WebView2 (Windows) · webkit2gtk (Linux) |
| 前端 | **[Vue 3](https://vuejs.org/) + [Vite](https://vitejs.dev/) + TS + [Naive UI](https://www.naiveui.com/)** | 一份构建产物，桌面与面板复用 |
| 无头模式 | **[clap](https://docs.rs/clap) + [axum](https://docs.rs/axum)** | CLI 子命令 + 内建 Web 面板（rust_embed 嵌入前端） |
| SQLite | **[rusqlite](https://docs.rs/rusqlite)** (bundled) | 零外部依赖 |
| MySQL / PG | **[mysql_async](https://docs.rs/mysql_async) + [tokio-postgres](https://docs.rs/tokio-postgres)** | 仅连接管理已有实例 |
## 📦 快速开始
### 🖥️ 桌面端开发
```bash
# 安装依赖
npm install
# 启动桌面端（Tauri 窗口 + Vite 热更新）
npm run tauri dev
# 构建发布包
npm run tauri build
```
### 🖧 无头服务器模式
```bash
# 编译 CLI
cargo build -p runphp-cli --release
# ① 安装 FrankenPHP 运行时
./target/release/runphp runtime install 1.12.7
# ② 创建站点（含 HTTPS）
./target/release/runphp site add mysite \
--domain mysite.test \
--root /var/www/mysite \
--https
# ③ 同步 hosts
./target/release/runphp hosts sync
# ④ 启动服务
./target/release/runphp run
# ⑤ 启动 Web 管理面板（浏览器访问）
./target/release/runphp panel --port 9080
# ⑥ 安装为 systemd 服务
./target/release/runphp service-install
```
## 📋 CLI 命令一览
| 命令 | 说明 |
|---|---|
| `runphp version` | 显示版本 |
| `runphp runtime list` | 列出已安装运行时 |
| `runphp runtime install <版本>` | 下载安装指定版本 |
| `runphp runtime default <版本>` | 设置默认运行时版本 |
| `runphp site list` | 列出全部站点 |
| `runphp site add <名称> --domain <域名> --root <目录> [--https]` | 新建站点 |
| `runphp site rm ` | 删除站点 |
| `runphp run` | 启动 FrankenPHP（前台） |
| `runphp stop` | 停止服务 |
| `runphp reload` | 热重载配置 |
| `runphp status` | 查询运行状态 |
| `runphp logs [--lines <行数>]` | 查看运行时日志末尾（默认 100 行） |
| `runphp hosts list` | 列出受管 hosts 条目 |
| `runphp hosts sync` | 同步站点域名到 hosts |
| `runphp hosts elevation` | 显示提权命令 |
| `runphp ftp list` | 列出 FTP 连接档案 |
| `runphp ftp add <名称> --host <主机> --protocol ` | 添加 FTP 连接 |
| `runphp ftp test ` | 测试连接 |
| `runphp ftp ls --path <路径>` | 列出远程目录 |
| `runphp ftp upload --local <本地> --remote <远程>` | 上传文件 |
| `runphp ftp upload-dir --local <目录> --remote <远程>` | 递归上传文件夹 |
| `runphp ftp download --remote <远程> --local <本地>` | 下载文件 |
| `runphp ftp rmfile --path <路径> [--dir]` | 删除文件或目录 |
| `runphp ftp rename --from <原路径> --to <新路径>` | 重命名 |
| `runphp ftp mkdir --path <路径>` | 创建目录 |
| `runphp panel --port <端口>` | 启动 Web 管理面板 |
| `runphp service-install` | 生成 systemd 服务单元 |
## 📁 目录结构
```
runphp/
├── crates/
│ ├── runphp-core/ # 核心业务库（站点 / 运行时 / 数据库 / FTP / hosts）
│ │ └── src/
│ │ ├── caddy.rs # Caddyfile 生成 + 进程启停 + 热重载
│ │ ├── config.rs # 配置持久化
│ │ ├── runtime.rs # FrankenPHP 下载 / 多版本
│ │ ├── site.rs # 站点模型与 CRUD
│ │ ├── hosts.rs # hosts 受管区块读写
│ │ ├── ftp.rs # FTP/FTPS/SFTP 连接管理 + 档案 CRUD
│ │ ├── adminer.rs # Adminer 单文件下载
│ │ ├── detect.rs # 本地环境检测
│ │ ├── fs.rs # 文件系统浏览
│ │ ├── system.rs # 主机系统信息
│ │ ├── error.rs # 统一错误类型
│ │ └── db/ # 数据库管理
│ │ ├── sqlite.rs # SQLite（rusqlite bundled）
│ │ ├── remote.rs # MySQL / PostgreSQL 连接管理
│ │ ├── tunnel.rs # SSH 隧道端口转发
│ │ └── libsql.rs # libSQL（本地/远程/副本）
│ └── runphp-cli/ # 无头二进制（CLI + Web 面板）
│ └── src/
│ ├── main.rs # clap 子命令分发
│ └── panel.rs # axum Web 面板（rust_embed 嵌入前端）
├── src-tauri/ # Tauri 2 桌面壳（薄封装 core）
├── src/ # Vue 3 前端（桌面与面板共用）
│ ├── views/ # 五个页面：仪表盘/站点/数据库/FTP/设置
│ ├── components/ # 共用组件：DirectoryPicker、HostsCard
│ ├── api/ # 适配层（invoke / fetch 双模式）
│ └── stores/ # Pinia 状态管理
└── docs/ # 中文文档
├── 用户手册.md
└── 架构设计.md
```
## 📂 数据目录
| 平台 | 路径 |
|---|---|
| **Windows** | `%APPDATA%\RunPHP` |
| **Linux** | `~/.local/share/runphp` |
数据目录包含：运行时分版本目录 · 站点根目录 · 日志 · Caddyfile · 配置 JSON · SQLite 数据库。
## 📖 文档
| 文档 | 说明 |
|---|---|
| [📖 用户手册](docs/用户手册.md) | 安装、桌面端使用、无头服务器、常见问题 |
| [🏗️ 架构设计](docs/架构设计.md) | 模块职责、关键设计决策、数据流、测试策略 |
| [🤖 AGENTS.md](AGENTS.md) | Agent 工作区指令（编辑规则、环境踩坑） |
## 📜 许可证
```
DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
Version 2, December 2004
Copyright (C) 2026 RunPHP Contributors
Everyone is permitted to copy and distribute verbatim or modified
copies of this license document, and changing it is allowed as long
as the name is changed.
DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. You just DO WHAT THE FUCK YOU WANT TO.
```
详细文本见 [LICENSE](./LICENSE) 文件。