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

Contents of /lbbs/README.md

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.9 - (show annotations)
Sat Jun 7 12:54:55 2025 UTC (9 months, 1 week ago) by sysadm
Branch: MAIN
Changes since 1.8: +4 -0 lines
Content type: text/markdown
Update installation step

1 # LBBS - Classical terminal server of LeafOK BBS
2
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 0) Prerequisite
38
39 Follow README.md under https://github.com/leafok88/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.
40
41 1) Extract the source files from a tarball or export from GitHub
42
43 Run the following command to set up the autoconf/automake environment,
44
45 sh ./autogen.sh
46
47 and fix any error if exists.
48
49 2) Compile source files
50
51 ./configure --prefix=/usr/local/lbbs
52
53 make
54
55 3) Create user and group
56
57 sudo useradd bbs
58
59 4) Install binary files and data files
60
61 sudo make install
62
63 5) Modify following configuration files
64
65 Default configuration files is saved as *.default, you should rename them first.
66
67 /usr/local/lbbs/conf/bbsd.conf
68
69 /usr/local/lbbs/utils/conf/db_conn.inc.php
70
71 6) Generate menu configuration file with section data by running the script
72
73 sudo -u bbs php /usr/local/lbbs/utils/bin/gen_section_menu.php
74
75 7) Create or copy SSH2 RSA certificate into /usr/local/lbbs/conf
76
77 ssh-keygen -t rsa -C "Your Server Name" -f ssh_host_rsa_key
78
79 8) Startup
80
81 sudo /usr/local/lbbs/bin/bbsd
82
83 9) Set up systemd
84
85 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.
86
87 Run the following bash command to startup the service:
88
89 sudo systemctl daemon-reload
90
91 sudo systemctl start lbbs
92

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