Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
util:scfg:system [2022/02/20 16:19] – [Loadable Modules] Forgot to add all the module internal links. Andreutil:scfg:system [2024/03/24 20:58] (current) – [Toggle Options] add new Spinning Cursor at Pause Prompts options (moved from Node Configuration) digital man
Line 5: Line 5:
 ===== Main Window Options ===== ===== Main Window Options =====
 <code> <code>
-══════════════════════════════════════════════════════════════════════╗ +╔═════════════════════════════════════╗ 
-║                         System Configuration                         ║ +║         System Configuration        ║ 
-══════════════════════════════════════════════════════════════════════╣ +╠═════════════════════════════════════╣ 
-║ │BBS Name                         My BBS                             ║ +║ │BBS Name            My BBS         ║ 
-║ │Location                         My City, State                     ║ +║ │Location            My City, State ║ 
-║ │Local Time Zone                  UTC                                ║ +║ │Local Time Zone     UTC            ║ 
-║ │Operator                         Sysop                              ║ +║ │Local Date Format   MM/DD/YY       ║ 
-║ │Password                         **********                         ║ +║ │Operator            Sysop          ║ 
-║ │Users Can Change Password        Yes, 4 chars minimum               ║ +║ │Notifications...                   ║ 
-║ │Days to Preserve Deleted Users   14                                 ║ +║ │Toggle Options...                  ║ 
-║ │Maximum Days of Inactivity       180                                ║ +║ │New User Values...                 ║ 
-║ │New User Password                                                   ║ +║ │New User Prompts...                ║ 
-║ │Toggle Options...                                                   ║ +║ │Security Options...                ║ 
-║ │New User Values...                                                  ║ +║ │Advanced Options...                ║ 
-║ │Advanced Options...                                                 ║ +║ │Loadable Modules...                ║ 
-║ │Loadable Modules...                                                 ║ +╚═════════════════════════════════════╝ 
-║ │Security Level Values...                                            ║ +
-║ │Expired Account Values...                                           ║ +
-║ │Quick-Validation Values...                                          ║ +
-══════════════════════════════════════════════════════════════════════╝+
 </code> </code>
  
Line 40: Line 37:
 ===== Toggle Options ===== ===== Toggle Options =====
 <code> <code>
-╔═══════════════════════════════════════╗ +═════════════════════════════════════════╗ 
-║             Toggle Options            ║ +║              Toggle Options             ║ 
-╠═══════════════════════════════════════╣ +═════════════════════════════════════════╣ 
-║ │Allow User Aliases               Yes ║ +║ │Allow User Aliases                 Yes ║ 
-║ │Allow Time Banking               No  ║ +║ │Allow Time Banking                 No  ║ 
-║ │Allow Credit Conversions         Yes ║ +║ │Allow Credit Conversions           Yes ║ 
-║ │Allow Sysop Logins               Yes ║ +║ │Short Sysop Page                   No  ║ 
-║ │Display/Log Passwords Locally    Yes ║ +║ │Include Sysop in Statistics        No  ║ 
-║ │Short Sysop Page                 No  ║ +║ │Use Location in User Lists         Yes ║ 
-║ │Include Sysop in Statistics      No  ║ +║ │Military (24 hour) Time Format     No  ║ 
-║ │Closed to New Users              No  ║ +║ │Display Sys Info During Logon      Yes ║ 
-║ │Use Location in User Lists       Yes ║ +║ │Display Node List During Logon     Yes ║ 
-║ │Military (24 hour) Time Format   No  ║ +║ │Mouse Hot-spots in Menus/Prompts   Yes ║ 
-║ │European Date Format (DD/MM/YY)  No  ║ +║ │Spinning Cursor at Pause Prompts   Yes ║ 
-║ │User Expires When Out-of-time    No  ║ +═════════════════════════════════════════╝
-║ │Require Sys Pass During Login    Yes ║ +
-║ │Display Sys Info During Logon    Yes ║ +
-║ │Display Node List During Logon   Yes ║ +
-╚═══════════════════════════════════════╝+
 </code> </code>
  
Line 67: Line 60:
 | Allow Time Banking | No | Allow users to deposit any extra time they may have left during a call into their [[access:minutes|minute bank]]. If this option is set to No, then the only way a user may get minutes in their minute bank is to purchase them with credits. | | Allow Time Banking | No | Allow users to deposit any extra time they may have left during a call into their [[access:minutes|minute bank]]. If this option is set to No, then the only way a user may get minutes in their minute bank is to purchase them with credits. |
 | Allow Credit Conversions | Yes | Allow users to convert any [[access:credits|credits]] they may have into minutes for their minute bank. | | Allow Credit Conversions | Yes | Allow users to convert any [[access:credits|credits]] they may have into minutes for their minute bank. |
-| Allow Sysop Logins | Yes | Allow users with system operator access to login. FIXME How otherwise? Why wouldn't this be allowed? | 
-| Display/Log Passwords Locally | Yes | Displays passwords locally and logs them to disk (e.g., when there's a failed login attempt). \\ \\ For [[howto:hardening|elevated security]], set this option to No. | 
 | Short Sysop Page | No | Audibly page the sysop with a short series of beeps instead of continuous random tones. | | Short Sysop Page | No | Audibly page the sysop with a short series of beeps instead of continuous random tones. |
 | Include Sysop in Statistics | No | Include sysops in the statistical data of the BBS. The suggested setting for this option is No so that statistical data will only reflect user usage and not include sysop maintenance activity. | | Include Sysop in Statistics | No | Include sysops in the statistical data of the BBS. The suggested setting for this option is No so that statistical data will only reflect user usage and not include sysop maintenance activity. |
-| Closed to New Users | No | Prevent callers from logging on as New and creating a new user. | 
 | Use Location in User Lists | Yes | Display user locations (city, state) in the user lists. If this option is set to No, the user notes (if they exist) are displayed instead. | | Use Location in User Lists | Yes | Display user locations (city, state) in the user lists. If this option is set to No, the user notes (if they exist) are displayed instead. |
 | Military (24 hour) Time Format | No | Display and enter time of day in 24-hour format. | | Military (24 hour) Time Format | No | Display and enter time of day in 24-hour format. |
-| European Date Format (DD/MM/YY) | No | Display and enter dates in DD/MM/YY format instead of MM/DD/YY format. | 
-| User Expires When Out-of-time | No | Set users to Expired Account Values (configured elsewhere in the System menu) immediately if they run out of time while logged in. They will be logged out at their next action. FIXME <-- this is true enough, right? | 
-| Require Sys Pass During Login | Yes | Require the system password, along with the sysop's personal user account password, immediately when a system operator is logging in. | 
 | Display Sys Info During Logon | Yes | Display system information during logon. | | Display Sys Info During Logon | Yes | Display system information during logon. |
 | Display Node List During Logon | Yes | Display the active nodes during logon. | | Display Node List During Logon | Yes | Display the active nodes during logon. |
 +| Mouse Hot-spots in Menus/Prompts | Yes | Enable [[howto:mouse]] hot-spots in the BBS menus and prompts. |
 +| Spinning Cursor at Pause Prompts | Yes | Display a spinning cursor at the ''[Hit a key]'' prompt |
 ===== New User Values ===== ===== New User Values =====
 <code> <code>
-══════════════════════════════════════════════════════════╗ +╔════════════════════════════════════════╗ 
-║                      New User Values                     ║ +║             New User Values            ║ 
-══════════════════════════════════════════════════════════╣ +╠════════════════════════════════════════╣ 
-║ │Level                      50                           ║ +║ │Level                      50         ║ 
-║ │Flag Set #1                                             ║ +║ │Flag Set #1                           ║ 
-║ │Flag Set #2                                             ║ +║ │Flag Set #2                           ║ 
-║ │Flag Set #3                                             ║ +║ │Flag Set #3                           ║ 
-║ │Flag Set #4                                             ║ +║ │Flag Set #4                           ║ 
-║ │Exemptions                                              ║ +║ │Exemptions                            ║ 
-║ │Restrictions                                            ║ +║ │Restrictions                          ║ 
-║ │Expiration Days            0                            ║ +║ │Expiration Days            0          ║ 
-║ │Credits                    10,485,760                   ║ +║ │Credits                    10,485,760 ║ 
-║ │Minutes                    0                            ║ +║ │Minutes                    0          ║ 
-║ │Editor                     FSEDITOR                     ║ +║ │Editor                     FSEDITOR   ║ 
-║ │Command Shell              DEFAULT                      ║ +║ │Command Shell              DEFAULT    ║ 
-║ │Download Protocol          Z                            ║ +║ │Download Protocol          Z          ║ 
-║ │Days of New Messages                                  ║ +║ │Days of New Messages                ║ 
-║ │Gender Options             MFX                          ║ +║ │Gender Options             MFX        ║ 
-║ │Default Toggles...                                      ║ +║ │Default Toggles...                    ║ 
-║ │Question Toggles...                                     ║ +║ │QWK Packet Settings...                ║ 
-══════════════════════════════════════════════════════════╝+╚════════════════════════════════════════╝
 </code> </code>
  
Line 144: Line 133:
 ║ │Hot Keys                    Yes ║ ║ │Hot Keys                    Yes ║
 ║ │Auto Hang-up After Xfer     No  ║ │Auto Hang-up After Xfer     No 
 +║ │Multinode Chat Echo         No 
 +║ │Multinode Chat Actions      No  ║
 +║ │Pageable for Chat           Yes ║
 +║ │Node Activity Messages      Yes ║
 +║ │Split-Screen Private Chat   Yes ║
 ╚══════════════════════════════════╝ ╚══════════════════════════════════╝
 </code> </code>
Line 166: Line 160:
 <code> <code>
 ╔══════════════════════════════════╗ ╔══════════════════════════════════╗
-║        New User Questions        +║    New User Questions/Prompts    
 ╠══════════════════════════════════╣ ╠══════════════════════════════════╣
 ║ │Real Name                   Yes ║ ║ │Real Name                   Yes ║
Line 175: Line 169:
 ║ │Force Unique Handle / Call  Yes ║ ║ │Force Unique Handle / Call  Yes ║
 ║ │E-mail/NetMail Address      Yes ║ ║ │E-mail/NetMail Address      Yes ║
 +║ │Force Unique E-mail/NetMail No  ║
 ║ │Sex (Gender)                Yes ║ ║ │Sex (Gender)                Yes ║
 ║ │Birthday                    Yes ║ ║ │Birthday                    Yes ║
Line 191: Line 186:
 This menu allows you to decide which questions will be asked of a new user when they're creating their account. This menu allows you to decide which questions will be asked of a new user when they're creating their account.
  
-^ Option Name                ^ Default ^ Description ^ +^ Option Name                 ^ Default ^ Description ^ 
-| Real Name                  | Yes     | Ask new user for their real name. | +| Real Name                   | Yes     | Ask new user for their real name. | 
-| Force Unique Real Name     | Yes     | Require real name and ensure that there isn't already a user with the same real name. | +| Force Unique Real Name      | Yes     | Require real name and ensure that there isn't already a user with the same real name. | 
-| Force Upper/Lower Case     | Yes     | Require that all names/locations are capitalized. | +| Force Upper/Lower Case      | Yes     | Require that all names/locations are capitalized. | 
-| Company Name               | No      | When user alias are **not** allowed, optionally use the real name field to store a company name. | +| Company Name                | No      | When user alias are **not** allowed, optionally use the real name field to store a company name. | 
-| Chat Handle / Call Sign    | Yes     | Ask new user their nickname for chat or [[https://en.wikipedia.org/wiki/Amateur_radio_call_signs|Amateur Radio callsign]]. | +| Chat Handle / Call Sign     | Yes     | Ask new user their nickname for chat or [[https://en.wikipedia.org/wiki/Amateur_radio_call_signs|Amateur Radio callsign]]. | 
-| Force Unique Handle / Call | Yes     | Require handle/call and ensure that another user doesn't have that handle/call already. | +| Force Unique Handle / Call  | Yes     | Require handle/call and ensure that another user doesn't have that handle/call already. | 
-| E-mail/NetMail Address     | Yes     | Internet email or direct [[ref:fidonet|NetMail]] address. | +| E-mail/NetMail Address      | Yes     | Internet email or direct [[ref:fidonet|NetMail]] address. | 
-| Sex (Gender)               | Yes     | Ask new user to identify their gender. | +| Force Unique E-mail/NetMail | No      | Prevent new users from using the same email address as an existing user. | 
-| Birthday                   | Yes     | Ask new user their date of birth. +| Sex (Gender)                | Yes     | Ask new user to identify their gender. | 
-| Address and Zip Code       | No      | Ask new user their address and zip/postal code. | +| Birthday                    | Yes     | Ask new user their date of birth. 
-| Location                   | Yes     | Short location sometimes displayed next to a user's name. Typically a city and state. | +| Address and Zip Code        | No      | Ask new user their address and zip/postal code. | 
-| Require Comma in Location  | No      | Force comma in the location as an attempt at forcing both a city and state. | +| Location                    | Yes     | Short location sometimes displayed next to a user's name. Typically a city and state. | 
-| Phone Number               | No      | Ask new user their phone number. | +| Require Comma in Location   | No      | Force comma in the location as an attempt at forcing both a city and state. | 
-| Allow EX-ASCII in Answers  | Yes     | Allow the use of [[https://en.wikipedia.org/wiki/Extended_ASCII|Extended ASCII]] characters in user strings. | +| Phone Number                | No      | Ask new user their phone number. | 
-| External Editor            | No      | Ask if the user prefers a [[howto:editor:index|full screen editor]] when composing messages. | +| Allow EX-ASCII in Answers   | Yes     | Allow the use of [[https://en.wikipedia.org/wiki/Extended_ASCII|Extended ASCII]] characters in user strings. | 
-| Command Shell              | Yes     | Ask which [[custom:command_shell|Command Shell]] the user prefers. | +| External Editor             | No      | Ask if the user prefers a [[howto:editor:index|full screen editor]] when composing messages. | 
-| Default Settings           | Yes     | Display to new user their default settings and allow them to make changes. | +| Command Shell               | Yes     | Ask which [[custom:command_shell|Command Shell]] the user prefers. | 
-| Color Terminal             | No      | Ask new users if they are using a color terminal. |+| Default Settings            | Yes     | Display to new user their default settings and allow them to make changes. | 
 +| Color Terminal              | No      | Ask new users if they are using a color terminal. |
 ===== Advanced Options ===== ===== Advanced Options =====
 <code> <code>
-══════════════════════════════════════════════════════════╗ +╔══════════════════════════════════════════╗ 
-║                     Advanced Options                     ║ +║             Advanced Options             ║ 
-══════════════════════════════════════════════════════════╣ +╠══════════════════════════════════════════╣ 
-║ │New User Magic Word                                     ║ +║ │New User Magic Word                     ║ 
-║ │Data Directory             ../data/                     ║ +║ │Data Directory             ../data/     ║ 
-║ │Logs Directory             ../data/                     ║ +║ │Logs Directory             ../data/     ║ 
-║ │Exec Directory             ../exec/                     ║ +║ │Exec Directory             ../exec/     ║ 
-║ │Mods Directory             ../mods/                     ║ +║ │Mods Directory             ../mods/     ║ 
-║ │Input SIF Questionnaire                                 ║ +║ │Input SIF Questionnaire                 ║ 
-║ │Output SIF Questionnaire                                ║ +║ │Output SIF Questionnaire                ║ 
-║ │Credits Per Dollar         2,097,152                    ║ +║ │Credits Per Dollar         2,097,152    ║ 
-║ │Minutes Per 100k Credits                              ║ +║ │Minutes Per 100K Credits              ║ 
-║ │Maximum Number of Minutes  Unlimited                    ║ +║ │Maximum Number of Minutes  Unlimited    ║ 
-║ │Warning Days Till Expire   30                           ║ +║ │Warning Days Till Expire   30           ║ 
-║ │Last Displayable Node      250                          ║ +║ │Last Displayable Node      250          ║ 
-║ │Phone Number Format        !!!!!!!!!!!!                 ║ +║ │Phone Number Format        !!!!!!!!!!!! ║ 
-║ │Sysop Chat Override                                     ║ +║ │Sysop Chat Override                     ║ 
-║ │User Database Backups      5                            ║ +║ │User Database Backups      5            ║ 
-║ │Mail Database Backups      5                            ║ +║ │Mail Database Backups      5            ║ 
-║ │Control Key Pass-through                              ║ +║ │Configuration Backups      5            ║ 
-══════════════════════════════════════════════════════════╝+║ │Maximum Log File Size      Unlimited    ║ 
 +║ │Maximum User Inactivity    5 minutes    ║ 
 +║ │User Inactivity Warning    75 percent   ║ 
 +║ │Control Key Pass-through              ║ 
 +╚══════════════════════════════════════════╝ 
 </code> </code>
  
 Care should be taken when modifying any of the options listed here. Care should be taken when modifying any of the options listed here.
 +
 +**Note:** For the directories, forward slashes will work in Windows and are preferred over backslashes as they will work cross-platform.
  
 ^ Option Name ^ Default ^ Description ^ ^ Option Name ^ Default ^ Description ^
 | New User Magic Word | <empty> | If this field has a value, it is assumed the sysop has placed some reference to this magic word in text/newuser.msg and new users will be prompted for the magic word after they enter their password. If they do not enter it correctly, it is assumed they didn't read the new user information displayed to them and they are disconnected. \\ \\ Think of it as a password to guarantee that new users read the text displayed to them. | | New User Magic Word | <empty> | If this field has a value, it is assumed the sysop has placed some reference to this magic word in text/newuser.msg and new users will be prompted for the magic word after they enter their password. If they do not enter it correctly, it is assumed they didn't read the new user information displayed to them and they are disconnected. \\ \\ Think of it as a password to guarantee that new users read the text displayed to them. |
-| Data Directory | ../data | The Synchronet [[dir:data|data directory]] contains almost all the data for your BBS. This directory must be located where **all** nodes can access it and **must not** be placed on a RAM disk or other volatile media. \\ \\ This option allows you to change the location of your data directory. FIXME <-- still forward slash for winodws?|+| Data Directory | ../data | The Synchronet [[dir:data|data directory]] contains almost all the data for your BBS. This directory must be located where **all** nodes can access it and **must not** be placed on a RAM disk or other volatile media. \\ \\ This option allows you to change the location of your data directory. |
 | Logs Directory | ../data | Log files will be stored in this directory. \\ \\ By default, this is set to the same as your Data File directory. | | Logs Directory | ../data | Log files will be stored in this directory. \\ \\ By default, this is set to the same as your Data File directory. |
 | Exec Directory | ../exec | The Synchronet [[dir:exec|exec directory]] contains program and script files that the BBS executes. This directory does not need to be in your OS search path. \\ \\ If you place programs in this directory for the BBS to execute, you should place the %! specifier for the exec directory at the beginning of the configured command-lines. \\ \\ This option allows you to change the location of your exec directory. | | Exec Directory | ../exec | The Synchronet [[dir:exec|exec directory]] contains program and script files that the BBS executes. This directory does not need to be in your OS search path. \\ \\ If you place programs in this directory for the BBS to execute, you should place the %! specifier for the exec directory at the beginning of the configured command-lines. \\ \\ This option allows you to change the location of your exec directory. |
 | Mods Directory | ../mods | This optional [[dir:mods|mods directory]] can be used to specify a location where modified module files are stored. These modified modules will take precedence over modules with the same filename (in the exec directory) and will not be overwritten by future updates/upgrades. \\ \\ Sub-directory searches of this directory also take precedence (e.g. mods/load/* overrides exec/load/*). \\ \\ If this directory is blank, then this feature is not used and all modules are assumed to be located in the exec directory. | | Mods Directory | ../mods | This optional [[dir:mods|mods directory]] can be used to specify a location where modified module files are stored. These modified modules will take precedence over modules with the same filename (in the exec directory) and will not be overwritten by future updates/upgrades. \\ \\ Sub-directory searches of this directory also take precedence (e.g. mods/load/* overrides exec/load/*). \\ \\ If this directory is blank, then this feature is not used and all modules are assumed to be located in the exec directory. |
 | Input SIF Questionnaire | <empty> | This is the name of a [[https://www.synchro.net/docs/customization.html#SIFQuestionnaireFile|SIF questionnaire]] file that resides your [[dir:text|text directory]] that all users will be prompted to answer when creating their new user account. | | Input SIF Questionnaire | <empty> | This is the name of a [[https://www.synchro.net/docs/customization.html#SIFQuestionnaireFile|SIF questionnaire]] file that resides your [[dir:text|text directory]] that all users will be prompted to answer when creating their new user account. |
-| Output SIF Questionnaire | <empty> | This is the SIF file used when the Sysop reviews the questionnaire answers from the user edit function (;UEDIT), the purpose of which is to remove any text other than the question and answersFIXME <-- Is that correct? FIXME If no output SIF is specified, the input SIF questionnaire is used. |+| Output SIF Questionnaire | <empty> | This is the SIF file used when the Sysop reviews the questionnaire answers from the user edit function (;UEDIT). If no output SIF is specified, the input SIF questionnaire is used. |
 | Credits Per Dollar | 2,097,152 | This is the monetary value of a credit (How many credits per dollar). This value should be a power of 2 (1, 2, 4, 8, 16, 32, 64, 128, etc.) since credits are usually converted in 100 kibibyte (102400) blocks. To make a dollar worth two mebibytes of credits, set this value to 2,097,152 (a mebibyte is 1024*1024 or 1048576). | | Credits Per Dollar | 2,097,152 | This is the monetary value of a credit (How many credits per dollar). This value should be a power of 2 (1, 2, 4, 8, 16, 32, 64, 128, etc.) since credits are usually converted in 100 kibibyte (102400) blocks. To make a dollar worth two mebibytes of credits, set this value to 2,097,152 (a mebibyte is 1024*1024 or 1048576). |
 | Minutes Per 100k Credits | 6 | This is the value of a minute of time online. This field is the number of minutes to give the user in exchange for each 100K credit block. | | Minutes Per 100k Credits | 6 | This is the value of a minute of time online. This field is the number of minutes to give the user in exchange for each 100K credit block. |
Line 254: Line 257:
 | User Database Backups | 5 | Setting this option to anything but 0 will enable automatic daily backups of the user database. This number determines how many backups to keep on disk. | | User Database Backups | 5 | Setting this option to anything but 0 will enable automatic daily backups of the user database. This number determines how many backups to keep on disk. |
 | Mail Database Backups | 5 | Setting this option to anything but 0 will enable automatic daily backups of the mail database. This number determines how many backups to keep on disk. | | Mail Database Backups | 5 | Setting this option to anything but 0 will enable automatic daily backups of the mail database. This number determines how many backups to keep on disk. |
 +| Maximum Log File Size | Unlimited | This option allows you to limit the size of the following log files created and appended to by Synchronet in the logs directory (inside the [[dir:data|data directory]]): \\ \\ hungup.log; error.log; crash.log; hack.log; spam.log; guru.log \\ \\ The largest supported log file size limit is 4294967295 (3.99G) bytes. Log files that have reached or exceeded the configured size limit are retained by renaming the *.log file to *.#.log beginning with *.0.log. \\ \\ You must also specify the number of older/max-size log files to retain. The largest number of supported retained rotated log files is 9999. Oldest rotated log files are automatically deleted to save disk space. |
 | Control Key Pass-through | 0 | This value is a 32-bit hexadecimal number. Each set bit represents a control key combination that will not be handled internally by Synchronet or by a Global Hot Key Event. \\ \\ To disable internal handling of the Ctrl-C key combination (for example) set this value to 8. The value is determined by calculating 2<sup>n</sup>, where //n// is the ASCII value of the control character (Ctrl-A is 1, Ctrl-B is 2, etc.). In the case of Ctrl-C (n=3), 2<sup>3</sup>=8. \\ \\ To pass-through multiple control key combinations, multiple bits must be set (or'd together) to create the necessary value, which may require the use of a hexadecimal calculator. \\ \\ If unsure, leave this value set to 0, the default. | | Control Key Pass-through | 0 | This value is a 32-bit hexadecimal number. Each set bit represents a control key combination that will not be handled internally by Synchronet or by a Global Hot Key Event. \\ \\ To disable internal handling of the Ctrl-C key combination (for example) set this value to 8. The value is determined by calculating 2<sup>n</sup>, where //n// is the ASCII value of the control character (Ctrl-A is 1, Ctrl-B is 2, etc.). In the case of Ctrl-C (n=3), 2<sup>3</sup>=8. \\ \\ To pass-through multiple control key combinations, multiple bits must be set (or'd together) to create the necessary value, which may require the use of a hexadecimal calculator. \\ \\ If unsure, leave this value set to 0, the default. |
  
 ===== Loadable Modules ===== ===== Loadable Modules =====
 <code> <code>
-╔══════════════════════════════════════╗ +════════════════════════════════════════╗ 
-║           Loadable Modules           ║ +║            Loadable Modules            ║ 
-╠══════════════════════════════════════╣ +════════════════════════════════════════╣ 
-║ │Login           login               ║ +║ │Login           login                 ║ 
-║ │Logon           logon               ║ +║ │Logon           logon                 ║ 
-║ │Sync                                ║ +║ │Sync                                  ║ 
-║ │Logoff                              ║ +║ │Logoff                                ║ 
-║ │Logout                              ║ +║ │Logout                                ║ 
-║ │New User        newuser             ║ +║ │New User        newuser               ║ 
-║ │Expired User                        ║ +║ │User Config     user_settings         ║ 
-║ │Auto Message    automsg             ║ +║ │Expired User                          ║ 
-║ │Text Section    text_sec            ║ +║ │Auto Message    automsg               ║ 
-║ │Xtrn Section    xtrn_sec            ║ +║ │Send Feedback                         ║ 
-║ │Pre Xtrn        prextrn             ║ +║ │Chat Section    chat_sec              ║ 
-║ │Post Xtrn       postxtrn            ║ +║ │Text Section    text_sec              ║ 
-║ │Read Mail       msglist mail -previe║ +║ │Xtrn Section    xtrn_sec              ║ 
-║ │Scan Msgs                           ║ +║ │Pre Xtrn        prextrn               ║ 
-║ │Scan Subs                           ║ +║ │Post Xtrn       postxtrn              ║ 
-║ │List Msgs       msglist             ║ +║ │Read Mail       msglist mail -preview ║ 
-║ │List Logons     logonlist           ║ +║ │Scan Msgs                             ║ 
-║ │List Nodes      nodelist            ║ +║ │Scan Subs                             ║ 
-║ │Who's Online    nodelist -active    ║ +║ │List Msgs       msglist               ║ 
-║ │Private Msg     privatemsg          ║ +║ │List Logons     logonlist             ║ 
-║ │Temp Transfer   tempxfer            ║ +║ │List Users      userlist              ║ 
-╚══════════════════════════════════════╝+║ │List Nodes      nodelist              ║ 
 +║ │Who's Online    nodelist -active      ║ 
 +║ │Private Msg     privatemsg            ║ 
 +║ │Scan Dirs                             ║ 
 +║ │List Files                            ║ 
 +║ │View File Info                        ║ 
 +║ │Batch Transfer                        ║ 
 +║ │Temp Transfer   tempxfer              ║ 
 +════════════════════════════════════════╝ 
 </code> </code>
  
Line 293: Line 306:
   - Exec folder: Baja module   - Exec folder: Baja module
  
-For these modules, only the name of the file is accepted as an SCFG configuration value (no .js or .bin file extension):+For all modules, additional command-line options/switches can be added when the module accepts them (e.g., ''nodelist -active''): 
  
 ^ Option Name   ^ Default ^ Description ^ ^ Option Name   ^ Default ^ Description ^
-| Login | [[module:login|login]] | Required module for interactive [[server:terminal]] logins. Occurs when a user is connected, immediately after the Synchronet copyright notice is displayed. Successful autologins (e.g., SSH, rlogin) will not display this module. | +| Login | ''[[module:login]]'' | Required module for interactive [[server:terminal]] logins. Occurs when a user is connected, immediately after the Synchronet copyright notice is displayed. Successful autologins (e.g., SSH, rlogin) will not display this module. | 
-| Logon | [[module:logon|logon]] | Executed during terminal logon procedure, immediately after a successful login (both autologin or using the Login module above. |+| Logon | ''[[module:logon]]'' | Executed during terminal logon procedure, immediately after a successful login (both autologin or using the Login module above. |
 | Sync | <empty> | Executed when terminal nodes are periodically synchronized (e.g., when node messages are received, node status is read, etc. while a user is online). | | Sync | <empty> | Executed when terminal nodes are periodically synchronized (e.g., when node messages are received, node status is read, etc. while a user is online). |
 | Logoff | <empty> | Executed during terminal logoff procedure (interactive). Does **not** occur when users hang up on the BBS or do a fast logoff. | | Logoff | <empty> | Executed during terminal logoff procedure (interactive). Does **not** occur when users hang up on the BBS or do a fast logoff. |
 | Logout | <empty> | Executed during terminal logout procedure (offline) after a user has disconnected from the BBS, either by logging off or hanging up. | | Logout | <empty> | Executed during terminal logout procedure (offline) after a user has disconnected from the BBS, either by logging off or hanging up. |
-| New User | [[module:newuser|newuser]] | Executed at end of new terminal user creation process (i.e., after the user has logged on, left new user feedback, and anything else that is required of a new user). |+| New User | ''[[module:newuser]]'' | Executed at end of new terminal user creation process (i.e., after the user has logged on, left new user feedback, and anything else that is required of a new user). 
 +| User Config | ''[[module:user_settings]]'' | User (e.g. terminal) settings configuration menu |
 | Expired User | <empty> | Executed before hanging up on a user that has run out of minutes, and during the daily maintenance event if a user has expired for another reason (e.g., deleted, inactive). FIXME link to the daily maintenance event once scfg->xtrn is done. | | Expired User | <empty> | Executed before hanging up on a user that has run out of minutes, and during the daily maintenance event if a user has expired for another reason (e.g., deleted, inactive). FIXME link to the daily maintenance event once scfg->xtrn is done. |
-| Auto Message | automsg | Executed when a user chooses to edit the [[https://www.synchro.net/docs/user.html#AutoMessage|auto-message]]. | +| Auto Message | ''[[module:automsg]]'' | Executed when a user chooses to edit the [[https://www.synchro.net/docs/user.html#AutoMessage|auto-message]]. 
-| Text Section | text_sec | Executed to handle the [[https://www.synchro.net/docs/textfile_section.html|text file]] (viewing) section. | +| Send Feedback | <empty> | User sending email to a sysop (return error to cancel) | 
-| Xtrn Section | xtrn_sec | Executed to handle the external programs ([[howto:door:index|doors]]) section. | +| Chat Section | ''[[module:chat_sec]]'' | User enters chat section/menu 
-| Pre Xtrn | prextrn | Executed once an external program is configured to run or selected by a user, but before the actual program has started. | +| Text Section | ''[[module:text_sec]]'' | Executed to handle the [[https://www.synchro.net/docs/textfile_section.html|text file]] (viewing) section. | 
-| Post Xtrn | postxtrn | Executed after an external program has finished running. | +| Xtrn Section | ''[[module:xtrn_sec]]'' | Executed to handle the external programs ([[howto:door:index|doors]]) section. | 
-| Temp Transfer | tempxfer | Temporary/archive file transfer menu, where users can [[https://www.synchro.net/docs/user.html#FileExtraction/TempDirectory|extract file archives]] to download only the files they want. |  +| Pre Xtrn | ''[[module:prextrn]]'' | Executed once an external program is configured to run or selected by a user, but before the actual program has started. | 
- +| Post Xtrn | ''[[module:postxtrn]]'' | Executed after an external program has finished running. | 
-For these modules, additional switches can be added when the module accepts them (e.g., "nodelist -active", "DDReadPersonalMail -chooseAreaFirst"): +| Read Mail     ''msglist mail -preview'' | Executed when a user reads personal email/netmail. |
- +
-^ Option Name   ^ Default                 ^ Description ^ +
-| Read Mail     <code>msglist mail -preview</code> | Executed when a user reads personal email/netmail. |+
 | Scan Msgs     | <empty>               | Executed when a user reads or scans messages within a single sub-board. | | Scan Msgs     | <empty>               | Executed when a user reads or scans messages within a single sub-board. |
 | Scan Subs     | <empty>               | Executed when a user scans one or more sub-boards for messages. | | Scan Subs     | <empty>               | Executed when a user scans one or more sub-boards for messages. |
-| List Msgs     | [[module:msglist|msglist]]               | Executed when a user lists messages from the message read prompt. | +| List Msgs     ''[[module:msglist]]''               | Executed when a user lists messages from the message read prompt. | 
-| List Logons   | [[module:logonlist|logonlist]]             | Executed when a user lists logons ('-y' for yesterday). | +| List Logons   ''[[module:logonlist]]''             | Executed when a user lists logons ('-y' for yesterday). 
-| List Nodes    | [[module:nodelist|nodelist]]              | Executed when a user lists the current status of all nodes. | +| List Users    | ''[[module:userlist]]''              | User lists the users of the system 
-| Who's Online <code>nodelist -active</code> | Executed when a user lists the nodes in-use (i.e., %%^%%U). | +| List Nodes    | ''[[module:nodelist]]''              | Executed when a user lists the current status of all nodes. | 
-| Private Msg   | [[module:privatemsg|privatemsg]]            | Executed when a user sends a private node msg (i.e., %%^%%P). | +| Who's Online ''nodelist -active'' | Executed when a user lists the nodes in-use (i.e., %%^%%U). | 
 +| Private Msg   ''[[module:privatemsg]]''            | Executed when a user sends a private node msg (i.e., %%^%%P). |  
 +| Scan Dirs     | <empty>  | User scans one or more directories for files | 
 +| List Files    | <empty>  | User lists files within a file directory | 
 +| View File Info | <empty> | User views detailed information on files in a directory | 
 +| Batch Transfer | <empty> | Batch file transfer menu | 
 +| Temp Transfer | ''[[module:tempxfer]]'' | Temporary/archive file transfer menu, where users can [[https://www.synchro.net/docs/user.html#FileExtraction/TempDirectory|extract file archives]] to download only the files they want. |  
 + 
 +===== Security Options ===== 
 +<file> 
 +╔══════════════════════════════════════════════════════════════════════╗ 
 +║                           Security Options                           ║ 
 +╠══════════════════════════════════════════════════════════════════════╣ 
 +║ │System Password                  *******                            ║ 
 +║ │Prompt for System Password       At Login and After 15 minutes      ║ 
 +║ │Allow Sysop Access               Yes                                ║ 
 +║ │Allow Login by Real Name         No                                 ║ 
 +║ │Allow Login by User Number       No                                 ║ 
 +║ │Users Can Choose Password        Yes, 4 chars minimum               ║ 
 +║ │Always Prompt for Password       No                                 ║ 
 +║ │Display/Log Passwords Locally    Yes                                ║ 
 +║ │Days to Preserve Deleted Users   14                                 ║ 
 +║ │Maximum Days of User Inactivity  180                                ║ 
 +║ │Open to New Users                Yes                                ║ 
 +║ │User Expires When Out-of-time    No                                 ║ 
 +║ │Security Level Values...                                            ║ 
 +║ │Expired Account Values...                                           ║ 
 +║ │Quick-Validation Values...                                          ║ 
 +╚══════════════════════════════════════════════════════════════════════╝ 
 +</file> 
 + 
 +^ Option Name                     ^ Description ^ 
 +| System Password                 | This is an extra security password may be required for sysop login and sysop functions.  This password should be something not easily guessed and should be kept absolutely confidential.\\ \\ This password must be entered at the Terminal Server ''SY:'' prompt. | 
 +| Prompt for System Password | Require the system password, along with the sysop's personal user account password, immediately when a system operator is logging in. "Allow Sysop Access" must be set to Yes for this setting to take effect. | 
 +| Allow Sysop Access | Allow users with system operator access to perform privileged sysop functions while logged into the BBS. Setting this option to No will prevent users with sysop [[access:level|security level]] from invoking functions that require system-password authentication. Instead, when a sysop function is attempted the request is ignored. \\ \\ This effectively overrides "Require Sys Pass During Login" below. The sysop will still be able to login to the BBS as a normal user, but will not be asked for the system password and will not be able to invoke sysop functions that required the password. \\ \\ This setting also affects the sysop actions available in the [[server:ftp|FTP server]] when authenticating with <user-pass>:<system-pass> as the password. The sysop user can still authenticate and login, but none of the sysop actions will be available to them. | 
 +| Display/Log Passwords Locally | Displays passwords locally and logs them to disk (e.g., when there's a failed login attempt). \\ \\ For [[howto:hardening|elevated security]], set this option to No. | 
 +| Open to New Users | Allow users to logon on as 'New' to create (register) a new user account. | 
 +| User Expires When Out-of-time | Set users to Expired Account Values (configured elsewhere in the System menu) immediately if they run out of time while logged in.  | 
  
 ===== Security Level Values ===== ===== Security Level Values =====
Line 373: Line 423:
 </code> </code>
  
-Here you can modify the corresponding values for that particular [[access:level|security level]] (0-99). These values will be given to **all** users who have the selected security level. Many of these values may be overridden by giving certain users the necessary [[access:exemptions|exemptions]] (if required). For example, the 'T' exemption will exempt a user from any time limitations.+Here you can modify the corresponding values for that particular [[access:level|security level]] (0-99). These values will be given to **all** users who have the selected security level. Many of these values may be overridden by giving certain users the necessary [[access:exemptions|exemptions]] (if required).
  
-^ Option Name          ^ Description ^ +**Note:** Levels 90 through 99 are reserved for sysops and co-sysops.
-| Time Per Day         | Maximum online time per day | +
-| Time Per Call        | Maximum online time per call (logon) | +
-| Calls Per Day        | Maximum number of calls (logons) per day | +
-| Email Per Day        | Maximum number of email sent per day | +
-| Posts Per Day        | Maximum number of posted messages per day | +
-| Lines Per Message    | Maximum number of lines per message | +
-| Free Credits Per Day | Number of free [[access:credits|credits]] awarded per day | +
-| Expire To            | Level or validation set to Expire to | +
-===== Expired Account Values ===== +
-If a user's account expires, the security levels for that account will be modified according to the settings of this menu. The expired account's Security Level  will be set to the value listed on this menu. The Flags and Exemptions listed on this menu will be removed from the account if they are set. The Restrictions listed will be added to the account                                    +
  
 +^ Option Name          ^ Default ^ Description ^
 +| Time Per Day         | 480     | The maximum amount of time (in minutes) that the user will be allowed to be online. See the ''T'' [[access:exemptions|exemption]] flag. Supported values: 0-65535. |
 +| Time Per Call        | 240     | The maximum amount of time (in minutes) that the user will be allowed to be online per connection/call. See the ''T'' [[access:exemptions|exemption]] flag. Supported values: 0-65535. |
 +| Calls Per Day        | 50      | Maximum number of calls/connections per day by the user. See the ''L'' [[access:exemptions|exemption]] flag. Supported values: 0-65535. |
 +| Email Per Day        | 50      | Maximum number of email, including local and network mail (netmail) messages that the user will be able to send per day. See the ''M'' [[access:exemptions|exemption]] flag. Supported values: 0-65535. |
 +| Posts Per Day        | 50      | Maximum number of messages that the user will be allowed to post per day (on sub-boards). Supported values: 0-65535. |
 +| Lines Per Message    | 200     | Limits the length of messages (posts and email) that the user can send. Supported values: 0-65535. |
 +| Free Credits Per Day | 10000K  | The number of free [[access:credits|credits]] that are awarded to users with this security level each day they logon. Free credits do not rollover to the following day. Supported values: 0-4GB. |
 +| Expire To            | Level 0 | A specific level or validation set that users with this security level will be given when the user expires. |
 +===== Expired Account Values =====
 <code> <code>
 ╔══════════════════════════════════════════════════════════╗ ╔══════════════════════════════════════════════════════════╗
Line 400: Line 450:
 ╚══════════════════════════════════════════════════════════╝ ╚══════════════════════════════════════════════════════════╝
 </code> </code>
 +
 +If a user's account expires, the [[access:level|Security Levels]] for that account will be modified according to the settings of this menu. The expired account's Security Level will be set to the value listed in this menu. The [[access:flags|Flags]] and [[access:exemptions|Exemptions]] listed on this menu will be removed from the account if they are set. The [[access:restrictions|Restrictions]] listed will be added to the account.                                     
  
 ^ Option Name           ^ Description ^ ^ Option Name           ^ Description ^
-| Level                 This is the security level automatically given to expired user accounts. | +| Level                 [[access:level|Security Level]] given to expired user accounts.                   
-| Flag Set #1 to Remove | These are the security flags automatically removed when a user account has expired. | +| Flag Set #1 to Remove | [[access:flags|Security Flags]] removed when a user account has expired.          
-| Flag Set #2 to Remove | These are the security flags automatically removed when a user account has expired. | +| Flag Set #2 to Remove | Security Flags removed when a user account has expired.          
-| Flag Set #3 to Remove | These are the security flags automatically removed when a user account has expired. | +| Flag Set #3 to Remove | Security Flags removed when a user account has expired.          
-| Flag Set #4 to Remove | These are the security flags automatically removed when a user account has expired. | +| Flag Set #4 to Remove | Security Flags removed when a user account has expired.          
-| Exemptions to Remove These are the exemptions that are automatically removed from a user account if it expires. | +| Exemptions to Remove [[access:exemptions|Exemptions]] that are removed from a user account when it expires. | 
-| Restrictions to Add   These are the restrictions that are automatically added to a user account if it expires.|+| Restrictions to Add   [[access:restrictions|Restrictions]] that are added to a user account when it expires.   |
  
  
Line 447: Line 499:
 </code> </code>
  
-This is a list of the ten quick-validation sets. These sets are used to quickly set a user's security values ([[access:level|Level]], [[access:flags|Flags]], [[access:exemptions|Exemptions]], [[access:restrictions|Restrictions]], Expiration Date, and [[access:credits|Credits]]) with one key strokeThe user's expiration date may be extended and additional credits may also be added using quick-validation sets.+This is a list of the ten quick-validation sets. These sets are used to quickly set a user's security values ([[access:level|Level]], [[access:flags|Flags]], [[access:exemptions|Exemptions]], [[access:restrictions|Restrictions]], Expiration Date, and [[access:credits|Credits]]) with one keystrokeAlso, the user's expiration date may be extended and additional credits may be added.
  
-From within the User Edit function, a sysop can use the Validate User command and select from this quick-validation list to change a user's security values with very few key-strokes +From within the User Edit function, a sysop can use the Validate User command and select from this quick-validation list to change a user's security values with very few keystrokesThis is done with the 'V' command from the User Editor when logged-in to the BBS (;UEDIT command), or from the user list in [[monitor:gtkmonitor|GtkMonitor]] on Unix systems.
- +
-A user can be quick-validated with the 'V' command from the User Editor when logged-in to the BBS (;UEDIT command), or additionally from the user list in [[monitor:gtkmonitor|GtkMonitor]] on Unix systems.+
  
 ^ Option Name        ^ Description ^ ^ Option Name        ^ Description ^
-| Level              | This is the [[access:level|security level]] given to the validated user. | +| Level              | [[access:level|Security Level]] given to the validated user. | 
-| Flag Set #1        | These are the [[access:flags|security flags]] added to the validated user. | +| Flag Set #1        | [[access:flags|Security Flags]] added to the validated user. | 
-| Flag Set #2        | These are the security flags added to the validated user. | +| Flag Set #2        | Security flags added to the validated user. | 
-| Flag Set #3        | These are the security flags added to the validated user. | +| Flag Set #3        | Security flags added to the validated user. | 
-| Flag Set #4        | These are the security flags added to the validated user. | +| Flag Set #4        | Security flags added to the validated user. | 
-| Exemptions         These are the [[access:exemptions|exemptions]] that are added to the validated user. | +| Exemptions         | [[access:exemptions|Exemptions]] that are added to the validated user. | 
-| Restrictions       These are the [[access:restrictions|restrictions]] that are added to the validated user. | +| Restrictions       | [[access:restrictions|Restrictions]] that are added to the validated user. | 
-| Extend Expiration  | Extend the user'account expiration date by this number of days. | +| Extend Expiration  | Extend the user account expiration date by this number of days. | 
-| Additional Credits | This is the amount additional of [[access:credits|credits]] that will be added to the validated user. |+| Additional Credits | Amount of additional [[access:credits|Credits]] that will be given to the validated user. |
 ===== See Also ===== ===== See Also =====
   * [[:util:scfg:|Synchronet Configuration Utility (SCFG)]]   * [[:util:scfg:|Synchronet Configuration Utility (SCFG)]]
  
-{{tag>}} +{{tag>configure scfg}}
util/scfg/system.1645402797.txt · Last modified: 2022/02/20 16:19 by Andre
Back to top
CC Attribution 4.0 International
Driven by DokuWiki Recent changes RSS feed Valid CSS Valid XHTML 1.0