| 2 |
|
|
| 3 |
英文版本: [README.md](README.md) |
英文版本: [README.md](README.md) |
| 4 |
|
|
| 5 |
|
## 目录 |
| 6 |
|
- [程序简介](#程序简介) |
| 7 |
|
- [安装和使用说明](#安装和使用说明) |
| 8 |
|
- [前置条件和所需库](#1-前置条件和所需库) |
| 9 |
|
- [数据库设置](#2-数据库设置) |
| 10 |
|
- [配置文件](#3-配置文件) |
| 11 |
|
- [站点个性化配置](#4-站点个性化配置) |
| 12 |
|
- [目录权限](#5-目录权限) |
| 13 |
|
- [账户创建](#6-账户创建) |
| 14 |
|
- [附加数据库设置](#7-数据库设置附加) |
| 15 |
|
- [管理和后台作业](#8-管理和后台作业) |
| 16 |
|
- [Docker部署](#docker部署) |
| 17 |
|
- [快速开始](#快速开始) |
| 18 |
|
- [从源代码构建](#从源代码构建) |
| 19 |
|
- [使用预构建镜像](#使用预构建镜像) |
| 20 |
|
- [Docker配置](#docker配置) |
| 21 |
|
- [Docker Compose服务](#docker-compose服务) |
| 22 |
|
- [常用Docker命令](#常用docker命令) |
| 23 |
|
- [持久化数据](#持久化数据) |
| 24 |
|
- [版权信息](#版权信息) |
| 25 |
|
- [授权许可](#授权许可) |
| 26 |
|
|
| 27 |
## 程序简介 |
## 程序简介 |
| 28 |
|
|
| 29 |
**开发语言:** PHP (8.2) + MySQL (8.4) |
**开发语言:** PHP (8.2) + MySQL (8.4) |
| 40 |
|
|
| 41 |
## 安装和使用说明 |
## 安装和使用说明 |
| 42 |
|
|
| 43 |
### 1. 数据库设置 |
### 1. 前置条件和所需库 |
| 44 |
|
- **PHP 8.2+** 和 **MySQL 8.4+** 已安装 |
| 45 |
|
- 使用包管理器安装 Composer(例如 `apt`、`yum`,或从 [getcomposer.org](https://getcomposer.org/) 下载) |
| 46 |
|
- 在项目根目录运行以下命令: |
| 47 |
|
```bash |
| 48 |
|
composer install --prefer-dist --no-scripts --no-progress |
| 49 |
|
``` |
| 50 |
|
|
| 51 |
|
### 2. 数据库设置 |
| 52 |
- 导入数据库结构文件 `TODO/sql/db_stru.sql` |
- 导入数据库结构文件 `TODO/sql/db_stru.sql` |
| 53 |
- *(可选)* 导入测试数据 `TODO/sql/sample_data.sql` |
- *(可选)* 导入测试数据 `TODO/sql/sample_data.sql` |
| 54 |
- 测试账户:`sysop` |
- 测试账户:`sysop` |
| 55 |
- 临时密码(登陆时需修改):`3anzHaNg` |
- 临时密码(首次登陆时需修改):`3anzHaNg` |
| 56 |
|
|
| 57 |
### 2. 配置文件 |
### 3. 配置文件 |
| 58 |
- 将 `TODO/conf/` 目录下的文件复制到 `conf` 目录下(如不存在) |
- 将 `TODO/conf/` 目录下的文件复制到 `conf` 目录下(如不存在) |
| 59 |
- 修改以下文件: |
- 修改以下文件: |
| 60 |
- 站点信息:编辑 `conf/site.conf.php` |
- 站点信息:编辑 `conf/site.conf.php` |
| 61 |
- 数据库连接:编辑 `conf/db_conn.conf.php` |
- 数据库连接:编辑 `conf/db_conn.conf.php` |
| 62 |
- 邮件发送:编辑 `conf/smtp.conf.php`(支持SMTP和本地sendmail两种方式) |
- 邮件发送:编辑 `conf/smtp.conf.php`(支持SMTP和本地sendmail两种方式) |
| 63 |
|
|
| 64 |
### 3. 站点个性化配置 |
### 4. 站点个性化配置 |
| 65 |
- 修改 `lib/common.inc.php` 文件 |
- 修改 `lib/common.inc.php` 文件 |
| 66 |
|
|
| 67 |
### 4. 目录权限 |
### 5. 目录权限 |
| 68 |
- 创建目录(如果不存在): |
- 创建目录(如果不存在): |
| 69 |
- `bbs/cache` |
- `bbs/cache` |
| 70 |
- `bbs/upload` |
- `bbs/upload` |
| 75 |
- `gen_ex` |
- `gen_ex` |
| 76 |
- `stat` |
- `stat` |
| 77 |
|
|
| 78 |
### 5. 账户创建 |
### 6. 账户创建 |
| 79 |
- 通过注册页面创建管理员账号等初始账号 |
- 通过注册页面创建管理员账号等初始账号 |
| 80 |
- *注意:* 涉及多张数据表,不建议直接在数据库中创建 |
- *注意:* 涉及多张数据表,不建议直接在数据库中创建 |
| 81 |
|
|
| 82 |
### 6. 数据库设置(附加) |
### 7. 数据库设置(附加) |
| 83 |
- 在数据库中添加管理员帐号、栏目、版块等 |
- 在数据库中添加管理员帐号、栏目、版块等 |
| 84 |
- 相关数据表:`admin_config`、`section_class`、`section_config` |
- 相关数据表:`admin_config`、`section_class`、`section_config` |
| 85 |
|
|
| 86 |
### 7. 管理和后台作业 |
### 8. 管理和后台作业 |
| 87 |
- 管理程序位于 `manage` 目录下 |
- 管理程序位于 `manage` 目录下 |
| 88 |
- 定时后台作业需要自行添加crontab |
- 定时后台作业需要自行添加crontab |
| 89 |
|
|
| 90 |
## Docker用户 |
## Docker部署 |
| 91 |
|
|
| 92 |
|
### 快速开始 |
| 93 |
|
```bash |
| 94 |
|
# 克隆仓库 |
| 95 |
|
git clone https://github.com/leafok/leafok_bbs.git |
| 96 |
|
cd leafok_bbs |
| 97 |
|
|
| 98 |
|
# 使用 Docker Compose 启动 |
| 99 |
|
docker compose up -d |
| 100 |
|
``` |
| 101 |
|
|
| 102 |
### 从源代码构建 |
### 从源代码构建 |
| 103 |
```bash |
```bash |
| 104 |
docker compose up --build -d |
docker compose up --build -d |
| 105 |
``` |
``` |
| 106 |
|
|
| 107 |
### 从Docker Hub下载 |
### 使用预构建镜像 |
| 108 |
```bash |
```bash |
| 109 |
|
# 从 Docker Hub 拉取最新镜像 |
| 110 |
docker compose pull |
docker compose pull |
| 111 |
|
|
| 112 |
|
# 启动容器 |
| 113 |
|
docker compose up -d |
| 114 |
|
``` |
| 115 |
|
|
| 116 |
|
### Docker配置 |
| 117 |
|
1. Web 应用将在 `http://localhost:8080` 可用 |
| 118 |
|
2. 配置文件应放置在 `conf/` 目录(在容器中挂载到 `/var/www/html/conf`) |
| 119 |
|
3. 修改配置: |
| 120 |
|
- 将文件从 `TODO/conf/` 复制到 `conf/` 目录 |
| 121 |
|
- 根据需要编辑配置文件 |
| 122 |
|
- 重启容器:`docker compose restart` |
| 123 |
|
|
| 124 |
|
### Docker Compose服务 |
| 125 |
|
- **web**: Apache HTTP 服务器与 PHP 8.2 |
| 126 |
|
- **db**: MySQL 8.4 数据库 |
| 127 |
|
- **phpmyadmin**: 数据库管理界面(可选,在 `http://localhost:8081` 可用) |
| 128 |
|
|
| 129 |
|
### 常用Docker命令 |
| 130 |
|
```bash |
| 131 |
|
# 查看日志 |
| 132 |
|
docker compose logs -f |
| 133 |
|
|
| 134 |
|
# 停止容器 |
| 135 |
|
docker compose down |
| 136 |
|
|
| 137 |
|
# 重新构建并重启 |
| 138 |
|
docker compose up --build -d |
| 139 |
|
|
| 140 |
|
# 进入容器 shell |
| 141 |
|
docker compose exec web bash |
| 142 |
``` |
``` |
| 143 |
|
|
| 144 |
### 配置 |
### 持久化数据 |
| 145 |
在容器的 `/var/www/html/conf` 目录下,修改或导入配置文件。 |
- 数据库数据存储在 Docker 卷中(`leafok_bbs_db_data`) |
| 146 |
|
- 上传的文件和缓存存储在挂载的主机目录中 |
| 147 |
|
|
| 148 |
## 版权信息 |
## 版权信息 |
| 149 |
版权所有 (C) 2004-2026 Leaflet <leaflet@leafok.com> |
版权所有 (C) 2004-2026 Leaflet <leaflet@leafok.com> |