136 lines
3.6 KiB
Markdown
136 lines
3.6 KiB
Markdown
# servboard
|
||
|
||
一个轻量级的服务导航仪表盘,用于管理本地Web服务。
|
||
|
||
## 功能
|
||
|
||
- **用户认证**:使用密码哈希(Werkzeug)的安全登录
|
||
- **服务卡片**:为已启用的服务提供干净、响应式的网格布局
|
||
- **智能URL生成**:支持反向代理场景,使用`X-Forwarded-Host`头
|
||
- **路径支持**:服务可以有自定义路径,实现更灵活的路由
|
||
- **SQLite数据库**:轻量级、基于文件的存储
|
||
- **Docker支持**:现成的容器化部署
|
||
- **服务管理工具**:命令行脚本,方便服务管理
|
||
|
||
## 快速开始
|
||
|
||
### 使用Docker Compose(推荐)
|
||
|
||
```bash
|
||
# 启动服务
|
||
docker-compose up -d
|
||
|
||
# 访问地址:http://your-server-ip 或 http://your-domain
|
||
# 默认凭据:admin / admin
|
||
```
|
||
|
||
### 本地运行(开发)
|
||
|
||
```bash
|
||
# 创建虚拟环境
|
||
python -m venv venv
|
||
source venv/bin/activate # Windows: venv\Scripts\activate
|
||
|
||
# 安装依赖
|
||
pip install -r requirements.txt
|
||
|
||
# 运行应用
|
||
python app.py
|
||
|
||
# 访问地址:http://localhost:5000
|
||
# 默认凭据:admin / admin
|
||
```
|
||
|
||
## 环境变量
|
||
|
||
| 变量 | 描述 | 默认值 |
|
||
|------|------|--------|
|
||
| `PORT` | 应用监听端口 | `5000` |
|
||
| `SECRET_KEY` | Flask会话密钥 | `dev-secret-key-change-in-production` |
|
||
|
||
## 配置
|
||
|
||
### 添加服务
|
||
|
||
服务可以通过命令行工具或直接向数据库插入记录来添加。
|
||
|
||
#### 使用命令行工具(推荐)
|
||
|
||
`data`目录中的`servctl.sh`脚本提供了一种简单的服务管理方式:
|
||
|
||
```bash
|
||
# 添加带路径的服务
|
||
./data/servctl.sh -a "Nextcloud" "文件同步" 8080 http "☁️" "nextcloud"
|
||
|
||
# 添加不带路径的服务
|
||
./data/servctl.sh -a "Jellyfin" "媒体服务器" 8096 http "🎬"
|
||
|
||
# 列出所有服务
|
||
./data/servctl.sh -l
|
||
|
||
# 删除服务
|
||
./data/servctl.sh -r "服务名称"
|
||
|
||
# 切换服务状态
|
||
./data/servctl.sh -t "服务名称"
|
||
```
|
||
|
||
#### 使用SQL
|
||
|
||
您也可以直接通过SQL添加服务:
|
||
|
||
```sql
|
||
-- 带路径
|
||
INSERT INTO services (name, description, port, protocol, enabled, icon, path)
|
||
VALUES ('Nextcloud', '文件同步', 8080, 'http', true, '☁️', 'nextcloud');
|
||
|
||
-- 不带路径
|
||
INSERT INTO services (name, description, port, protocol, enabled, icon)
|
||
VALUES ('Jellyfin', '媒体服务器', 8096, 'http', true, '🎬');
|
||
```
|
||
|
||
### 默认用户
|
||
|
||
首次运行时,会创建一个默认的管理员用户:
|
||
- **用户名**:`admin`
|
||
- **密码**:`admin`
|
||
|
||
**重要**:首次登录后请更改默认密码!
|
||
|
||
## 架构
|
||
|
||
```
|
||
servboard/
|
||
├── app.py # 主Flask应用,包含路由和模板
|
||
├── models.py # 数据库模型(User, Service)
|
||
├── requirements.txt # Python依赖项
|
||
├── Dockerfile # 容器配置
|
||
├── docker-compose.yml # Docker Compose配置
|
||
├── data/ # SQLite数据库和服务管理工具
|
||
│ ├── dashboard.db # SQLite数据库
|
||
│ ├── icons/ # 服务图标
|
||
│ └── servctl.sh # 服务管理脚本
|
||
├── static/ # 静态资源(CSS, JS, 图片)
|
||
└── templates/ # HTML模板
|
||
```
|
||
|
||
## Docker支持
|
||
|
||
Servboard提供Docker支持,便于部署。提供的`Dockerfile`和`docker-compose.yml`文件使在容器化环境中运行Servboard变得简单。
|
||
|
||
### 自动文件创建
|
||
|
||
运行容器时,如果映射的`data`目录不包含:
|
||
- `dashboard.db`:会自动创建默认数据库
|
||
- `servctl.sh`:会自动复制服务管理脚本
|
||
|
||
## 安全
|
||
|
||
- 密码使用`werkzeug.security.generate_password_hash`进行哈希处理
|
||
- 容器以非root用户(`appuser`)运行
|
||
- 会话使用Flask的安全cookie-based认证
|
||
- HTTPS终止由反向代理处理(Flask仅运行HTTP)
|
||
|
||
## 许可证
|
||
|
||
MIT |