app/docs/deploy/install.md

60 lines
2.3 KiB
Markdown
Raw Normal View History

2024-03-28 11:12:55 +08:00
---
title: 安装
2024-03-31 10:59:17 +08:00
icon: download
2024-03-28 11:12:55 +08:00
order: 1
category: 使用指南
tag:
- 安装
---
2024-06-19 12:34:38 +08:00
## **开始安装**
2024-04-12 13:07:19 +08:00
2024-06-19 12:34:38 +08:00
### **常规部署**
2024-04-12 13:07:19 +08:00
1. 安装 [`Git`](https://git-scm.com/download/) 和 [`Python3.10+`](https://www.python.org/downloads/release/python-31010/) 环境
2024-06-19 12:34:38 +08:00
```bash
# 克隆项目到本地轻雪使用Git进行版本管理该步骤为必要项
2024-08-05 06:05:37 +08:00
git clone https://github.com/LiteyukiStudio/LiteyukiBot --depth=1
2024-06-19 12:34:38 +08:00
# 切换到Bot目录下
cd LiteyukiBot
# 安装依赖
pip install -r requirements.txt
# 启动Bot
python main.py
```
> [!tip]
> 推荐使用虚拟环境来运行轻雪,以避免依赖冲突,你可以使用`python -m venv .venv`来创建虚拟环境,然后使用`.venv\Scripts\activate`来激活虚拟环境Linux下使用`source .venv/bin/activate`激活)
2024-06-19 12:34:38 +08:00
### **使用Docker构建镜像部署**
2024-05-01 02:17:21 +08:00
1. 安装 [`Docker`](https://docs.docker.com/get-docker/)
2024-08-05 06:05:37 +08:00
2. 克隆项目 `git clone https://github.com/LiteyukiStudio/LiteyukiBot --depth=1`
2024-05-01 02:17:21 +08:00
3. 进入轻雪目录 `cd LiteyukiBot`
4. 构建镜像 `docker build -t liteyukibot .`
5. 启动容器 `docker run -p 20216:20216 -v $(pwd):/liteyukibot -v $(pwd)/.cache:/root/.cache liteyukibot`
2024-05-01 02:39:28 +08:00
> [!tip]
> Windows请使用项目绝对目录`/path/to/LiteyukiBot`代替`$(pwd)` <br>
> 若你修改了端口号请将`20216:20216`中的`20216`替换为你的端口号
2024-05-01 02:17:21 +08:00
2024-06-19 12:34:38 +08:00
### **使用TRSS Scripts部署**
[TRSS_Liteyuki轻雪机器人管理脚本](https://timerainstarsky.github.io/TRSS_Liteyuki/)该功能由TRSS提供支持不是LiteyukiBot官方提供的功能推荐使用`Arch Linux`
2024-04-12 13:07:19 +08:00
## **设备要求**
2024-06-19 12:34:38 +08:00
2024-03-31 10:59:17 +08:00
- Windows系统版本最低`Windows10+`/`Windows Server 2019+`
2024-04-10 23:06:55 +08:00
- Linux系统要支持Python3.10+,推荐`Ubuntu 20.04+`(~~别用你那b CentOS~~)
2024-03-31 10:59:17 +08:00
- CPU: 至少`1vCPU`
2024-07-21 00:40:55 +08:00
- 内存: Bot无其他插件会占用`300~500MB`,包括`chromium` 及 `node`等进程,其他插件占用视具体插件而定,建议`1GB`以上
2024-03-31 10:59:17 +08:00
- 硬盘: 至少`1GB`空间
2024-04-10 23:06:55 +08:00
> [!warning]
2024-04-12 13:07:19 +08:00
> 如果设备上有多个环境,请使用`path/to/python -m pip install -r requirements.txt`来安装依赖,`path/to/python`为你的Python可执行文件路径
2024-04-10 23:06:55 +08:00
> [!warning]
2024-06-19 12:34:38 +08:00
> 轻雪的更新功能依赖Git如果你没有安装Git直接下载源代码运行你将无法使用更新功能
2024-04-10 23:06:55 +08:00
2024-06-19 12:34:38 +08:00
#### 其他问题请移步至[答疑](/deployment/fandq)