| 1 |
# LeafOK BBS
|
| 2 |
|
| 3 |
英文版本: [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)
|
| 30 |
**运行平台：** Linux / Windows
|
| 31 |
**授权许可：** 源代码采用 GNU GPL 授权发布
|
| 32 |
|
| 33 |
**功能说明：**
|
| 34 |
- 基于Web的文章浏览、发表、查找等基本功能和其它各种实用功能
|
| 35 |
- 支持多类别多版块，各版块分设讨论区、文摘区、精华区
|
| 36 |
- 提供全面的版主管理支持
|
| 37 |
- **高级搜索功能：**
|
| 38 |
- 支持中文的Solr全文搜索
|
| 39 |
- **现代架构：**
|
| 40 |
- 重构的轻量级标记语言（LML）渲染器，性能更优
|
| 41 |
- 支持用户时区，本地化日期/时间显示
|
| 42 |
- 主要功能支持主题定制
|
| 43 |
- 可选Telnet方式的登陆访问、文章查看、游戏等功能（详见[lbbs](https://github.com/leafok/lbbs)）
|
| 44 |
|
| 45 |
**演示站点：** https://fenglin.info/bbs/
|
| 46 |
|
| 47 |
## 安装和使用说明
|
| 48 |
|
| 49 |
### 1. 前置条件和所需库
|
| 50 |
- **PHP 8.2+** 和 **MySQL 8.4+** 已安装
|
| 51 |
- 使用包管理器安装 Composer（例如 `apt`、`yum`，或从 [getcomposer.org](https://getcomposer.org/) 下载）
|
| 52 |
- 在项目根目录运行以下命令：
|
| 53 |
```bash
|
| 54 |
composer install --prefer-dist --no-scripts --no-progress
|
| 55 |
```
|
| 56 |
|
| 57 |
### 2. 数据库设置
|
| 58 |
- 导入数据库结构文件 `TODO/sql/db_stru.sql`
|
| 59 |
- *(可选)* 导入测试数据 `TODO/sql/sample_data.sql`
|
| 60 |
- 测试账户：`sysop`
|
| 61 |
- 临时密码（首次登陆时需修改）：`3anzHaNg`
|
| 62 |
|
| 63 |
### 3. 配置文件
|
| 64 |
- 将 `TODO/conf/` 目录下的文件复制到 `conf` 目录下（如不存在）
|
| 65 |
- 修改以下文件：
|
| 66 |
- 站点信息：编辑 `conf/site.conf.php`
|
| 67 |
- 数据库连接：编辑 `conf/db_conn.conf.php`
|
| 68 |
- 邮件发送：编辑 `conf/smtp.conf.php`（支持SMTP和本地sendmail两种方式）
|
| 69 |
- **Solr搜索**（可选）：如需使用Solr进行高级搜索，编辑 `conf/solr.conf.php`
|
| 70 |
- 默认配置假设Solr运行在 `localhost:8983`，核心为 `lbbs`
|
| 71 |
- 根据需要更新主机名、端口、认证信息和路径
|
| 72 |
- 将 `TODO/solr/schema.json` 中的架构导入到核心 `lbbs`
|
| 73 |
- 使用PHP扩展安装工具PIE安装pecl/solr扩展
|
| 74 |
|
| 75 |
### 4. 站点个性化配置
|
| 76 |
- 修改 `lib/common.inc.php` 文件
|
| 77 |
|
| 78 |
### 5. 目录权限
|
| 79 |
- 创建目录（如果不存在）：
|
| 80 |
- `bbs/cache`
|
| 81 |
- `bbs/upload`
|
| 82 |
- `stat`
|
| 83 |
- 确保Web服务器运行账户对以下目录有写权限：
|
| 84 |
- `bbs/cache`
|
| 85 |
- `bbs/upload`
|
| 86 |
- `gen_ex`
|
| 87 |
- `stat`
|
| 88 |
|
| 89 |
### 6. 账户创建
|
| 90 |
- 通过注册页面创建管理员账号等初始账号
|
| 91 |
- *注意：* 涉及多张数据表，不建议直接在数据库中创建
|
| 92 |
|
| 93 |
### 7. 数据库设置（附加）
|
| 94 |
- 在数据库中添加管理员帐号、栏目、版块等
|
| 95 |
- 相关数据表：`admin_config`、`section_class`、`section_config`
|
| 96 |
|
| 97 |
### 8. 管理和后台作业
|
| 98 |
- 管理程序位于 `manage` 目录下
|
| 99 |
- 定时后台作业需要自行添加crontab
|
| 100 |
|
| 101 |
## Docker部署
|
| 102 |
|
| 103 |
### 快速开始
|
| 104 |
```bash
|
| 105 |
# 克隆仓库
|
| 106 |
git clone https://github.com/leafok/leafok_bbs.git
|
| 107 |
cd leafok_bbs
|
| 108 |
|
| 109 |
# 使用 Docker Compose 启动
|
| 110 |
docker compose up -d
|
| 111 |
```
|
| 112 |
|
| 113 |
### 从源代码构建
|
| 114 |
```bash
|
| 115 |
docker compose up --build -d
|
| 116 |
```
|
| 117 |
|
| 118 |
### 使用预构建镜像
|
| 119 |
```bash
|
| 120 |
# 从 Docker Hub 拉取最新镜像
|
| 121 |
docker compose pull
|
| 122 |
|
| 123 |
# 启动容器
|
| 124 |
docker compose up -d
|
| 125 |
```
|
| 126 |
|
| 127 |
### Docker配置
|
| 128 |
1. Web 应用将在 `http://localhost:8080` 可用
|
| 129 |
2. 配置文件应放置在 `conf/` 目录（在容器中挂载到 `/var/www/html/conf`）
|
| 130 |
3. 修改配置：
|
| 131 |
- 将文件从 `TODO/conf/` 复制到 `conf/` 目录
|
| 132 |
- 根据需要编辑配置文件
|
| 133 |
- 重启容器：`docker compose restart`
|
| 134 |
|
| 135 |
### Docker Compose服务
|
| 136 |
- **web**: Apache HTTP 服务器与 PHP 8.2
|
| 137 |
- **db**: MySQL 8.4 数据库
|
| 138 |
- **phpmyadmin**: 数据库管理界面（可选，在 `http://localhost:8081` 可用）
|
| 139 |
|
| 140 |
### 常用Docker命令
|
| 141 |
```bash
|
| 142 |
# 查看日志
|
| 143 |
docker compose logs -f
|
| 144 |
|
| 145 |
# 停止容器
|
| 146 |
docker compose down
|
| 147 |
|
| 148 |
# 重新构建并重启
|
| 149 |
docker compose up --build -d
|
| 150 |
|
| 151 |
# 进入容器 shell
|
| 152 |
docker compose exec web bash
|
| 153 |
```
|
| 154 |
|
| 155 |
### 持久化数据
|
| 156 |
- 数据库数据存储在 Docker 卷中（`leafok_bbs_db_data`）
|
| 157 |
- 上传的文件和缓存存储在挂载的主机目录中
|
| 158 |
|
| 159 |
## 版权信息
|
| 160 |
版权所有 (C) 2001-2026 Leaflet <leaflet@leafok.com>
|
| 161 |
|
| 162 |
## 授权许可
|
| 163 |
本程序是自由软件；您可以按照自由软件基金会发布的[GNU通用发布许可](LICENSE)的第三版或后续版本的条款，分发和/或修改本程序。
|
Parent Directory
| 
Revision Log