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

Diff of /fenglin/README.md

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

Revision 1.4 by sysadm, Sun Jun 22 12:20:24 2025 UTC Revision 1.14 by sysadm, Sat Jan 10 06:48:17 2026 UTC
# Line 1  Line 1 
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/  ## 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      - [Docker Compose Services](#docker-compose-services)
22      - [Common Docker Commands](#common-docker-commands)
23      - [Persistent Data](#persistent-data)
24    - [Copyright Information](#copyright-information)
25    - [License](#license)
26    
27    ## Program Overview
28    
29    **Development Language:** PHP (8.2) + MySQL (8.4)  
30    **Platform:** Linux / Windows  
31    **License:** Source code released under GNU GPL license  
32    
33    **Features:**
34    - Web-based article browsing, posting, searching, and other basic functions
35    - Support for multiple categories and sections, each with discussion areas, digest areas, and featured areas
36    - Comprehensive moderator management support
37    - Optional Telnet access for login, article viewing, games, etc. (see [lbbs](https://github.com/leafok/lbbs) for details)
38    
39    **Demo site:** https://fenglin.info/bbs/
40    
41    ## Installation and Usage Instructions
42    
43    ### 1. Prerequisites and Required Libraries
44    - **PHP 8.2+** and **MySQL 8.4+** installed
45    - Install Composer using your package manager (e.g., `apt`, `yum`, or from [getcomposer.org](https://getcomposer.org/))
46    - Run the following command in the project root directory:
47    ```bash
48    composer install --prefer-dist --no-scripts --no-progress
49    ```
50    
51    ### 2. Database Setup
52    - Import the database structure from `TODO/sql/db_stru.sql`
53    - *(Optional)* Import sample data from `TODO/sql/sample_data.sql`
54      - Test account: `sysop`
55      - Temporary password (must be changed upon first login): `3anzHaNg`
56    
57    ### 3. Configuration
58    - Copy files from `TODO/conf/` directory to `conf` directory (create if it doesn't exist)
59    - Modify the following files:
60      - Site information: Edit `conf/site.conf.php`
61      - Database connection: Edit `conf/db_conn.conf.php`
62      - Email sending: Edit `conf/smtp.conf.php` (supports both SMTP and local sendmail)
63    
64    ### 4. Site Customization
65    - Modify `lib/common.inc.php` for site-specific configurations
66    
67    ### 5. Directory Permissions
68    - Create directories (if they don't exist):
69      - `bbs/cache`
70      - `bbs/upload`
71      - `stat`
72    - Ensure the web server user has write permissions for:
73      - `bbs/cache`
74      - `bbs/upload`
75      - `gen_ex`
76      - `stat`
77    
78    ### 6. Account Creation
79    - Create administrator and initial accounts through the registration page
80    - *Note:* Involves multiple database tables; not recommended to create directly in the database
81    
82    ### 7. Database Setup (Additional)
83    - Add administrator accounts, categories, and sections in the database
84    - Relevant tables: `admin_config`, `section_class`, `section_config`
85    
86    ### 8. Management and Background Jobs
87    - Management programs are located in the `manage` directory
88    - Scheduled background tasks require adding to crontab
89    
90    ## Docker Deployment
91    
92    ### Quick Start
93    ```bash
94    # Clone the repository
95    git clone https://github.com/leafok/leafok_bbs.git
96    cd leafok_bbs
97    
98    # Start with Docker Compose
99    docker compose up -d
100    ```
101    
102    ### Build from Source
103    ```bash
104    docker compose up --build -d
105    ```
106    
107    ### Using Pre-built Images
108    ```bash
109    # Pull the latest images from Docker Hub
110    docker compose pull
111    
112    # Start the containers
113    docker compose up -d
114    ```
115    
116    ### Configuration for Docker
117    1. The web application will be available at `http://localhost:8080`
118    2. Configuration files should be placed in `conf/` directory (mounted to `/var/www/html/conf` in the container)
119    3. To modify configuration:
120       - Copy files from `TODO/conf/` to `conf/` directory
121       - Edit the configuration files as needed
122       - Restart the container: `docker compose restart`
123    
124    ### Docker Compose Services
125    - **web**: Apache HTTP Server with PHP 8.2
126    - **db**: MySQL 8.4 database
127    - **phpmyadmin**: Database management interface (optional, available at `http://localhost:8081`)
128    
129    ### Common Docker Commands
130    ```bash
131    # View logs
132    docker compose logs -f
133    
134    # Stop containers
135    docker compose down
136    
137    # Rebuild and restart
138    docker compose up --build -d
139    
140    # Access container shell
141    docker compose exec web bash
142    ```
143    
144    ### Persistent Data
145    - Database data is stored in a Docker volume (`leafok_bbs_db_data`)
146    - Uploaded files and cache are stored in mounted host directories
147    
148  程序简介  ## Copyright Information
149  =================  Copyright (C) 2004-2026 Leaflet <leaflet@leafok.com>
150  开发语言：PHP (8.2) + MySQL (8.4)    
151  运行平台：Linux / Windows    ## License
152  软件性质：源代码采用 GNU GPL 授权发布    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.
 功能说明：    
     基于Web的文章浏览、发表、查找等基本功能和其它各种实用功能，可开设多类别多版块，各版块分设讨论区、文摘区、精华区，并提供全面的版主管理支持。  
     Telnet方式的登陆访问、文章查看、游戏等功能（可选，详见https://github.com/leafok88/lbbs）  
   
   
 使用说明：  
 =================  
 数据库结构位于 TODO/sql/db_stru.sql ，需先导入    
 将 TODO/conf/ 目录下的文件复制到 conf 目录下，并修改    
 修改 lib/common.inc.php 文件（站点个性化配置）    
 通过注册页面创建管理员账号等初始账号（涉及多张数据表，不建议直接在数据库中创建）    
 在数据库中添加管理员帐号、栏目、版块等（分别位于admin_config、section_class、section_config表）    
 BBS程序位于 bbs 目录下    
 管理程序和定时后台作业（需要自行添加crontab）位于 manage 目录下    
 生成的精华区位于 gen_ex 目录下    
   
   
 报告Bug/参与改进：  
 =================  
 由于本程序源代码采用 GNU GPL 授权发布，如果您发现任何错误或者愿意加入本BBS的开发，请与我们联系。    
 E-mail: leaflet@leafok.com    

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