45 lines
1.6 KiB
Markdown
45 lines
1.6 KiB
Markdown
# Configuration
|
|
|
|
This file contains the information necessary to configure Pyscii-BBS. The default configuration provided will run, but you will likely want to change many of these values.
|
|
|
|
## String Replacements
|
|
Except where noted, these can be used in either the asc page files, or the config strings.
|
|
|
|
* %node%
|
|
- Replaced with the node number of the connected party.
|
|
|
|
### Messages
|
|
* %subject%
|
|
- The message's subject
|
|
* %content%
|
|
- The message's content
|
|
* %date%
|
|
- The date the message was posted
|
|
|
|
## Config.ini Key-Value Pairs
|
|
|
|
* [Main] - Main Configuration Information.
|
|
- Port = The integer value of the port to bind Pyscii BBS to
|
|
- DefaultSplash = The string that will greet users if no splash.asc page exists in the "pages" location
|
|
|
|
* [Auth] - Configuration information related to Authentication and Authorization
|
|
- jsonFile = The string of the json file that holds the user database. This database is expected to follow the user.schema
|
|
|
|
* [Menu#] - Configuration for a menu. Starts with 0
|
|
- Title = The title of the menu, a string.
|
|
- Groups = A list of the groups that can see this menu
|
|
- options = an integer number of the count of options
|
|
- Option# = The option description to display to the user
|
|
- Option#Key = The key to press to use the menu option
|
|
|
|
## Pages
|
|
The pages for the BBS are stored in the "pages" directory.
|
|
|
|
* splash.asc
|
|
- Replaces the "DefaultSplash" Config Key/Value pair.
|
|
- Is shown to the users before login
|
|
|
|
* menu#.asc
|
|
- The default display screen for a given menu.
|
|
- If this does not exist, the menu will be displayed from the configuration in the config.ini file
|