Annotation of telnetbbs/telnetbbs.conf, revision 1.2
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.2 ! nick 7: ## $Id: telnetbbs.conf,v 1.1 2010-12-14 20:32:49 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.1 nick 35: port = 3023
1.2 ! nick 36:
! 37: ##
! 38: ## This set of ports is entirely different than the port above. Once someone
! 39: ## connects to the telnet BBS server, the server will determine if there
! 40: ## are any nodes available. If there are is spawns off a child process
! 41: ## and moves the connection to a new port so that it can continue allowing
! 42: ## connections on the original listening port.
! 43: ##
! 44: ## Each node the BBS uses will be assigned the base_port + node. So if
! 45: ## your BBS is configured for 10 nodes and the base_port is set to 7000, it
! 46: ## will use ports 7000 - 7009 for connections. It is highly recommended
! 47: ## to use non-privledged ports for this and confirm there are no
! 48: ## services running on the ports you wish to use.
! 49: ##
! 50: base_port = 7000
! 51:
! 52: ##
! 53: ## The telnet bbs server uses dosbox which requires an X server for display.
! 54: ## The X server does not need to be local. Set the display here. If X
! 55: ## is running on the machine the telnet bbs server is running this option
! 56: ## does not need to be changed.
! 57: ##
! 58: ## If using a headless system with no access to an X server on the network
! 59: ## an X server such as nxserver (http://www.nomachine.com/download.php) can
! 60: ## be used. However, each time the server is rebooted or nxserver is
! 61: ## restarted the port it is using may change and this will need to be updated.
! 62: ##
! 63: ## Multiple BBS' can share this display setting.
! 64: ##
1.1 nick 65: display = :0.0
1.2 ! nick 66:
! 67: ##
! 68: ## Enter the name of your BBS here. This name gets displayed when a
! 69: ## connection is first made to the telnet server, before the BBS is
! 70: ## actually launched. Once a node has been allocated to the connection
! 71: ## a lock file for that node is put in place, which is based on this
! 72: ## name as well.
! 73: ##
1.1 nick 74: bbs_name = Hell's Dominion BBS
1.2 ! nick 75:
! 76: ##
! 77: ## The lock_path specified where the individual lock files for the BBS nodes
! 78: ## will be stored. Once someone connects and a node has been allocated for
! 79: ## that user a node lock file is put in place. It is only removed once that
! 80: ## node has been shutdown. If the server is killed (ctrl-c/HUP) these will
! 81: ## currently not be cleaned up.
! 82: ##
! 83: ## As above, lock files are normally in '/var/run'. If running as non-root,
! 84: ## which is recommended, using the lock directory created above is perfectly
! 85: ## acceptable.
! 86: ##
! 87: lock_path = /tmp
! 88:
! 89: ##
! 90: ## Since dosbox is being utilized, each time a connection is made a new
! 91: ## dosbox configuration is generated. The '__NODE__' in the command line
! 92: ## is necessary as the configuration file is passed to dosbox on a
! 93: ## per node basis which determines how the BBS is started.
! 94: ##
1.1 nick 95: dosbox_cfg = /tmp/dosbox-__NODE__.conf
1.2 ! nick 96:
! 97: ##
! 98: ## The configuration file above is generated from a template. If you are
! 99: ## running multiple BBSes you will need different templates per BBS. This
! 100: ## template contains the autoexec.bat that will launch your BBS.
! 101: ##
! 102: dosboxt = dosbox.conf.template
! 103:
! 104: ##
! 105: ## This is the command that will launch dosbox and pass it the configuration
! 106: ## file. You can add custom dosbox options to the command line below.
! 107: ##
1.1 nick 108: bbs_cmd = DISPLAY=$DISPLAY /usr/bin/dosbox -conf
1.2 ! nick 109:
! 110: ##
! 111: ## This will enable logging to a file on the system. By default any system
! 112: ## messages will be sent to STDOUT and STDERR.
! 113: ##
1.1 nick 114: logging = 0
1.2 ! nick 115:
! 116: ##
! 117: ## If logging is enabled this will tell the server what file to write to.
! 118: ## Traditionally these files are stored in '/var/log' but root access is
! 119: ## required to write to this directory. As mentioned before it's not
! 120: ## recommended to run as root. Creating a seperate directory in '/var/log'
! 121: ## with write permissions to the telnet bbs server user is acceptable.
! 122: ##
1.1 nick 123: log_path = /tmp/bbs.log
1.2 ! nick 124:
! 125: ##
! 126: ## This specifies the number of nodes the telnet BBS server will spawn.
! 127: ## This starts counting from 1. EG: for a 5 node BBS, enter 5.
! 128: ##
1.1 nick 129: nodes = 1
1.2 ! nick 130:
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