LeafOK_CVS/lbbs/README.md

# LBBS - Classical terminal server of LeafOK BBS

Copyright (C) 2004-2025 by Leaflet

Email : leaflet@leafok.com


Introduction
=================
This software (named as LBBS) aims to providing a telnet-based interface for a pure web-based BBS (named as LeafOK BBS).

LeafOK BBS is a powerful BBS system, not only providing almost every function that a standard BBS should have, but also giving many features other BBS hasn't complemented yet.

As an open source project, LeafOK BBS use MySQL as its major data depository, and PHP as its developing language. With MySQL and PHP, LeafOK BBS becomes a platform-independent system. It can works stably on many popular Web Servers such as Apache and IIS.

However, as a pure web-based BBS, its shortage is inevitable. For LeafOK BBS uses Browser/Server as its architecture, it will cause more data traffic between Users and Server than telnet-based BBS, and its response is a little slower than telnet-based BBS.

In order to conquer these shortage, a new project was launched. LBBS is a telnet-based BBS which is full compatible with LeafOK BBS. It also uses MySQL as its data repository, and keep coherence with the data structure of LeafOK BBS. LBBS is designed to be a system running on Linux, with GNU C as its developing language.

Thank you for using this software. If you meet any bugs or have any suggestion, please tell me.


System Requirement
==================
Operation System: Linux

Software: 
1) GNU C Compiler
2) PHP ( Version >= 8.2 )
3) MySQL database ( Version >= 8.4 )


Quick Installation
==================
To install LBBS quickly, please do the following steps:

1) Extract the source files from a tarball or export from GitHub

   Run the following command to set up the autoconf/automake environment,

   sh ./autogen.sh

   and fix any error if exists.

2) Compile source files

   ./configure --prefix=/usr/local/lbbs

   make

3) Create user and group

   sudo useradd bbs

4) Install binary files and data files

   sudo make install

5) Modify following configuration files

   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

6) Generate menu configuration file with section data by running the script

   sudo -u bbs php /usr/local/lbbs/utils/bin/gen_section_menu.php

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. Please note that the startup argument "-f" with bbsd should be used in systemd notify mode.

   Run the following bash command to startup the service:

   sudo systemctl daemon-reload

   sudo systemctl start lbbs

1	sysadm	1.7	# LBBS - Classical terminal server of LeafOK BBS
2	sysadm	1.1
3			Copyright (C) 2004-2025 by Leaflet
4
5			Email : leaflet@leafok.com
6
7
8			Introduction
9			=================
10			This software (named as LBBS) aims to providing a telnet-based interface for a pure web-based BBS (named as LeafOK BBS).
11
12			LeafOK BBS is a powerful BBS system, not only providing almost every function that a standard BBS should have, but also giving many features other BBS hasn't complemented yet.
13
14			As an open source project, LeafOK BBS use MySQL as its major data depository, and PHP as its developing language. With MySQL and PHP, LeafOK BBS becomes a platform-independent system. It can works stably on many popular Web Servers such as Apache and IIS.
15
16			However, as a pure web-based BBS, its shortage is inevitable. For LeafOK BBS uses Browser/Server as its architecture, it will cause more data traffic between Users and Server than telnet-based BBS, and its response is a little slower than telnet-based BBS.
17
18			In order to conquer these shortage, a new project was launched. LBBS is a telnet-based BBS which is full compatible with LeafOK BBS. It also uses MySQL as its data repository, and keep coherence with the data structure of LeafOK BBS. LBBS is designed to be a system running on Linux, with GNU C as its developing language.
19
20			Thank you for using this software. If you meet any bugs or have any suggestion, please tell me.
21
22
23			System Requirement
24			==================
25			Operation System: Linux
26
27			Software:
28			1) GNU C Compiler
29			2) PHP ( Version >= 8.2 )
30			3) MySQL database ( Version >= 8.4 )
31
32
33			Quick Installation
34			==================
35			To install LBBS quickly, please do the following steps:
36
37			1) Extract the source files from a tarball or export from GitHub
38
39			Run the following command to set up the autoconf/automake environment,
40
41			sh ./autogen.sh
42
43			and fix any error if exists.
44
45			2) Compile source files
46
47			./configure --prefix=/usr/local/lbbs
48
49			make
50
51	sysadm	1.2	3) Create user and group
52	sysadm	1.1
53	sysadm	1.2	sudo useradd bbs
54	sysadm	1.1
55	sysadm	1.2	4) Install binary files and data files
56	sysadm	1.1
57	sysadm	1.2	sudo make install
58	sysadm	1.1
59	sysadm	1.2	5) Modify following configuration files
60	sysadm	1.1
61			Default configuration files is saved as *.default, you should rename them first.
62
63			/usr/local/lbbs/conf/bbsd.conf
64
65			/usr/local/lbbs/utils/conf/db_conn.inc.php
66
67	sysadm	1.8	6) Generate menu configuration file with section data by running the script
68	sysadm	1.6
69			sudo -u bbs php /usr/local/lbbs/utils/bin/gen_section_menu.php
70
71	sysadm	1.8	7) Create or copy SSH2 RSA certificate into /usr/local/lbbs/conf
72
73			ssh-keygen -t rsa -C "Your Server Name" -f ssh_host_rsa_key
74
75			8) Startup
76	sysadm	1.1
77	sysadm	1.3	sudo /usr/local/lbbs/bin/bbsd
78	sysadm	1.1
79	sysadm	1.8	9) Set up systemd
80	sysadm	1.4
81	sysadm	1.5	Create your own /usr/lib/systemd/system/lbbs.service from the sample at conf/lbbs.service.default, and make any change if necessary. Please note that the startup argument "-f" with bbsd should be used in systemd notify mode.
82	sysadm	1.4
83			Run the following bash command to startup the service:
84
85	sysadm	1.6	sudo systemctl daemon-reload
86	sysadm	1.4
87	sysadm	1.6	sudo systemctl start lbbs
88	sysadm	1.4
webmaster@leafok.com	ViewVC Help
Powered by ViewVC 1.3.0-beta1