/[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.7 by sysadm, Sat May 31 14:39:06 2025 UTC Revision 1.16 by sysadm, Wed Jul 9 14:03:27 2025 UTC
# Line 1  Line 1 
1  # LBBS - Classical terminal server of LeafOK BBS  # 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 aims to providing a telnet-based interface for a pure web-based BBS [leafok_bbs](https://github.com/leafok88/leafok_bbs).  
11    ![Welcome](misc/images/ssh_welcome.jpg "Welcome to LBBS")  
12  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.  ![Menu](misc/images/telnet_menu.jpg "Main menu")  
13    ![Section](misc/images/telnet_section.jpg "List of articles")  
14  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.  ![Reader](misc/images/telnet_article_reader.jpg "Article reader")  
   
 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.  
   
 Thank you for using this software. If you meet any bugs or have any suggestion, please tell me.  
15    
16    
17  System Requirement  System Requirement
18  ==================  ==================
19  Operation System: Linux  1) GNU C Compiler  
20    2) PHP ( Version >= 8.2 )  
21  Software:  3) MySQL database ( Version >= 8.4 )  
 1) GNU C Compiler  
 2) PHP ( Version >= 8.2 )  
 3) MySQL database ( Version >= 8.4 )  
22    
23    
24  Quick Installation  Quick Installation
25  ==================  ==================
26  To install LBBS quickly, please do the following steps:  To install LBBS quickly, please do the following steps:
27    
28  1) Extract the source files from a tarball or export from GitHub  0) Prerequisite  
29       Follow README.md under [leafok_bbs](https://github.com/leafok88/leafok_bbs) to initialize the database structure shared by both web version and telnet version.  
30     Run the following command to set up the autoconf/automake environment,     It is highly recommended to finish the configuration steps of web version first and make sure those features could work properly.
31    
32     sh ./autogen.sh  1) Extract the source files from a tarball or export from GitHub  
33       Run the following command to set up the autoconf/automake environment,  
34       sh ./autogen.sh  
35     and fix any error if exists.     and fix any error if exists.
36    
37  2) Compile source files  2) Compile source files  
38       ./configure --prefix=/usr/local/lbbs  
    ./configure --prefix=/usr/local/lbbs  
   
39     make     make
40    
41  3) Create user and group  3) Create user and group  
   
42     sudo useradd bbs     sudo useradd bbs
43    
44  4) Install binary files and data files  4) Install binary files and data files  
   
45     sudo make install     sudo make install
46    
47  5) Modify following configuration files  5) Modify following configuration files  
48       Default configuration files is saved as *.default, you should rename them first.  
49     Default configuration files is saved as *.default, you should rename them first.     /usr/local/lbbs/conf/bbsd.conf  
50         /usr/local/lbbs/utils/conf/db_conn.inc.php  
51     /usr/local/lbbs/conf/bbsd.conf  
52      6) Generate menu configuration file with section data by running the script  
53     /usr/local/lbbs/utils/conf/db_conn.inc.php     sudo -u bbs php /usr/local/lbbs/utils/bin/gen_section_menu.php  
54       sudo -u bbs php /usr/local/lbbs/utils/bin/gen_ex_list.php  
 7) Generate menu configuration file with section data by running the script  
   
    sudo -u bbs php /usr/local/lbbs/utils/bin/gen_section_menu.php  
55    
56  6) Startup  7) Create or copy SSH2 RSA certificate into /usr/local/lbbs/conf  
57       ssh-keygen -t rsa -C "Your Server Name" -f ssh_host_rsa_key
58    
59    8) Startup  
60     sudo /usr/local/lbbs/bin/bbsd     sudo /usr/local/lbbs/bin/bbsd
61    
62  7) Set up systemd  9) Set up systemd  
63       Create your own /usr/lib/systemd/system/lbbs.service from the sample at conf/lbbs.service.default, and make any change if necessary.  
64     Create your own /usr/lib/systemd/system/lbbs.service from the sample at conf/lbbs.service.default, and make any change if necessary. Please note that the startup argument "-f" with bbsd should be used in systemd notify mode.     Reload daemon config and start the service.  
   
    Run the following bash command to startup the service:  
   
    sudo systemctl daemon-reload  
   
    sudo systemctl start lbbs  
   

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