Runtipi - 开源个人家庭服务器管理工具
项目功能：家庭服务器管理
▎项目介绍：
一个开源的个人家庭服务器管理工具，旨在简化在单一服务器上管理和运行多个服务的过程。
它基于 Docker 构建，提供了一个简单的 Web 界面，用户可以通过该界面轻松添加和管理服务，而无需手动配置或处理复杂的网络设置
它可以通过简单的命令一键安装，快速上手；
内置应用商店，提供超过 200 个流行的自托管应用，用户可以一键安装和更新。
🌟 特性
- 一键安装：快速部署自托管应用，无需手动配置。
- 多应用支持：支持多种流行的自托管应用。
- 易于管理：通过直观的界面管理所有应用。
- 自动化更新：自动保持应用和依赖项的最新状态。
- 安全可靠：内置安全措施，保护你的数据和隐私。
🚀 快速开始
前提条件
- 一台运行 Linux 的服务器（推荐 Ubuntu 20.04 或更高版本）
- Docker 和 Docker Compose 已安装
系统要求
- 操作系统: Ubuntu 22.04+/CentOS 8+ (推荐使用干净环境)
- 内存: 最低2GB，建议4GB+
- 存储: 至少20GB可用空间
- 网络: 开放80/443端口
快速安装步骤
# 获取最新代码
git clone -b develop https://github.com/runtipi/runtipi.git
cd runtipi# 执行安装脚本（自动检测环境）
sudo ./scripts/install.sh### 安装步骤1. 克隆仓库：```bashgit clone https://github.com/runtipi/runtipi.gitcd runtipi
-
启动 Tipi：
docker-compose up -d -
访问 Tipi 的 Web 界面：
http://你的服务器IP:3000
⚙️ 配置指南
🔧 配置文件
runtipi 支持通过 config.json 进行配置，文件位置一般在项目根目录。
示例配置：
{"project": {"name": "示例项目","template": "default"},"settings": {"author": "你的名字"}
}
高级配置
修改 config/runtipi.yaml 文件：
network:domain: yourdomain.com # 绑定自定义域名ssl: auto # 自动SSL证书
🧰 命令行工具
🎯 常用命令
| 命令 | 说明 |
|---|---|
runtipi create <name> --template <template> | 创建新项目 |
runtipi run | 运行项目 |
runtipi --help | 查看帮助信息 |
runtipi build | 构建项目（如果支持） |
📜 命令参数
支持多种参数，以定制操作流程。
📦 模板管理
📁 内置模板
默认提供一些基础模板，可直接使用。
✨ 自定义模板
可以在项目或本地定义模板，格式如下：
runtipi create <name> --template <路径或名称>
🔍 参数说明
create <name>：新建项目。--template <name|path>：指定模板。run：运行项目。build：构建项目。--help：显示帮助信息。
故障排查
✅ 确保Docker服务正常启动
✅ 检查防火墙规则（需开放80/443端口）
✅ 查看日志文件 /var/log/runtipi/install.log
📦 支持的应用
Tipi 支持多种自托管应用，包括但不限于：
- Nextcloud
- Jellyfin
- Bitwarden
- Home Assistant
- 更多…
应用管理接口
GET /api/v1/apps
👉 获取已安装应用列表
// 响应示例
{"data": [{"id": "nextcloud","status": "running","version": "24.0.3"}]
}
WebSocket 实时监控
const ws = new WebSocket('wss://yourserver/api/v1/ws');
ws.onmessage = (event) => {console.log('资源监控:', JSON.parse(event.data));
};
4️⃣ 安全策略（重要声明）
# 🔒 安全策略## 漏洞报告流程
1. 通过 security@runtipi.com 提交报告
2. 包含以下信息：- 受影响的版本号- 复现步骤说明- 相关日志片段## 安全更新承诺
- 重大漏洞：24小时内发布补丁
- 普通漏洞：72小时内修复
- 每月安全公告发布在官网博客
🎯 介绍
如何使用 runtipi 工具，包括基本命令和参数。
🛠 安装
# 使用 curl
curl -fsSL https://deno.land/x/runtipi/install.sh | sh# 或者使用 wget
wget -O- https://deno.land/x/runtipi/install.sh | sh
🚀 创建项目
runtipi create <项目名称> --template <模板名称>
参数
<项目名称>：新项目的目录名。--template：选择模板（默认是default）。
🖥 运行项目
runtipi run
📝 查看帮助
runtipi --help
❓ 常见问题
1. 如何安装 runtipi？
答：使用以下命令安装：
curl -fsSL https://deno.land/x/runtipi/install.sh | sh
2. 如何创建新项目？
答：运行：
runtipi create <项目名> --template <模板名>
3. 支持哪些模板？
答：当前支持默认模板，也可以自定义模板。
4. 遇到问题怎么办？
答：请提交 Issue 或在社区中寻求帮助。
5、每日资源 在这里
💯 👉【我的更新汇总】
👉项目直达
关注我的CSDN博客
更多资源可以查看我的CSDN博客