LeafOK_CVS/fenglin/README.md

# LeafOK BBS

Chinese version: [README.zh_CN.md](README.zh_CN.md)

## Table of Contents
- [Program Overview](#program-overview)
- [Installation and Usage Instructions](#installation-and-usage-instructions)
  - [Prerequisites and Required Libraries](#1-prerequisites-and-required-libraries)
  - [Database Setup](#2-database-setup)
  - [Configuration](#3-configuration)
  - [Site Customization](#4-site-customization)
  - [Directory Permissions](#5-directory-permissions)
  - [Account Creation](#6-account-creation)
  - [Additional Database Setup](#7-database-setup-additional)
  - [Management and Background Jobs](#8-management-and-background-jobs)
- [Docker Deployment](#docker-deployment)
  - [Quick Start](#quick-start)
  - [Build from Source](#build-from-source)
  - [Using Pre-built Images](#using-pre-built-images)
  - [Configuration for Docker](#configuration-for-docker)
  - [Persistent Data](#persistent-data)
- [Copyright Information](#copyright-information)
- [License](#license)

## Program Overview

**Development Language:** PHP (8.2) + MySQL (8.4)  
**Platform:** Linux / Windows  
**License:** Source code released under GNU GPL license  

**Features:**
- Web-based article browsing, posting, searching, and other basic functions
- Support for multiple categories and sections, each with discussion areas, digest areas, and featured areas
- Comprehensive moderator management support
- **Advanced Search Capabilities:**
  - Solr-powered full-text search with Chinese language support
- **Modern Architecture:**
  - Refactored Lightweight Markup Language (LML) renderer with improved performance
  - User timezone support for localized date/time display
  - Theme support for major features
- Optional Telnet access for login, article viewing, games, etc. (see [lbbs](https://github.com/leafok/lbbs) for details)

**Demo site:** https://fenglin.info/bbs/

## Installation and Usage Instructions

### 1. Prerequisites and Required Libraries
- **PHP 8.2+** and **MySQL 8.4+** installed
- Install Composer using your package manager (e.g., `apt`, `yum`)
- Run the following command in the project root directory:
```bash
composer install --prefer-dist --no-scripts --no-progress
```

### 2. Database Setup
- Import the database structure from `TODO/sql/db_stru.sql`
- *(Optional)* Import sample data from `TODO/sql/sample_data.sql`
  - Test account: `sysop`
  - Temporary password (must be changed upon first login): `3anzHaNg`

### 3. Configuration
- Copy files from `TODO/conf/` directory to `conf` directory (create if it doesn't exist)
- Modify the following files:
  - Site information: Edit `conf/site.conf.php`
  - Database connection: Edit `conf/db_conn.conf.php`
  - Email sending: Edit `conf/smtp.conf.php` (supports both SMTP and local sendmail)
- **Solr search** (optional): Edit `conf/solr.conf.php` if using Solr for advanced search features
  - Default configuration assumes Solr running on `localhost:8983` with core `lbbs`
  - Update hostname, port, authentication, and path as needed
  - Import schema from `TODO/solr/schema.json` into core `lbbs`
  - Install pecl/solr extension with PIE

### 4. Site Customization
- Modify `lib/common.inc.php` for site-specific configurations

### 5. Directory Permissions
- Create directories (if they don't exist):
  - `bbs/cache`
  - `bbs/upload`
  - `export_xml`
  - `stat`
- Ensure the web server user has write permissions for:
  - `bbs/cache`
  - `bbs/upload`
  - `export_xml`
  - `gen_ex`
  - `stat`

### 6. Account Creation
- Create administrator and initial accounts through the registration page
- *Note:* Involves multiple database tables; not recommended to create directly in the database

### 7. Database Setup (Additional)
- Add administrator accounts, categories, and sections in the database
- Relevant tables: `admin_config`, `section_class`, `section_config`

### 8. Management and Background Jobs
- Management programs are located in the `manage` directory
- Scheduled background tasks require adding to crontab

## Docker Deployment

### Quick Start
```bash
# Clone the repository
git clone https://github.com/leafok/leafok_bbs.git
cd leafok_bbs

# Start with Docker Compose
docker compose up -d
```

### Build from Source
```bash
docker compose up --build -d
```

### Using Pre-built Images
```bash
# Pull the latest images from Docker Hub
docker compose pull

# Start the containers
docker compose up -d
```

### Configuration for Docker
1. The web application will be available at `http://localhost:8080`
2. Configuration files should be placed in `conf/` directory (mounted to `/var/www/html/conf` in the container)
3. To modify configuration:
   - Copy files from `TODO/conf/` to `conf/` directory
   - Edit the configuration files as needed
   - Restart the container: `docker compose restart`

### Persistent Data
- Database data is stored in a Docker volume (`leafok_bbs_db_data`)
- Uploaded files and cache are stored in mounted host directories

## Copyright Information
Copyright (C) 2001-2026 Leaflet <leaflet@leafok.com>

## License
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.
1	sysadm	1.1	# LeafOK BBS
2
3	sysadm	1.12	Chinese version: [README.zh_CN.md](README.zh_CN.md)
4	sysadm	1.1
5	sysadm	1.14	## 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	sysadm	1.12	## Program Overview
26	sysadm	1.1
27	sysadm	1.12	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	sysadm	1.16	- Support for multiple categories and sections, each with discussion areas, digest areas, and featured areas
34			- Comprehensive moderator management support
35	sysadm	1.15	- 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	sysadm	1.12	- 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	sysadm	1.14	### 1. Prerequisites and Required Libraries
48			- PHP 8.2+ and MySQL 8.4+ installed
49	sysadm	1.18	- Install Composer using your package manager (e.g., `apt`, `yum`)
50	sysadm	1.14	- 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	sysadm	1.12	- Import the database structure from `TODO/sql/db_stru.sql`
57	sysadm	1.14	- (Optional) Import sample data from `TODO/sql/sample_data.sql`
58	sysadm	1.12	- Test account: `sysop`
59	sysadm	1.14	- Temporary password (must be changed upon first login): `3anzHaNg`
60	sysadm	1.12
61	sysadm	1.14	### 3. Configuration
62	sysadm	1.12	- Copy files from `TODO/conf/` directory to `conf` directory (create if it doesn't exist)
63			- Modify the following files:
64	sysadm	1.13	- Site information: Edit `conf/site.conf.php`
65	sysadm	1.12	- Database connection: Edit `conf/db_conn.conf.php`
66			- Email sending: Edit `conf/smtp.conf.php` (supports both SMTP and local sendmail)
67	sysadm	1.16	- 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	sysadm	1.12
73	sysadm	1.14	### 4. Site Customization
74	sysadm	1.12	- Modify `lib/common.inc.php` for site-specific configurations
75
76	sysadm	1.14	### 5. Directory Permissions
77	sysadm	1.12	- Create directories (if they don't exist):
78			- `bbs/cache`
79			- `bbs/upload`
80	sysadm	1.17	- `export_xml`
81	sysadm	1.12	- `stat`
82			- Ensure the web server user has write permissions for:
83			- `bbs/cache`
84			- `bbs/upload`
85	sysadm	1.17	- `export_xml`
86	sysadm	1.12	- `gen_ex`
87			- `stat`
88
89	sysadm	1.14	### 6. Account Creation
90	sysadm	1.12	- 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	sysadm	1.14	### 7. Database Setup (Additional)
94	sysadm	1.12	- Add administrator accounts, categories, and sections in the database
95			- Relevant tables: `admin_config`, `section_class`, `section_config`
96
97	sysadm	1.14	### 8. Management and Background Jobs
98	sysadm	1.12	- Management programs are located in the `manage` directory
99			- Scheduled background tasks require adding to crontab
100
101	sysadm	1.14	## 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	sysadm	1.12
113			### Build from Source
114			```bash
115			docker compose up --build -d
116			```
117
118	sysadm	1.14	### Using Pre-built Images
119	sysadm	1.12	```bash
120	sysadm	1.14	# Pull the latest images from Docker Hub
121	sysadm	1.12	docker compose pull
122	sysadm	1.14
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	sysadm	1.1
139	sysadm	1.12	## Copyright Information
140	sysadm	1.16	Copyright (C) 2001-2026 Leaflet <leaflet@leafok.com>
141	sysadm	1.1
142	sysadm	1.12	## License
143	sysadm	1.15	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.
webmaster@leafok.com	ViewVC Help
Powered by ViewVC 1.3.0-beta1