| 1 |
# LeafOK BBS
|
| 2 |
|
| 3 |
Chinese version: [README.zh_CN.md](README.zh_CN.md)
|
| 4 |
|
| 5 |
## Program Overview
|
| 6 |
|
| 7 |
**Development Language:** PHP (8.2) + MySQL (8.4)
|
| 8 |
**Platform:** Linux / Windows
|
| 9 |
**License:** Source code released under GNU GPL license
|
| 10 |
|
| 11 |
**Features:**
|
| 12 |
- Web-based article browsing, posting, searching, and other basic functions
|
| 13 |
- Support for multiple categories and sections, each with discussion areas, digest areas, and featured areas
|
| 14 |
- 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 |
## Installation and Usage Instructions
|
| 20 |
|
| 21 |
### 1. Database Setup
|
| 22 |
- Import the database structure from `TODO/sql/db_stru.sql`
|
| 23 |
- *(Optional)* Import test data from `TODO/sql/sample_data.sql`
|
| 24 |
- Test account: `sysop`
|
| 25 |
- Temporary password (must be changed upon login): `3anzHaNg`
|
| 26 |
|
| 27 |
### 2. Configuration
|
| 28 |
- Copy files from `TODO/conf/` directory to `conf` directory (create if it doesn't exist)
|
| 29 |
- Modify the following files:
|
| 30 |
- Database connection: Edit `conf/db_conn.conf.php`
|
| 31 |
- Email sending: Edit `conf/smtp.conf.php` (supports both SMTP and local sendmail)
|
| 32 |
|
| 33 |
### 3. Site Customization
|
| 34 |
- Modify `lib/common.inc.php` for site-specific configurations
|
| 35 |
|
| 36 |
### 4. Directory Permissions
|
| 37 |
- Create directories (if they don't exist):
|
| 38 |
- `bbs/cache`
|
| 39 |
- `bbs/upload`
|
| 40 |
- `stat`
|
| 41 |
- Ensure the web server user has write permissions for:
|
| 42 |
- `bbs/cache`
|
| 43 |
- `bbs/upload`
|
| 44 |
- `gen_ex`
|
| 45 |
- `stat`
|
| 46 |
|
| 47 |
### 5. Account Creation
|
| 48 |
- Create administrator and initial accounts through the registration page
|
| 49 |
- *Note:* Involves multiple database tables; not recommended to create directly in the database
|
| 50 |
|
| 51 |
### 6. Database Setup (Additional)
|
| 52 |
- Add administrator accounts, categories, and sections in the database
|
| 53 |
- Relevant tables: `admin_config`, `section_class`, `section_config`
|
| 54 |
|
| 55 |
### 7. Management and Background Jobs
|
| 56 |
- Management programs are located in the `manage` directory
|
| 57 |
- Scheduled background tasks require adding to crontab
|
| 58 |
|
| 59 |
## Docker Users
|
| 60 |
|
| 61 |
### Build from Source
|
| 62 |
```bash
|
| 63 |
docker compose up --build -d
|
| 64 |
```
|
| 65 |
|
| 66 |
### Download from Docker Hub
|
| 67 |
```bash
|
| 68 |
docker compose pull
|
| 69 |
```
|
| 70 |
|
| 71 |
### Configuration
|
| 72 |
Modify or import configuration files in the container's `/var/www/html/conf` directory.
|
| 73 |
|
| 74 |
## Copyright Information
|
| 75 |
Copyright (C) 2004-2026 Leaflet <leaflet@leafok.com>
|
| 76 |
|
| 77 |
## License
|
| 78 |
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