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 >= 14.2  
   autoconf >= 2.68  
   automake >= 1.16  
   libssh >= 0.11  
   pcre2 >= 10.38  
   php >= 8.2  
   mysql >= 8.4  

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  
   ./configure --prefix=$LBBS_HOME_DIR  
   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/badwords.conf  
   $LBBS_HOME_DIR/utils/conf/db_conn.conf.php  

8) 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  

9) Create SSH2 RSA certificate  
   ssh-keygen -t rsa -C "Your Server Name" -f $LBBS_HOME_DIR/conf/ssh_host_rsa_key

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

11) (Optional) Set up systemd  
   Enable systemd related feature during config, by running:  
     ./configure --prefix=$LBBS_HOME_DIR --enable-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.  

12) (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.  

13) 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


For Cygwin User
==================
Installation of LBBS on Cygwin is similar to the above steps for Linux, except that:

a. Use additional config switches to keep compatible with the Cygwin environment.  
   ./configure --prefix=$LBBS_HOME_DIR --with-mariadb --without-epoll  

b. Enable Cygserver with optimized parameters (as large as possible) of XSI semaphore and shared memory in /etc/cygserver.conf  

c. Skip those steps not supported by Cygwin (e.g. systemd and logrotate).  
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.6	./configure --prefix=$LBBS_HOME_DIR
25	sysadm	1.1	make
26
27	sysadm	1.7	5) Create user and group
28	sysadm	1.1	sudo useradd bbs
29
30	sysadm	1.7	6) Install binary files and data files
31	sysadm	1.5	sudo make install
32	sysadm	1.6	chown -R bbs:bbs $LBBS_HOME_DIR
33	sysadm	1.1
34	sysadm	1.7	7) Modify following configuration files
35	sysadm	1.1	Default configuration files is saved as *.default, you should rename them first.
36	sysadm	1.6	$LBBS_HOME_DIR/conf/bbsd.conf
37			$LBBS_HOME_DIR/conf/badwords.conf
38			$LBBS_HOME_DIR/utils/conf/db_conn.conf.php
39	sysadm	1.1
40	sysadm	1.7	8) Generate menu configuration file with section data by running the script
41	sysadm	1.6	sudo -u bbs php $LBBS_HOME_DIR/utils/bin/gen_section_menu.php
42			sudo -u bbs php $LBBS_HOME_DIR/utils/bin/gen_ex_list.php
43	sysadm	1.1
44	sysadm	1.7	9) Create SSH2 RSA certificate
45	sysadm	1.6	ssh-keygen -t rsa -C "Your Server Name" -f $LBBS_HOME_DIR/conf/ssh_host_rsa_key
46	sysadm	1.1
47	sysadm	1.7	10) Startup
48	sysadm	1.6	sudo -u bbs $LBBS_HOME_DIR/bin/bbsd
49	sysadm	1.1
50	sysadm	1.9	11) (Optional) Set up systemd
51	sysadm	1.12	Enable systemd related feature during config, by running:
52			./configure --prefix=$LBBS_HOME_DIR --enable-systemd
53	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.
54	sysadm	1.1	Reload daemon config and start the service.
55	sysadm	1.3
56	sysadm	1.9	12) (Optional) Set up logrotate
57	sysadm	1.10	Create your own /etc/logrotate.d/lbbs from the sample at conf/lbbs.logrotate, and make any change if necessary.
58	sysadm	1.9	Restart logrotate service.
59
60			13) Cleanup on abnormal service termination
61	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:
62			sudo -u bbs ipcs
63			There should be no item owned by bbs. Otherwise, run the following command to cleanup:
64			sudo -u bbs ipcrm -a
65	sysadm	1.7
66	sysadm	1.12
67			For Cygwin User
68			==================
69			Installation of LBBS on Cygwin is similar to the above steps for Linux, except that:
70
71			a. Use additional config switches to keep compatible with the Cygwin environment.
72			./configure --prefix=$LBBS_HOME_DIR --with-mariadb --without-epoll
73
74			b. Enable Cygserver with optimized parameters (as large as possible) of XSI semaphore and shared memory in /etc/cygserver.conf
75
76			c. Skip those steps not supported by Cygwin (e.g. systemd and logrotate).
webmaster@leafok.com	ViewVC Help
Powered by ViewVC 1.3.0-beta1