| 1 |
# LeafOK BBS
|
| 2 |
|
| 3 |
Chinese version: [README.zh_CN.md](README.zh_CN.md)
|
| 4 |
|
| 5 |
## Table of Contents
|
| 6 |
- [Program Overview](#program-overview)
|
| 7 |
- [Installation and Usage Instructions](#installation-and-usage-instructions)
|
| 8 |
- [Prerequisites and Required Libraries](#1-prerequisites-and-required-libraries)
|
| 9 |
- [Database Setup](#2-database-setup)
|
| 10 |
- [Configuration](#3-configuration)
|
| 11 |
- [Site Customization](#4-site-customization)
|
| 12 |
- [Directory Permissions](#5-directory-permissions)
|
| 13 |
- [Account Creation](#6-account-creation)
|
| 14 |
- [Additional Database Setup](#7-database-setup-additional)
|
| 15 |
- [Management and Background Jobs](#8-management-and-background-jobs)
|
| 16 |
- [Docker Deployment](#docker-deployment)
|
| 17 |
- [Quick Start](#quick-start)
|
| 18 |
- [Build from Source](#build-from-source)
|
| 19 |
- [Using Pre-built Images](#using-pre-built-images)
|
| 20 |
- [Configuration for Docker](#configuration-for-docker)
|
| 21 |
- [Persistent Data](#persistent-data)
|
| 22 |
- [Copyright Information](#copyright-information)
|
| 23 |
- [License](#license)
|
| 24 |
|
| 25 |
## Program Overview
|
| 26 |
|
| 27 |
**Development Language:** PHP (8.2) + MySQL (8.4)
|
| 28 |
**Platform:** Linux / Windows
|
| 29 |
**License:** Source code released under GNU GPL license
|
| 30 |
|
| 31 |
**Features:**
|
| 32 |
- Web-based article browsing, posting, searching, and other basic functions
|
| 33 |
- Support for multiple categories and sections, each with discussion areas, digest areas, and featured areas
|
| 34 |
- Comprehensive moderator management support
|
| 35 |
- **Advanced Search Capabilities:**
|
| 36 |
- Solr-powered full-text search with Chinese language support
|
| 37 |
- **Modern Architecture:**
|
| 38 |
- Refactored Lightweight Markup Language (LML) renderer with improved performance
|
| 39 |
- User timezone support for localized date/time display
|
| 40 |
- Theme support for major features
|
| 41 |
- Optional Telnet access for login, article viewing, games, etc. (see [lbbs](https://github.com/leafok/lbbs) for details)
|
| 42 |
|
| 43 |
**Demo site:** https://fenglin.info/bbs/
|
| 44 |
|
| 45 |
## Installation and Usage Instructions
|
| 46 |
|
| 47 |
### 1. Prerequisites and Required Libraries
|
| 48 |
- **PHP 8.2+** and **MySQL 8.4+** installed
|
| 49 |
- Install Composer using your package manager (e.g., `apt`, `yum`)
|
| 50 |
- Run the following command in the project root directory:
|
| 51 |
```bash
|
| 52 |
composer install --prefer-dist --no-scripts --no-progress
|
| 53 |
```
|
| 54 |
|
| 55 |
### 2. Database Setup
|
| 56 |
- Import the database structure from `TODO/sql/db_stru.sql`
|
| 57 |
- *(Optional)* Import sample data from `TODO/sql/sample_data.sql`
|
| 58 |
- Test account: `sysop`
|
| 59 |
- Temporary password (must be changed upon first login): `3anzHaNg`
|
| 60 |
|
| 61 |
### 3. Configuration
|
| 62 |
- Copy files from `TODO/conf/` directory to `conf` directory (create if it doesn't exist)
|
| 63 |
- Modify the following files:
|
| 64 |
- Site information: Edit `conf/site.conf.php`
|
| 65 |
- Database connection: Edit `conf/db_conn.conf.php`
|
| 66 |
- Email sending: Edit `conf/smtp.conf.php` (supports both SMTP and local sendmail)
|
| 67 |
- **Solr search** (optional): Edit `conf/solr.conf.php` if using Solr for advanced search features
|
| 68 |
- Default configuration assumes Solr running on `localhost:8983` with core `lbbs`
|
| 69 |
- Update hostname, port, authentication, and path as needed
|
| 70 |
- Import schema from `TODO/solr/schema.json` into core `lbbs`
|
| 71 |
- Install pecl/solr extension with PIE
|
| 72 |
|
| 73 |
### 4. Site Customization
|
| 74 |
- Modify `lib/common.inc.php` for site-specific configurations
|
| 75 |
|
| 76 |
### 5. Directory Permissions
|
| 77 |
- Create directories (if they don't exist):
|
| 78 |
- `bbs/cache`
|
| 79 |
- `bbs/upload`
|
| 80 |
- `export_xml`
|
| 81 |
- `stat`
|
| 82 |
- Ensure the web server user has write permissions for:
|
| 83 |
- `bbs/cache`
|
| 84 |
- `bbs/upload`
|
| 85 |
- `export_xml`
|
| 86 |
- `gen_ex`
|
| 87 |
- `stat`
|
| 88 |
|
| 89 |
### 6. Account Creation
|
| 90 |
- Create administrator and initial accounts through the registration page
|
| 91 |
- *Note:* Involves multiple database tables; not recommended to create directly in the database
|
| 92 |
|
| 93 |
### 7. Database Setup (Additional)
|
| 94 |
- Add administrator accounts, categories, and sections in the database
|
| 95 |
- Relevant tables: `admin_config`, `section_class`, `section_config`
|
| 96 |
|
| 97 |
### 8. Management and Background Jobs
|
| 98 |
- Management programs are located in the `manage` directory
|
| 99 |
- Scheduled background tasks require adding to crontab
|
| 100 |
|
| 101 |
## Docker Deployment
|
| 102 |
|
| 103 |
### Quick Start
|
| 104 |
```bash
|
| 105 |
# Clone the repository
|
| 106 |
git clone https://github.com/leafok/leafok_bbs.git
|
| 107 |
cd leafok_bbs
|
| 108 |
|
| 109 |
# Start with Docker Compose
|
| 110 |
docker compose up -d
|
| 111 |
```
|
| 112 |
|
| 113 |
### Build from Source
|
| 114 |
```bash
|
| 115 |
docker compose up --build -d
|
| 116 |
```
|
| 117 |
|
| 118 |
### Using Pre-built Images
|
| 119 |
```bash
|
| 120 |
# Pull the latest images from Docker Hub
|
| 121 |
docker compose pull
|
| 122 |
|
| 123 |
# Start the containers
|
| 124 |
docker compose up -d
|
| 125 |
```
|
| 126 |
|
| 127 |
### Configuration for Docker
|
| 128 |
1. The web application will be available at `http://localhost:8080`
|
| 129 |
2. Configuration files should be placed in `conf/` directory (mounted to `/var/www/html/conf` in the container)
|
| 130 |
3. To modify configuration:
|
| 131 |
- Copy files from `TODO/conf/` to `conf/` directory
|
| 132 |
- Edit the configuration files as needed
|
| 133 |
- Restart the container: `docker compose restart`
|
| 134 |
|
| 135 |
### Persistent Data
|
| 136 |
- Database data is stored in a Docker volume (`leafok_bbs_db_data`)
|
| 137 |
- Uploaded files and cache are stored in mounted host directories
|
| 138 |
|
| 139 |
## Copyright Information
|
| 140 |
Copyright (C) 2001-2026 Leaflet <leaflet@leafok.com>
|
| 141 |
|
| 142 |
## License
|
| 143 |
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