/[LeafOK_CVS]/fenglin/README.zh_CN.md
ViewVC logotype

Diff of /fenglin/README.zh_CN.md

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

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

Legend:
Removed lines/characters  
Changed lines/characters
  Added lines/characters
webmaster@leafok.com
 ViewVC Help
Powered by ViewVC 1.3.0-beta1