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

Annotation of /lbbs/INSTALL.md

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.17 - (hide annotations)
Fri Nov 21 03:33:05 2025 UTC (3 months, 3 weeks ago) by sysadm
Branch: MAIN
Changes since 1.16: +1 -1 lines
Content type: text/markdown
Update INSTALL

1 sysadm 1.1 Installation
2     ==================
3 sysadm 1.12 To install LBBS on Linux (e.g. Debian 13, CentOS Stream 10), please perform the following steps:
4 sysadm 1.1
5     0) Prerequisite
6 sysadm 1.8 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 sysadm 1.1 It is highly recommended to finish the configuration steps of web version first and make sure those features could work properly.
8    
9 sysadm 1.2 1) Common requirements
10 sysadm 1.7 gcc >= 14.2
11 sysadm 1.2 autoconf >= 2.68
12     automake >= 1.16
13 sysadm 1.7 libssh >= 0.11
14     pcre2 >= 10.38
15     php >= 8.2
16     mysql >= 8.4
17 sysadm 1.2
18 sysadm 1.7 3) Extract the source files from a tarball or export from GitHub
19 sysadm 1.1 Run the following command to set up the autoconf/automake environment,
20 sysadm 1.11 autoreconf --install --force
21 sysadm 1.1
22 sysadm 1.7 4) Compile source files
23     export LBBS_HOME_DIR=/usr/local/lbbs
24 sysadm 1.14 Choose different implementation based on System V or Posix
25     ./configure --prefix=$LBBS_HOME_DIR --with-sysv
26     ./configure --prefix=$LBBS_HOME_DIR --without-sysv
27     make
28 sysadm 1.1
29 sysadm 1.7 5) Create user and group
30 sysadm 1.1 sudo useradd bbs
31    
32 sysadm 1.7 6) Install binary files and data files
33 sysadm 1.5 sudo make install
34 sysadm 1.6 chown -R bbs:bbs $LBBS_HOME_DIR
35 sysadm 1.1
36 sysadm 1.7 7) Modify following configuration files
37 sysadm 1.1 Default configuration files is saved as *.default, you should rename them first.
38 sysadm 1.6 $LBBS_HOME_DIR/conf/bbsd.conf
39     $LBBS_HOME_DIR/conf/badwords.conf
40     $LBBS_HOME_DIR/utils/conf/db_conn.conf.php
41 sysadm 1.1
42 sysadm 1.16 8) Copy CA cert file of MySQL server to $LBBS_HOME_DIR/conf/ca_cert.pem
43    
44     9) Generate menu configuration file with section data by running the script
45 sysadm 1.6 sudo -u bbs php $LBBS_HOME_DIR/utils/bin/gen_section_menu.php
46     sudo -u bbs php $LBBS_HOME_DIR/utils/bin/gen_ex_list.php
47 sysadm 1.1
48 sysadm 1.16 10) Create SSH2 RSA certificate
49 sysadm 1.6 ssh-keygen -t rsa -C "Your Server Name" -f $LBBS_HOME_DIR/conf/ssh_host_rsa_key
50 sysadm 1.1
51 sysadm 1.16 11) Startup
52 sysadm 1.6 sudo -u bbs $LBBS_HOME_DIR/bin/bbsd
53 sysadm 1.1
54 sysadm 1.16 12) (Optional) Set up systemd
55 sysadm 1.12 Enable systemd related feature during config, by running:
56     ./configure --prefix=$LBBS_HOME_DIR --enable-systemd
57 sysadm 1.10 Create your own /usr/lib/systemd/system/lbbs.service from the sample at conf/lbbs.service, and make any change if necessary.
58 sysadm 1.1 Reload daemon config and start the service.
59 sysadm 1.3
60 sysadm 1.16 13) (Optional) Set up logrotate
61 sysadm 1.10 Create your own /etc/logrotate.d/lbbs from the sample at conf/lbbs.logrotate, and make any change if necessary.
62 sysadm 1.9 Restart logrotate service.
63    
64 sysadm 1.16 14) Cleanup on abnormal service termination
65 sysadm 1.5 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:
66     sudo -u bbs ipcs
67     There should be no item owned by bbs. Otherwise, run the following command to cleanup:
68     sudo -u bbs ipcrm -a
69 sysadm 1.7
70 sysadm 1.12
71 sysadm 1.16 For MSYS2 User
72 sysadm 1.12 ==================
73 sysadm 1.14 Installation of LBBS on MSYS2 is similar to the above steps for Linux, except that:
74 sysadm 1.12
75 sysadm 1.16 1) Use additional config switches to keep compatible with the MSYS2 environment.
76 sysadm 1.17 ./configure --prefix=$LBBS_HOME_DIR --with-mariadb --with-iconv --without-epoll --without-sysv
77 sysadm 1.12
78 sysadm 1.16 2) Skip those steps not supported (e.g. systemd and logrotate).
79 sysadm 1.12

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