installation.md - Pixelle-Video

installation.md

1	# 安装
2
3	本页面将指导你完成 Pixelle-Video 的安装。
4
5	---
6
7	## 系统要求
8
9	### 必需条件
10
11	- Python: 3.10 或更高版本
12	- 操作系统: Windows、macOS 或 Linux
13	- 包管理器: uv（推荐）或 pip
14
15	### 可选条件
16
17	- GPU: 如需本地运行 ComfyUI，建议配备 NVIDIA 显卡（6GB+ 显存）
18	- 网络: 稳定的网络连接（用于调用 LLM API 和图像生成服务）
19
20	---
21
22	## 🪟 Windows 一键整合包（推荐 Windows 用户使用）
23
24	无需安装 Python、uv 或 ffmpeg，一键开箱即用！
25
26	### 下载和安装
27
28	1. 访问 [GitHub Releases](https://github.com/AIDC-AI/Pixelle-Video/releases/latest) 下载最新版本
29	2. 下载最新的 Windows 一键整合包并解压到任意目录
30	3. 双击运行 `start.bat` 启动 Web 界面
31	4. 浏览器会自动打开 `http://localhost:8501`
32
33	!!! success "安装完成！"
34	整合包已包含所有依赖，无需手动安装任何环境。首次使用只需在「⚙️ 系统配置」中配置 API 密钥即可开始使用。
35
36	!!! tip "下一步"
37	安装完成后，请查看 [配置说明](configuration.md) 来设置 LLM 和图像生成服务，然后查看 [快速开始](quick-start.md) 生成第一个视频。
38
39	---
40
41	## 从源码安装（适合 macOS / Linux 用户或需要自定义的用户）
42
43	### 第一步：克隆项目
44
45	```bash
46	git clone https://github.com/AIDC-AI/Pixelle-Video.git
47	cd Pixelle-Video
48	```
49
50	### 第二步：安装依赖
51
52	!!! tip "推荐使用 uv"
53	本项目使用 `uv` 作为包管理器，它比传统的 pip 更快、更可靠。
54
55	#### 使用 uv（推荐）
56
57	```bash
58	# 如果还没有安装 uv，先安装它
59	curl -LsSf https://astral.sh/uv/install.sh \| sh
60
61	# 安装项目依赖（uv 会自动创建虚拟环境）
62	uv sync
63	```
64
65	#### 使用 pip
66
67	```bash
68	# 创建虚拟环境
69	python -m venv venv
70
71	# 激活虚拟环境
72	# Windows:
73	venv\Scripts\activate
74	# macOS/Linux:
75	source venv/bin/activate
76
77	# 安装依赖
78	pip install -e .
79	```
80
81	---
82
83	## 验证安装
84
85	运行以下命令验证安装是否成功：
86
87	```bash
88	# 使用 uv
89	uv run streamlit run web/app.py
90
91	# 或使用 pip（需先激活虚拟环境）
92	streamlit run web/app.py
93	```
94
95	浏览器应该会自动打开 `http://localhost:8501`，显示 Pixelle-Video 的 Web 界面。
96
97	!!! success "安装成功！"
98	如果能看到 Web 界面，说明安装成功了！接下来请查看 [配置说明](configuration.md) 来设置服务。
99
100	---
101
102	## 可选：安装 ComfyUI（本地部署）
103
104	如果希望本地运行图像生成服务，需要安装 ComfyUI：
105
106	### 快速安装
107
108	```bash
109	# 克隆 ComfyUI
110	git clone https://github.com/comfyanonymous/ComfyUI.git
111	cd ComfyUI
112
113	# 安装依赖
114	pip install -r requirements.txt
115	```
116
117	### 启动 ComfyUI
118
119	```bash
120	python main.py
121	```
122
123	ComfyUI 默认运行在 `http://127.0.0.1:8188`
124
125	!!! info "ComfyUI 模型"
126	ComfyUI 需要下载对应的模型文件才能工作。请参考 [ComfyUI 官方文档](https://github.com/comfyanonymous/ComfyUI) 了解如何下载和配置模型。
127
128	---
129
130	## 下一步
131
132	- [配置服务](configuration.md) - 配置 LLM 和图像生成服务
133	- [快速开始](quick-start.md) - 生成第一个视频
134
135

135 lines MARKDOWN