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

Diff of /lbbs/README.md

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

Revision 1.1 by sysadm, Tue May 6 10:57:39 2025 UTC Revision 1.12 by sysadm, Tue Jun 24 13:30:52 2025 UTC
# Line 1  Line 1 
1  # LBBS  # LBBS - Classical terminal server of LeafOK BBS
2    
3  Copyright (C) 2004-2025 by Leaflet  Copyright (C) 2004-2025 by Leaflet  
4    Email : leaflet@leafok.com  
5  Email : leaflet@leafok.com  Demo site : bbs.fenglin.info (Telnet 2323 / SSH2 2322)
6    
7    
8  Introduction  Introduction
9  =================  =================
10  This software (named as LBBS) aims to providing a telnet-based interface for a pure web-based BBS (named as LeafOK BBS).  This software (named as LBBS) aims to providing a telnet-based interface for a pure web-based BBS (named as LeafOK BBS).  
11    LeafOK BBS (https://github.com/leafok88/leafok_bbs) provides almost all fundamental BBS features as well as many additional plugins. Its major part was written in PHP + MySQL.  
 LeafOK BBS is a powerful BBS system, not only providing almost every function that a standard BBS should have, but also giving many features other BBS hasn't complemented yet.  
   
 As an open source project, LeafOK BBS use MySQL as its major data depository, and PHP as its developing language. With MySQL and PHP, LeafOK BBS becomes a platform-independent system. It can works stably on many popular Web Servers such as Apache and IIS.  
   
 However, as a pure web-based BBS, its shortage is inevitable. For LeafOK BBS uses Browser/Server as its architecture, it will cause more data traffic between Users and Server than telnet-based BBS, and its response is a little slower than telnet-based BBS.  
   
 In order to conquer these shortage, a new project was launched. LBBS is a telnet-based BBS which is full compatible with LeafOK BBS. It also uses MySQL as its data repository, and keep coherence with the data structure of LeafOK BBS. LBBS is designed to be a system running on Linux, with GNU C as its developing language.  
   
12  Thank you for using this software. If you meet any bugs or have any suggestion, please tell me.  Thank you for using this software. If you meet any bugs or have any suggestion, please tell me.
13    
14    
15  System Requirement  System Requirement
16  ==================  ==================
 Operation System: Linux  
   
 Software:  
17  1) GNU C Compiler  1) GNU C Compiler
18  2) PHP ( Version >= 8.2 )  2) PHP ( Version >= 8.2 )
19  3) MySQL database ( Version >= 8.4 )  3) MySQL database ( Version >= 8.4 )
# Line 34  Quick Installation Line 23  Quick Installation
23  ==================  ==================
24  To install LBBS quickly, please do the following steps:  To install LBBS quickly, please do the following steps:
25    
26  1) Extract the source files from a tarball or export from GitHub  0) Prerequisite
   
    Run the following command to set up the autoconf/automake environment,  
27    
28     sh ./autogen.sh     Follow README.md under https://github.com/leafok88/leafok_bbs to initialize the database structure shared by both web version and telnet version. It is highly recommended to finish the configuration steps of web version first and make sure those features could work properly.
29    
30    1) Extract the source files from a tarball or export from GitHub  
31       Run the following command to set up the autoconf/automake environment,  
32       sh ./autogen.sh  
33     and fix any error if exists.     and fix any error if exists.
34    
35  2) Compile source files  2) Compile source files  
36       ./configure --prefix=/usr/local/lbbs  
    ./configure --prefix=/usr/local/lbbs  
   
37     make     make
38    
39  3) Install binary files and data files  3) Create user and group  
40       sudo useradd bbs
    make install  
41    
42  4) Create user and group  4) Install binary files and data files  
43       sudo make install
44    
45     groupadd bbs  5) Modify following configuration files  
46       Default configuration files is saved as *.default, you should rename them first.  
47     useradd bbs     /usr/local/lbbs/conf/bbsd.conf  
   
 5) Set privileges of files  
   
    cd /usr/local/lbbs  
   
    chown bbs:bbs -R lbbs  
   
    chmod 750 -R lbbs  
   
    chmod 4750 lbbs/bin/bbsd  
   
 6) Modify following configuration files  
   
    Default configuration files is saved as *.default, you should rename them first.  
     
    /usr/local/lbbs/conf/bbsd.conf  
     
48     /usr/local/lbbs/utils/conf/db_conn.inc.php     /usr/local/lbbs/utils/conf/db_conn.inc.php
49    
50  7) Startup  6) Generate menu configuration file with section data by running the script  
51       sudo -u bbs php /usr/local/lbbs/utils/bin/gen_section_menu.php
52     /usr/local/lbbs/bin/bbsd     sudo -u bbs php /usr/local/lbbs/utils/bin/gen_ex_list.php
53    
54    7) Create or copy SSH2 RSA certificate into /usr/local/lbbs/conf  
55       ssh-keygen -t rsa -C "Your Server Name" -f ssh_host_rsa_key
56    
57    8) Startup  
58       sudo /usr/local/lbbs/bin/bbsd
59    
60    9) Set up systemd  
61       Create your own /usr/lib/systemd/system/lbbs.service from the sample at conf/lbbs.service.default, and make any change if necessary.  
62       Reload daemon config and start the service.  


Legend:
Removed lines/characters  
Changed lines/characters
  Added lines/characters

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