| Both sides previous revisionPrevious revisionNext revision | Previous revision |
| module:tickit [2019/07/30 04:58] – [ctrl/tickit.ini] add missing options and clarifications wkitty42 | module:tickit [2022/03/05 00:39] (current) – Fine tuning on AutoAreas Mewcenary |
|---|
| ====== Tickit ====== | ====== TickIT - FidoNet TIC File Processor ====== |
| |
| Tickit (''[[dir:exec]]/tickit.js'') is a simple incoming TICK (TIC File) processor for Synchronet. | TickIT (''[[dir:exec]]/tickit.js'') is a simple incoming TICK (TIC File) processor for Synchronet. |
| |
| It is configured via the file: ''[[dir:ctrl]]/tickit.ini'' | It is configured via the file: ''[[dir:ctrl]]/tickit.ini'' |
| |
| Managing ''[[dir:ctrl]]/tickit.ini'' may be done manually or via ''[[dir:exec]]/tickitcfg.js''. The preferred method is via [[module:tickitcfg|tickitcfg]] which allows for importing your FDN areas as well as access to global and per area options. | Managing ''[[dir:ctrl]]/tickit.ini'' may be done manually or via ''[[dir:exec]]/tickitcfg.js''. The preferred method is via [[module:tickitcfg|tickitcfg]] which allows for importing your FDN areas as well as access to global and per area options. |
| |
| Tickit automatically executes ''[[dir:exec]]/addfiles'' when it processes files sent to your system in FDN areas stored in your file bases. Addfiles is executed for each file as it is processed. Files stored outside of your file bases will not have addfiles run against them during processing. | |
| |
| In a recent change to SBBSecho/EchoCfg v3 and ''tickit.js'', the TIC file password for each FTN-linked node is now stored in the ''TicFilePwd'' key of the corresponding ''[node]'' section of the ''[[config:sbbsecho.ini]]'' file and can be managed via AreaFix and via ''[[util:echocfg]]''. | In a recent change to SBBSecho/EchoCfg v3 and ''tickit.js'', the TIC file password for each FTN-linked node is now stored in the ''TicFilePwd'' key of the corresponding ''[node]'' section of the ''[[config:sbbsecho.ini]]'' file and can be managed via AreaFix and via ''[[util:echocfg]]''. |
| |
| ===== Setup ===== | ===== Install ===== |
| |
| You should create an event to run it when you get .TIC files... | You should create an event to run it when you get .TIC files... |
| * [[module:binkit|BinkIT]] automatically runs the TICKIT timed event when a TIC file is received | * [[module:binkit|BinkIT]] automatically runs the TICKIT timed event when a TIC file is received |
| * If you would like to treat all imported ''.tic'' files as though they have a ''REPLACES'' clause, add the ''-force-replace'' option to the ticket.js command-line or use the ''Force Replace'' options in tickitcfg for global or per-area forced replacements | * If you would like to treat all imported ''.tic'' files as though they have a ''REPLACES'' clause, add the ''-force-replace'' option to the ticket.js command-line or use the ''Force Replace'' options in tickitcfg for global or per-area forced replacements |
| ===== Configuration ===== | |
| | ===== Invoke ===== |
| | |
| | ''tickit.js'' may be executed via [[util:JSexec]] or via timed event (as shown in the [[#Install]] section). |
| | |
| | ==== Command-line Syntax ==== |
| | |
| | tickit.js [cfg-file=tickit.ini] [-options] |
| | |
| | ^ Option ^ Description ^ |
| | | -force-replace | Always replace existing files of the same name in the same directory | |
| | | -debug | Enable extra debug-level log messages | |
| | |
| | The default configuration file is ''[[dir:ctrl]]/tickit.ini''. To use an alternate configuration file (but still located in the ''[[dir:ctrl]]'' directory), pass that filename on the command-line (not the full path, just the filename). Example: |
| | jsexec tickit.js alt_tickit.ini |
| | |
| | ===== Configure ===== |
| |
| ==== ctrl/tickit.ini ==== | ==== ctrl/tickit.ini ==== |
| === Global Options === | === Global Options === |
| |
| The following global options are used by TickIT: | The following global options (located in the //root// section of the ''tickit.ini'' file) are used by TickIT: |
| |
| * ''Path'' Default local path to store files in. If this is set, the file will NOT be imported into a local sub. | ^ Key ^ Description ^ |
| * ''Dir'' Default BBS file directory internal code to store files in. [[module:binkit|addfiles]] will be called to import the file. | | ''Path'' | Default local path to store files in. If this is set, the file will NOT be imported into a local sub. | |
| * ''Links'' Comma-separated list of FTN addresses to forward *all* files to. | | ''Dir'' | Default BBS file directory internal code to store files in. [[module:binkit|addfiles]] will be called to import the file. | |
| * ''IgnorePassword'' Set to true to ignore the password in the TIC file. This will allow anyone who can send a TIC file to your board to do so even if they are not configured as one of your linked systems. It should be used with extreme caution (and only used with SecureOnly). Global setting only; not overridden per FDN definition | | ''Links'' |Comma-separated list of FTN addresses to forward *all* files to. | |
| * ''SecureOnly'' Set to true to only import TIC files from the secure inbound. Global setting only; not overridden per FDN definition | | ''IgnorePassword'' | Set to true to ignore the password in the TIC file. This will allow anyone who can send a TIC file to your board to do so even if they are not configured as one of your linked systems. It should be used with extreme caution (and only used with SecureOnly). Global setting only; not overridden per FDN definition | |
| * ''Handler'' Set to the filename of a handler script as defined below. | | ''SecureOnly'' | Set to true to only import TIC files from the secure inbound. Global setting only; not overridden per FDN definition | |
| * ''HandlerArg'' a string that is passed to the handler function. | | ''Handler'' | Set to the filename of a handler script as defined below. | |
| * ''AddFilesLogCap'' used to capture addfiles output into a log for debug and troubleshooting. Global setting only; not overridden per FDN definition | | ''HandlerArg'' | A string that is passed to the handler function. | |
| * ''SourceAddress'' a FTN address to send *all* files from when you are feeding FDNs to other systems. | | ''AddFilesLogCap'' | Used to capture addfiles output into a log for debug and troubleshooting. Global setting only; not overridden per FDN definition | |
| * ''AKAMatching'' set to true to enable AKAMatching so that your best address is selected to be used when feeding files and TICs to other linked systems. | | ''SourceAddress'' | FTN address to send *all* files from when you are feeding FDNs to other systems. | |
| * ''ForceReplace'' set to true to forcibly replace existing files with new ones of the same name even if the TIC does not properly specify the REPLACES verb. This will allow anyone who can send a TIC file to your board to overwrite files in your file bases. It should be used with caution. | | ''AKAMatching'' | Set to true to enable AKAMatching so that your best address is selected to be used when feeding files and TICs to other linked systems. | |
| * ''Uploader'' provides a default uploader name to be used in the files' database records | | ''ForceReplace'' | Set to true to forcibly replace existing files with new ones of the same name even if the TIC does not properly specify the REPLACES verb. This will allow anyone who can send a TIC file to your board to overwrite files in your file bases. It should be used with caution. | |
| | | ''Uploader'' |Default uploader name to be used in the files' database records | |
| | | ''AutoAreas'' |Set to a comma-separated list of File Library Short Names (case sensitive) which should be **automatically** added to the list of areas in your TickIT configuration. When incoming TICs are processed, the AREA tag must match the ''FidoNet Area Tag'' as defined in scfg. | |
| |
| **NOTE:** ''Path'' and ''Dir'' cannot be used together. | **NOTE:** ''Path'' and ''Dir'' cannot be used together. |
| === Sections === | === Sections === |
| |
| Each section is a FDN area definition. This must match the AREA tag in the TIC file. Each area supports the following options: | Each section is a FDN area definition. The ''[section]'' name must match the ''AREA'' tag in the TIC file. Each section supports the following options: |
| |
| * ''Path'' Local path to store files in. If this is set, the file will NOT be imported into a local sub. | ^ Key ^ Description ^ |
| * ''Dir'' BBS file directory internal code to store files in. [[module:binkit|addfiles]] will be called to import the file. | | ''Path'' | Local path to store files in. If this is set, the file will NOT be imported into a local directory. | |
| * ''Links'' Comma-separated list of FTN addresses to forward the files to. | | ''Dir'' | BBS file directory internal code to store files in. [[module:binkit|addfiles]] will be called to import the file. | |
| * ''Handler'' Set to the filename of a handler script as defined below. If present, this overrides the global Handler, they do not both run. | | ''Links'' | Comma-separated list of FTN addresses to forward the files to. | |
| * ''HandlerArg'' a string that is passed to the handler function. | | ''Handler'' | Set to the filename of a handler script as defined below. If present, this overrides the global Handler, they do not both run. | |
| * ''SourceAddress'' a FTN address to send files from when you are feeding this area to other systems. | | ''HandlerArg'' |String that is passed to the handler function. | |
| * ''AKAMatching'' set to true to enable AKAMatching so that your best address is selected to be used when feeding files and TICs to other linked systems. | | ''SourceAddress''|FTN address to send files from when you are feeding this area to other systems. | |
| * ''ForceReplace'' set to true to forcibly replace existing files with new ones of the same name even if the TIC does not properly specify the REPLACES verb. | | ''AKAMatching'' |Set to true to enable AKAMatching so that your best address is selected to be used when feeding files and TICs to other linked systems. | |
| * ''Uploader'' provides an uploader name for this FDN area | | ''ForceReplace'' |Set to true to forcibly replace existing files with new ones of the same name even if the TIC does not properly specify the REPLACES verb. | |
| | | ''Uploader'' | Uploader name for this FDN area | |
| |
| |
| The following is a sample FDN Area Definition for the DAILYLIST FDN. | The following is a sample FDN Area Definition for the DAILYLIST FDN. |
| |
| <code> | <code ini> |
| [DAILYLIST] | [DAILYLIST] |
| Dir=FDIST-DAILYLIS | Dir=FDIST-DAILYLIS |
| </code> | </code> |
| |
| This means that the Fido file area "DAILYLIST", files are imported into my BBS file area "DAILYLIST", and the tickit/nodelist_handler.js file contains the handler for this area. The handler is passed all of the available arguments. | This means that the Fido file area "DAILYLIST" files are imported into my BBS file area "DAILYLIST", and the tickit/nodelist_handler.js file contains the handler for this area. The handler is passed all of the available arguments. |
| |
| * ''domain'' the FTN domain this is the nodelist for. This value is **required**. | * ''domain'' the FTN domain this is the nodelist for. This value is **required**. |
| * ''match'' the filespec for nodelist archives in this area. If the incoming file doesn't match this, the nodelist is not updated. This defaults to '*.*' on Windows and '*' everywhere else. | * ''match'' the filespec for nodelist archives in this area. If the incoming file doesn't match this, the nodelist is not updated. This defaults to '*.*' on Windows and '*' everywhere else. |
| * ''nlmatch'' the filespec for the nodelist file inside the archive. There must be exactly one file matching this filespec inside the archive, or the nodelist will not be updated. . This defaults to '*.*' on Windows and '*' everywhere else. | * ''nlmatch'' the filespec for the nodelist file inside the archive. There must be exactly one file matching this filespec inside the archive or the nodelist will not be updated. This defaults to '*.*' on Windows and '*' everywhere else. |
| |
| **NOTE:** This handler will attempt to extract the nlmatch file from the match archive and write it to the directory and file name as defined in echocfg in the Domains definition section. The file will always be saved to the defined name and it will not be changed unless you change the Domain definition in echocfg. The domain argument must also be one defined in echocfg. | **NOTE:** This handler will attempt to extract the nlmatch file from the match archive and write it to the directory and file name as defined in echocfg in the Domains definition section. The file will always be saved to the defined name and it will not be changed unless you change the Domain definition in echocfg. The domain argument must also be one defined in echocfg. |
| ===== See Also ===== | ===== See Also ===== |
| * [[module:|Module Index]] | * [[module:|Module Index]] |
| * [[:module:tickitcfg|tickitcfg]] | * [[TickITcfg]] |
| | * [[TickFix]] |
| |
| {{tag>fidonet}} | {{tag>fidonet tic tick raid jsutil}} |
| |
