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

Diff of /lbbs/INSTALL.md

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

Revision 1.6 by sysadm, Fri Nov 7 07:27:36 2025 UTC Revision 1.20 by sysadm, Sat Nov 22 06:44:55 2025 UTC
# Line 1  Line 1 
1  Installation  Installation
2  ==================  ==================
3  To install LBBS, please perform the following steps:  To install LBBS on Linux (e.g. Debian 13, CentOS Stream 10), please perform the following steps:
4    
5  0) Prerequisite    0) Prerequisite  
6     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.       Follow README.md under [leafok_bbs](https://github.com/leafok/leafok_bbs) to initialize the database structure shared by both web version and telnet version.  
7     It is highly recommended to finish the configuration steps of web version first and make sure those features could work properly.     It is highly recommended to finish the configuration steps of web version first and make sure those features could work properly.
8    
9  1) Common requirements    1) Common requirements  
10     gcc >= 14.2.0       gcc >= 14.2  
11     autoconf >= 2.68       autoconf >= 2.68  
12     automake >= 1.16       automake >= 1.16  
13     libssh >= 0.11.1       libssh >= 0.11  
14     PHP >= 8.2       pcre2 >= 10.38  
15     MySQL >= 8.4     php >= 8.2  
16       mysql >= 8.4  
17    
18  2) Extract the source files from a tarball or export from GitHub    3) Extract the source files from a tarball or export from GitHub  
19     Run the following command to set up the autoconf/automake environment,       Run the following command to set up the autoconf/automake environment,  
20     sh ./autogen.sh     autoreconf --install --force
21    
22  3) Compile source files    4) Compile source files  
23     export LBBS_HOME_DIR=/usr/local/lbbs     export LBBS_HOME_DIR=/usr/local/lbbs  
24       (For Linux)  
25     ./configure --prefix=$LBBS_HOME_DIR       ./configure --prefix=$LBBS_HOME_DIR  
26     make     (For MSYS2 with MinGW-w64 toolchain)  
27       ./configure --prefix=$LBBS_HOME_DIR --disable-shared PKG_CONFIG_PATH=/mingw64/lib/pkgconfig/  
28       make  
29    
30  4) Create user and group    5) Create user and group  
31     sudo useradd bbs     sudo useradd bbs
32    
33  5) Install binary files and data files    6) Install binary files and data files  
34     sudo make install       sudo make install  
35     chown -R bbs:bbs $LBBS_HOME_DIR     chown -R bbs:bbs $LBBS_HOME_DIR
36    
37  6) Modify following configuration files    7) Modify following configuration files  
38     Default configuration files is saved as *.default, you should rename them first.       Default configuration files is saved as *.default, you should rename them first.  
39     $LBBS_HOME_DIR/conf/bbsd.conf       $LBBS_HOME_DIR/conf/bbsd.conf  
40     $LBBS_HOME_DIR/conf/badwords.conf       $LBBS_HOME_DIR/conf/badwords.conf  
41     $LBBS_HOME_DIR/utils/conf/db_conn.conf.php       $LBBS_HOME_DIR/utils/conf/db_conn.conf.php  
42    
43  7) Generate menu configuration file with section data by running the script    8) Copy CA cert file of MySQL server to $LBBS_HOME_DIR/conf/ca_cert.pem  
44    
45    9) Generate menu configuration file with section data by running the script  
46     sudo -u bbs php $LBBS_HOME_DIR/utils/bin/gen_section_menu.php       sudo -u bbs php $LBBS_HOME_DIR/utils/bin/gen_section_menu.php  
47     sudo -u bbs php $LBBS_HOME_DIR/utils/bin/gen_ex_list.php       sudo -u bbs php $LBBS_HOME_DIR/utils/bin/gen_ex_list.php  
48    
49  8) Create SSH2 RSA certificate    10) Create SSH2 RSA certificate  
50     ssh-keygen -t rsa -C "Your Server Name" -f $LBBS_HOME_DIR/conf/ssh_host_rsa_key     ssh-keygen -t rsa -C "Your Server Name" -f $LBBS_HOME_DIR/conf/ssh_host_rsa_key
51    
52  9) Startup    11) Startup  
53     sudo -u bbs $LBBS_HOME_DIR/bin/bbsd     sudo -u bbs $LBBS_HOME_DIR/bin/bbsd
54    
55  10) Set up systemd    12) (Optional) Set up systemd  
56     Create your own /usr/lib/systemd/system/lbbs.service from the sample at conf/lbbs.service.default, and make any change if necessary.       Create your own /usr/lib/systemd/system/lbbs.service from the sample at conf/lbbs.service, and make any change if necessary.  
57     Reload daemon config and start the service.       Reload daemon config and start the service.  
58    
59  11) Cleanup on abnormal service termination    13) (Optional) Set up logrotate  
60       Create your own /etc/logrotate.d/lbbs from the sample at conf/lbbs.logrotate, and make any change if necessary.  
61       Restart logrotate service.  
62    
63    14) Cleanup on abnormal service termination  
64     In case of any unexpected failure or improper operation which results in abnormal termination of lbbs process, manual cleanup of shared memory / semaphore might be required before re-launch the process. Run the following command to check first:       In case of any unexpected failure or improper operation which results in abnormal termination of lbbs process, manual cleanup of shared memory / semaphore might be required before re-launch the process. Run the following command to check first:  
65     sudo -u bbs ipcs       sudo -u bbs ipcs  
66     There should be no item owned by bbs. Otherwise, run the following command to cleanup:       There should be no item owned by bbs. Otherwise, run the following command to cleanup:  
67     sudo -u bbs ipcrm -a     sudo -u bbs ipcrm -a
68    


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

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