LeafOK_CVS/lbbs/INSTALL.md

Installation
==================
To install LBBS on Linux (e.g. Debian 13, CentOS Stream 10), please perform the following steps:

0) Prerequisite  
   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.   
   It is highly recommended to finish the configuration steps of web version first and make sure those features could work properly.

1) Common requirements  
   gcc >= 13.3  
   autoconf >= 2.68  
   automake >= 1.16  
   php >= 8.2  
   mysql >= 8.4  
   (For Debian / Ubuntu)  
   sudo apt-get install -y libssh-dev libsystemd-dev  
   (For CentOS / RHEL)  
   sudo dnf install -y libssh-devel systemd-devel  
   (For MSYS2 with MinGW-w64 toolchain)  
   pacman -S --needed msys2-runtime-devel libssh libssh-devel pcre2-devel mingw-w64-x86_64-libiconv mingw-w64-x86_64-libmariadbclient  

3) Extract the source files from a tarball or export from GitHub  
   Run the following command to set up the autoconf/automake environment,  
   autoreconf --install --force

4) Compile source files  
   export LBBS_HOME_DIR=/usr/local/lbbs  
   (For Linux)  
   ./configure --prefix=$LBBS_HOME_DIR  
   (For MSYS2 with MinGW-w64 toolchain)  
   ./configure --prefix=$LBBS_HOME_DIR --disable-shared PKG_CONFIG_PATH=/mingw64/lib/pkgconfig/  
   make  

5) Create user and group  
   sudo useradd bbs

6) Install binary files and data files  
   sudo make install  
   chown -R bbs:bbs $LBBS_HOME_DIR

7) Modify following configuration files  
   Default configuration files is saved as *.default, you should rename them first.  
   $LBBS_HOME_DIR/conf/bbsd.conf  
   $LBBS_HOME_DIR/conf/bbsnet.conf  
   $LBBS_HOME_DIR/conf/badwords.conf  
   $LBBS_HOME_DIR/utils/conf/db_conn.conf.php  

8) Copy CA cert file of MySQL server to $LBBS_HOME_DIR/conf/ca_cert.pem  

9) Generate menu configuration file with section data by running the script  
   sudo -u bbs php $LBBS_HOME_DIR/utils/bin/gen_section_menu.php  
   sudo -u bbs php $LBBS_HOME_DIR/utils/bin/gen_ex_list.php  
   sudo -u bbs php $LBBS_HOME_DIR/utils/bin/gen_top.php  

10) Create SSH2 RSA / ED25519 certificate  
   ssh-keygen -t rsa -C "Your Server Name" -f $LBBS_HOME_DIR/conf/ssh_host_rsa_key  
   ssh-keygen -t ed25519 -C "Your Server Name" -f $LBBS_HOME_DIR/conf/ssh_host_ed25519_key  
   ssh-keygen -t ecdsa -C "Your Server Name" -f $LBBS_HOME_DIR/conf/ssh_host_ecdsa_key  

11) Startup  
   sudo -u bbs $LBBS_HOME_DIR/bin/bbsd

12) (Optional) Set up systemd  
   Create your own /usr/lib/systemd/system/lbbs.service from the sample at conf/lbbs.service, and make any change if necessary.  
   Reload daemon config and start the service.  

13) (Optional) Set up logrotate  
   Create your own /etc/logrotate.d/lbbs from the sample at conf/lbbs.logrotate, and make any change if necessary.  
   Restart logrotate service.  

14) Cleanup on abnormal service termination  
   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:  
   sudo -u bbs ipcs  
   There should be no item owned by bbs. Otherwise, run the following command to cleanup:  
   sudo -u bbs ipcrm -a

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.28	gcc >= 13.3
11	sysadm	1.2	autoconf >= 2.68
12			automake >= 1.16
13	sysadm	1.7	php >= 8.2
14			mysql >= 8.4
15	sysadm	1.22	(For Debian / Ubuntu)
16			sudo apt-get install -y libssh-dev libsystemd-dev
17			(For CentOS / RHEL)
18			sudo dnf install -y libssh-devel systemd-devel
19	sysadm	1.21	(For MSYS2 with MinGW-w64 toolchain)
20	sysadm	1.24	pacman -S --needed msys2-runtime-devel libssh libssh-devel pcre2-devel mingw-w64-x86_64-libiconv mingw-w64-x86_64-libmariadbclient
21	sysadm	1.2
22	sysadm	1.7	3) Extract the source files from a tarball or export from GitHub
23	sysadm	1.1	Run the following command to set up the autoconf/automake environment,
24	sysadm	1.11	autoreconf --install --force
25	sysadm	1.1
26	sysadm	1.7	4) Compile source files
27			export LBBS_HOME_DIR=/usr/local/lbbs
28	sysadm	1.20	(For Linux)
29	sysadm	1.18	./configure --prefix=$LBBS_HOME_DIR
30	sysadm	1.20	(For MSYS2 with MinGW-w64 toolchain)
31			./configure --prefix=$LBBS_HOME_DIR --disable-shared PKG_CONFIG_PATH=/mingw64/lib/pkgconfig/
32	sysadm	1.14	make
33	sysadm	1.1
34	sysadm	1.7	5) Create user and group
35	sysadm	1.1	sudo useradd bbs
36
37	sysadm	1.7	6) Install binary files and data files
38	sysadm	1.5	sudo make install
39	sysadm	1.6	chown -R bbs:bbs $LBBS_HOME_DIR
40	sysadm	1.1
41	sysadm	1.7	7) Modify following configuration files
42	sysadm	1.1	Default configuration files is saved as *.default, you should rename them first.
43	sysadm	1.6	$LBBS_HOME_DIR/conf/bbsd.conf
44	sysadm	1.26	$LBBS_HOME_DIR/conf/bbsnet.conf
45	sysadm	1.6	$LBBS_HOME_DIR/conf/badwords.conf
46			$LBBS_HOME_DIR/utils/conf/db_conn.conf.php
47	sysadm	1.1
48	sysadm	1.16	8) Copy CA cert file of MySQL server to $LBBS_HOME_DIR/conf/ca_cert.pem
49
50			9) Generate menu configuration file with section data by running the script
51	sysadm	1.6	sudo -u bbs php $LBBS_HOME_DIR/utils/bin/gen_section_menu.php
52			sudo -u bbs php $LBBS_HOME_DIR/utils/bin/gen_ex_list.php
53	sysadm	1.28	sudo -u bbs php $LBBS_HOME_DIR/utils/bin/gen_top.php
54	sysadm	1.1
55	sysadm	1.25	10) Create SSH2 RSA / ED25519 certificate
56			ssh-keygen -t rsa -C "Your Server Name" -f $LBBS_HOME_DIR/conf/ssh_host_rsa_key
57			ssh-keygen -t ed25519 -C "Your Server Name" -f $LBBS_HOME_DIR/conf/ssh_host_ed25519_key
58	sysadm	1.27	ssh-keygen -t ecdsa -C "Your Server Name" -f $LBBS_HOME_DIR/conf/ssh_host_ecdsa_key
59	sysadm	1.1
60	sysadm	1.16	11) Startup
61	sysadm	1.6	sudo -u bbs $LBBS_HOME_DIR/bin/bbsd
62	sysadm	1.1
63	sysadm	1.16	12) (Optional) Set up systemd
64	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.
65	sysadm	1.1	Reload daemon config and start the service.
66	sysadm	1.3
67	sysadm	1.16	13) (Optional) Set up logrotate
68	sysadm	1.10	Create your own /etc/logrotate.d/lbbs from the sample at conf/lbbs.logrotate, and make any change if necessary.
69	sysadm	1.9	Restart logrotate service.
70
71	sysadm	1.16	14) Cleanup on abnormal service termination
72	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:
73			sudo -u bbs ipcs
74			There should be no item owned by bbs. Otherwise, run the following command to cleanup:
75			sudo -u bbs ipcrm -a
76	sysadm	1.7
webmaster@leafok.com	ViewVC Help
Powered by ViewVC 1.3.0-beta1