Both sides previous revisionPrevious revision | Last revisionBoth sides next revision |
util:scfg:system [2024/03/03 14:55] – [Security Options] Updated, added a table of (some of) the setting descriptions digital man | util:scfg:system [2024/03/08 18:52] – [Loadable Modules] Updated for v3.20 digital man |
---|
- 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"): | |
| |
^ Option Name ^ Default ^ Description ^ | |
| Read Mail | ''msglist mail -preview'' | Executed when a user reads personal email/netmail. | | | Read Mail | ''msglist mail -preview'' | 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 | |
| | List Nodes | ''[[module:nodelist]]'' | Executed when a user lists the current status of all nodes. | |
| Who's Online | ''nodelist -active'' | Executed when a user lists the nodes in-use (i.e., %%^%%U). | | | Who's Online | ''nodelist -active'' | Executed when a user lists the nodes in-use (i.e., %%^%%U). | |
| Private Msg | [[module:privatemsg|privatemsg]] | Executed when a user sends a private node msg (i.e., %%^%%P). | | | 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 ===== | ===== Security Options ===== |