This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
projects:opensource:titan:configure [2019/04/29 11:24] apam |
— (current) | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | Configuring Titan is done with a single JSON file. | ||
- | |||
- | ===== Sections ===== | ||
- | |||
- | ==== Main ==== | ||
- | |||
- | * **MaxNodes** The Maximum number of nodes the system supports | ||
- | * **TelnetPort** The Port to listen for Telnet Connections | ||
- | * **RloginPort** The Port to listen for rlogin connections | ||
- | * **SSHPort** The Port to listen for SSH connections | ||
- | * **SystemName** Your BBS Name | ||
- | * **SysopName** The USERNAME of the sysop account | ||
- | * **LogLevel** The level of severity to use for the log file | ||
- | |||
- | ==== Paths ==== | ||
- | |||
- | * **GFiles** Path to the directory where txt files sent as menus are stored | ||
- | * **Databases** Path to database files | ||
- | * **Temp** Path to node directories where temporary files are placed. | ||
- | * **SEXYZ** Path and Filename of SEXYZ, used for file transfers. | ||
- | * **ExternalEditor** Path and Filename of a batchfile that will launch an external editor. | ||
- | * **SSHRSAKey** Path and filename of SSH Host RSA key | ||
- | * **SSHDSAKey** Path and filename of SSH Host DSA key | ||
- | * **LogFile** Path and filename of Log file | ||
- | * **MailSemaphore** Path and filename of semaphore to create when a mail is entered. | ||
- | |||
- | |||
- | ==== MessageBases ==== | ||
- | |||
- | * **name** The name of the message base. | ||
- | * **id** The id used for the message base in the database. | ||
- | |||
- | ==== MessageConferences ==== | ||
- | |||
- | * **name** The name of the message conference. | ||
- | * **id** The id used for the message conference in the database. | ||
- | * **areas** an array of message base ids | ||
- | |||
- | |||
- | ===== Example Configuration File ===== | ||
- | |||
- | |||
- | { | ||
- | "Main": { | ||
- | "MaxNodes": 5, | ||
- | "TelnetPort": 23, | ||
- | "RloginPort": 513, | ||
- | "SSHPort": 22, | ||
- | "SystemName": "A New Titan BBS", | ||
- | "SysopName": "Sysop", | ||
- | "LogLevel": "Info" | ||
- | }, | ||
- | "Paths": { | ||
- | "GFiles": "C:/bbs/gfiles", | ||
- | "Databases": "C:/bbs/dbs", | ||
- | "Temp": "C:/bbs/temp", | ||
- | "SEXYZ": "C:/bbs/sexyz.exe", | ||
- | "ExternalEditor": "C:/bbs/doors/oedit.bat", | ||
- | "SSHRSAKey": "C:/bbs/keys/ssh_host_rsa_key", | ||
- | "SSHDSAKey": "C:/bbs/keys/ssh_host_dsa_key", | ||
- | "LogFile": "C:/bbs/logs/Titan.log", | ||
- | "MailSemaphore": "C:/bbs/mail.out" | ||
- | }, | ||
- | "MessageBases": [ | ||
- | { | ||
- | "name": "General", | ||
- | "id": 0 | ||
- | }, | ||
- | { | ||
- | "name": "Testing", | ||
- | "id": 1 | ||
- | }, | ||
- | { | ||
- | "name": "General", | ||
- | "id": 100 | ||
- | }, | ||
- | { | ||
- | "name": "BBS Discussion", | ||
- | "id": 101 | ||
- | }, | ||
- | { | ||
- | "name": "Mystic Discussion", | ||
- | "id": 102 | ||
- | }, | ||
- | { | ||
- | "name": "Magicka Discussion", | ||
- | "id": 103 | ||
- | }, | ||
- | { | ||
- | "name": "ENiGMA 1/2 Discussion", | ||
- | "id": 104 | ||
- | }, | ||
- | { | ||
- | "name": "Cryptographic Posts", | ||
- | "id": 105 | ||
- | }, | ||
- | { | ||
- | "name": "Automated RoBOT Posts", | ||
- | "id": 106 | ||
- | } | ||
- | ], | ||
- | "MessageConferences": [ | ||
- | { | ||
- | "name": "Local Mail", | ||
- | "id": 0, | ||
- | "areas": [ 0, 1 ] | ||
- | }, | ||
- | { | ||
- | "name": "FSXNet", | ||
- | "id": 2, | ||
- | "areas": [ 100, 101, 102, 103, 104, 105, 106 ] | ||
- | } | ||
- | ], | ||
- | "Doors": [ | ||
- | { | ||
- | "name": "Galactic Dynasty", | ||
- | "hotkey": "1", | ||
- | "command": "C:/bbs/doors/gd.bat" | ||
- | }, | ||
- | { | ||
- | "name": "For Honour", | ||
- | "hotkey": "2", | ||
- | "command": "C:/bbs/doors/fh.bat" | ||
- | } | ||
- | ], | ||
- | "FileBases": [ | ||
- | { | ||
- | "index": 1, | ||
- | "name": "General Files", | ||
- | "filepath": "C:/bbs/files/general", | ||
- | "database": "C:/bbs/files/general.db3" | ||
- | }, | ||
- | { | ||
- | "index": 2, | ||
- | "name": "BBS Related Files", | ||
- | "filepath": "C:/bbs/files/bbs", | ||
- | "database": "C:/bbs/files/bbs.db3" | ||
- | } | ||
- | ], | ||
- | "TextFiles": [ | ||
- | { | ||
- | "title": "AF Downs Scores", | ||
- | "filepath": "C:/bbs/doors/afdowns2/scores.txt", | ||
- | "pause": "true", | ||
- | "hotkey": "1" | ||
- | }, | ||
- | { | ||
- | "title": "AF Slots Scores", | ||
- | "filepath": "C:/bbs/doors/afslots2/scores.txt", | ||
- | "pause": "true", | ||
- | "hotkey": "2" | ||
- | } | ||
- | ] | ||
- | } | ||