Annotation of telnetbbs/telnetbbs.conf, revision 1.3
1.1 nick 1: ###############################################################################
2: ##
3: ## This is the configuration file for telnetbbs.pl. If everything is
4: ## commented out the defaults will be used.
5: ##
6: ## Nicholas DeClario <nick@demandred.dyndns.org>
1.3 ! nick 7: ## $Id: telnetbbs.conf,v 1.2 2010-12-16 14:12:27 nick Exp $
1.1 nick 8: ## December 2010
9: ##
10: ###############################################################################
1.2 nick 11: ##
12: ## pidfile contains the pid of the parent process and also acts as a lock
13: ## file. If you plan on running more than 1 BBS on the same system this
14: ## needs to be different for each BBS configuration.
15: ##
16: ## Also note, traditionally lock/pid files are in '/var/run'; however, root
17: ## access is required to write to this directory. It is not recommended
18: ## running your BBS as root for security reasons. If you wish to continue
19: ## using '/var/run' it's recommended you create a directory such as
20: ## '/var/run/telnetbbs', change the ownership to the user/group that will
21: ## be running the BBS and point the PID file(s) to that location.
22: ##
1.1 nick 23: pidfile = /tmp/telnetbbs.pid
1.2 nick 24:
25: ##
26: ## This is the initial port for the telnet service to listen on. Telnet
27: ## generally uses port 23 but root access is required to use any privledged
28: ## port, which is any port 1024 or below. If running this service behind a
29: ## router, the router can be configured to accept incoming connections on
30: ## port 23 and forward it to a different port on the system.
31: ##
32: ## If running more than one BBS, you will need to run each BBS on a different
33: ## port.
34: ##
1.3 ! nick 35: ## Also note, this can be set at the command line with the '-p' option and
! 36: ## will overwrite the setting in here. This can be usefull for testing.
! 37: ##
1.1 nick 38: port = 3023
1.2 nick 39:
40: ##
41: ## This set of ports is entirely different than the port above. Once someone
42: ## connects to the telnet BBS server, the server will determine if there
43: ## are any nodes available. If there are is spawns off a child process
44: ## and moves the connection to a new port so that it can continue allowing
45: ## connections on the original listening port.
46: ##
47: ## Each node the BBS uses will be assigned the base_port + node. So if
48: ## your BBS is configured for 10 nodes and the base_port is set to 7000, it
49: ## will use ports 7000 - 7009 for connections. It is highly recommended
50: ## to use non-privledged ports for this and confirm there are no
51: ## services running on the ports you wish to use.
52: ##
53: base_port = 7000
54:
55: ##
56: ## The telnet bbs server uses dosbox which requires an X server for display.
57: ## The X server does not need to be local. Set the display here. If X
58: ## is running on the machine the telnet bbs server is running this option
59: ## does not need to be changed.
60: ##
61: ## If using a headless system with no access to an X server on the network
62: ## an X server such as nxserver (http://www.nomachine.com/download.php) can
63: ## be used. However, each time the server is rebooted or nxserver is
64: ## restarted the port it is using may change and this will need to be updated.
65: ##
66: ## Multiple BBS' can share this display setting.
67: ##
1.1 nick 68: display = :0.0
1.2 nick 69:
70: ##
71: ## Enter the name of your BBS here. This name gets displayed when a
72: ## connection is first made to the telnet server, before the BBS is
73: ## actually launched. Once a node has been allocated to the connection
74: ## a lock file for that node is put in place, which is based on this
75: ## name as well.
76: ##
1.1 nick 77: bbs_name = Hell's Dominion BBS
1.2 nick 78:
79: ##
80: ## The lock_path specified where the individual lock files for the BBS nodes
81: ## will be stored. Once someone connects and a node has been allocated for
82: ## that user a node lock file is put in place. It is only removed once that
1.3 ! nick 83: ## node has been shutdown.
! 84: ##
! 85: ## If the server is killed with a HUP (kill -HUP), INT (kill -2) or TERM
! 86: ## (ctrl-C) these will be cleanly removed.
1.2 nick 87: ##
88: ## As above, lock files are normally in '/var/run'. If running as non-root,
89: ## which is recommended, using the lock directory created above is perfectly
90: ## acceptable.
91: ##
92: lock_path = /tmp
93:
94: ##
95: ## Since dosbox is being utilized, each time a connection is made a new
96: ## dosbox configuration is generated. The '__NODE__' in the command line
97: ## is necessary as the configuration file is passed to dosbox on a
98: ## per node basis which determines how the BBS is started.
99: ##
1.1 nick 100: dosbox_cfg = /tmp/dosbox-__NODE__.conf
1.2 nick 101:
102: ##
103: ## The configuration file above is generated from a template. If you are
104: ## running multiple BBSes you will need different templates per BBS. This
105: ## template contains the autoexec.bat that will launch your BBS.
106: ##
107: dosboxt = dosbox.conf.template
108:
109: ##
110: ## This is the command that will launch dosbox and pass it the configuration
111: ## file. You can add custom dosbox options to the command line below.
112: ##
1.1 nick 113: bbs_cmd = DISPLAY=$DISPLAY /usr/bin/dosbox -conf
1.2 nick 114:
115: ##
116: ## This will enable logging to a file on the system. By default any system
117: ## messages will be sent to STDOUT and STDERR.
118: ##
1.1 nick 119: logging = 0
1.2 nick 120:
121: ##
122: ## If logging is enabled this will tell the server what file to write to.
123: ## Traditionally these files are stored in '/var/log' but root access is
124: ## required to write to this directory. As mentioned before it's not
125: ## recommended to run as root. Creating a seperate directory in '/var/log'
126: ## with write permissions to the telnet bbs server user is acceptable.
127: ##
1.1 nick 128: log_path = /tmp/bbs.log
1.2 nick 129:
130: ##
131: ## This specifies the number of nodes the telnet BBS server will spawn.
132: ## This starts counting from 1. EG: for a 5 node BBS, enter 5.
133: ##
1.1 nick 134: nodes = 1
1.2 nick 135:
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to telnetbbs.conf CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [Local Repository] / telnetbbs