/[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.12 by sysadm, Tue Jun 24 13:30:52 2025 UTC Revision 1.25 by sysadm, Thu Jan 8 03:18:58 2026 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    Chinese version of README.md is located at [README.zh_CN.md](README.zh_CN.md)
 Email : leaflet@leafok.com    
 Demo site : bbs.fenglin.info (Telnet 2323 / SSH2 2322)  
4    
5    ## Introduction
6    
7  Introduction  This software aims to provide a telnet-based interface for a pure web-based BBS [leafok_bbs](https://github.com/leafok/leafok_bbs).
 =================  
 This software (named as LBBS) aims to providing a telnet-based interface for a pure web-based BBS (named as LeafOK BBS).    
 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.    
 Thank you for using this software. If you meet any bugs or have any suggestion, please tell me.  
8    
9    Demo site: fenglin.info (Telnet 2323 / SSH2 2322)
10    
11  System Requirement  ![Welcome screen](misc/images/ssh_welcome.jpg "Welcome to LBBS")
12  ==================  ![Main menu](misc/images/telnet_menu.jpg "Main menu")
13  1) GNU C Compiler  ![Section view](misc/images/telnet_section.jpg "List of articles")
14  2) PHP ( Version >= 8.2 )  ![Article reader](misc/images/telnet_article_reader.jpg "Article reader")
 3) MySQL database ( Version >= 8.4 )  
15    
16    ## System Requirements
17    
18  Quick Installation  1. GNU C Compiler
19  ==================  2. PHP (version 8.2 or higher)
20  To install LBBS quickly, please do the following steps:  3. MySQL database (version 8.4 or higher)
21    
22  0) Prerequisite  ## Installation
23    
24     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.  See guide in [INSTALL.md](INSTALL.md)
25    
26  1) Extract the source files from a tarball or export from GitHub    ## Tutorial
    Run the following command to set up the autoconf/automake environment,    
    sh ./autogen.sh    
    and fix any error if exists.  
27    
28  2) Compile source files    Watch demos and keynotes in [Tutorial.md](Tutorial.md)
    ./configure --prefix=/usr/local/lbbs    
    make  
29    
30  3) Create user and group    ## Copyright
    sudo useradd bbs  
31    
32  4) Install binary files and data files    Copyright (C) 2004-2026 Leaflet <leaflet@leafok.com>
    sudo make install  
33    
34  5) Modify following configuration files    ## License
    Default configuration files is saved as *.default, you should rename them first.    
    /usr/local/lbbs/conf/bbsd.conf    
    /usr/local/lbbs/utils/conf/db_conn.inc.php  
35    
36  6) Generate menu configuration file with section data by running the script    This program is free software; you can redistribute it and/or modify
37     sudo -u bbs php /usr/local/lbbs/utils/bin/gen_section_menu.php  it under the terms of the [GNU General Public License](LICENSE) as published by
38     sudo -u bbs php /usr/local/lbbs/utils/bin/gen_ex_list.php  the Free Software Foundation; either version 3 of the License, or
39    (at your option) any later version.
 7) Create or copy SSH2 RSA certificate into /usr/local/lbbs/conf    
    ssh-keygen -t rsa -C "Your Server Name" -f ssh_host_rsa_key  
   
 8) Startup    
    sudo /usr/local/lbbs/bin/bbsd  
   
 9) Set up systemd    
    Create your own /usr/lib/systemd/system/lbbs.service from the sample at conf/lbbs.service.default, and make any change if necessary.    
    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