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

Annotation of /fenglin/README.md

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.13 - (hide annotations)
Thu Jan 8 12:12:00 2026 UTC (2 months, 1 week ago) by sysadm
Branch: MAIN
Changes since 1.12: +1 -0 lines
Content type: text/markdown
Allow customize site information in conf/site.conf.php

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.12 ## Program Overview
6 sysadm 1.1
7 sysadm 1.12 **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 sysadm 1.13 - Site information: Edit `conf/site.conf.php`
31 sysadm 1.12 - Database connection: Edit `conf/db_conn.conf.php`
32     - 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 sysadm 1.1
72 sysadm 1.12 ### Configuration
73     Modify or import configuration files in the container's `/var/www/html/conf` directory.
74 sysadm 1.1
75 sysadm 1.12 ## Copyright Information
76     Copyright (C) 2004-2026 Leaflet <leaflet@leafok.com>
77 sysadm 1.1
78 sysadm 1.12 ## 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.

webmaster@leafok.com
ViewVC Help
Powered by ViewVC 1.3.0-beta1