| 1 |
# LeafOK BBS |
# LeafOK BBS |
| 2 |
|
|
| 3 |
Copyright (C) LeafOK.com, 2001-2025 |
Chinese version: [README.zh_CN.md](README.zh_CN.md) |
| 4 |
|
|
| 5 |
演示站点位于：https://www.fenglin.info/bbs/ |
## Program Overview |
| 6 |
|
|
| 7 |
程序简介 |
**Development Language:** PHP (8.2) + MySQL (8.4) |
| 8 |
================= |
**Platform:** Linux / Windows |
| 9 |
开发语言：PHP (8.2) + MySQL (8.4) |
**License:** Source code released under GNU GPL license |
| 10 |
运行平台：Linux / Windows |
|
| 11 |
软件性质：源代码采用 GNU GPL 授权发布 |
**Features:** |
| 12 |
功能说明： |
- Web-based article browsing, posting, searching, and other basic functions |
| 13 |
基于Web的文章浏览、发表、查找等基本功能和其它各种实用功能，可开设多类别多版块，各版块分设讨论区、文摘区、精华区，并提供全面的版主管理支持。 |
- Support for multiple categories and sections, each with discussion areas, digest areas, and featured areas |
| 14 |
Telnet方式的登陆访问、文章查看、游戏等功能（可选，详见https://github.com/leafok88/lbbs） |
- Comprehensive moderator management support |
| 15 |
|
- Optional Telnet access for login, article viewing, games, etc. (see [lbbs](https://github.com/leafok/lbbs) for details) |
| 16 |
|
|
| 17 |
使用说明： |
**Demo site:** https://fenglin.info/bbs/ |
| 18 |
================= |
|
| 19 |
数据库结构位于 TODO/sql/db_stru.sql ，需先导入 |
## Installation and Usage Instructions |
| 20 |
将 TODO/conf/ 目录下的文件复制到 conf 目录下，并修改 |
|
| 21 |
修改 lib/common.inc.php 文件（站点个性化配置） |
### 1. Database Setup |
| 22 |
通过注册页面创建管理员账号等初始账号（涉及多张数据表，不建议直接在数据库中创建） |
- Import the database structure from `TODO/sql/db_stru.sql` |
| 23 |
在数据库中添加管理员帐号、栏目、版块等（分别位于admin_config、section_class、section_config表） |
- *(Optional)* Import test data from `TODO/sql/sample_data.sql` |
| 24 |
BBS程序位于 bbs 目录下 |
- Test account: `sysop` |
| 25 |
管理程序和定时后台作业（需要自行添加crontab）位于 manage 目录下 |
- Temporary password (must be changed upon login): `3anzHaNg` |
| 26 |
生成的精华区位于 gen_ex 目录下 |
|
| 27 |
|
### 2. Configuration |
| 28 |
|
- Copy files from `TODO/conf/` directory to `conf` directory (create if it doesn't exist) |
| 29 |
报告Bug/参与改进： |
- Modify the following files: |
| 30 |
================= |
- Site information: Edit `conf/site.conf.php` |
| 31 |
由于本程序源代码采用 GNU GPL 授权发布，如果您发现任何错误或者愿意加入本BBS的开发，请与我们联系。 |
- Database connection: Edit `conf/db_conn.conf.php` |
| 32 |
E-mail: leaflet@leafok.com |
- Email sending: Edit `conf/smtp.conf.php` (supports both SMTP and local sendmail) |
| 33 |
|
|
| 34 |
|
### 3. Site Customization |
| 35 |
|
- Modify `lib/common.inc.php` for site-specific configurations |
| 36 |
|
|
| 37 |
|
### 4. Directory Permissions |
| 38 |
|
- Create directories (if they don't exist): |
| 39 |
|
- `bbs/cache` |
| 40 |
|
- `bbs/upload` |
| 41 |
|
- `stat` |
| 42 |
|
- Ensure the web server user has write permissions for: |
| 43 |
|
- `bbs/cache` |
| 44 |
|
- `bbs/upload` |
| 45 |
|
- `gen_ex` |
| 46 |
|
- `stat` |
| 47 |
|
|
| 48 |
|
### 5. Account Creation |
| 49 |
|
- Create administrator and initial accounts through the registration page |
| 50 |
|
- *Note:* Involves multiple database tables; not recommended to create directly in the database |
| 51 |
|
|
| 52 |
|
### 6. Database Setup (Additional) |
| 53 |
|
- Add administrator accounts, categories, and sections in the database |
| 54 |
|
- Relevant tables: `admin_config`, `section_class`, `section_config` |
| 55 |
|
|
| 56 |
|
### 7. Management and Background Jobs |
| 57 |
|
- Management programs are located in the `manage` directory |
| 58 |
|
- Scheduled background tasks require adding to crontab |
| 59 |
|
|
| 60 |
|
## Docker Users |
| 61 |
|
|
| 62 |
|
### Build from Source |
| 63 |
|
```bash |
| 64 |
|
docker compose up --build -d |
| 65 |
|
``` |
| 66 |
|
|
| 67 |
|
### Download from Docker Hub |
| 68 |
|
```bash |
| 69 |
|
docker compose pull |
| 70 |
|
``` |
| 71 |
|
|
| 72 |
|
### Configuration |
| 73 |
|
Modify or import configuration files in the container's `/var/www/html/conf` directory. |
| 74 |
|
|
| 75 |
|
## Copyright Information |
| 76 |
|
Copyright (C) 2004-2026 Leaflet <leaflet@leafok.com> |
| 77 |
|
|
| 78 |
|
## License |
| 79 |
|
This program is free software; you can redistribute it and/or modify it under the terms of the [GNU General Public License](LICENSE) as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. |
Parent Directory
| 
Revision Log
| 
Patch